From 8dba0a478d165c91c45097d503437419ecafb0ce Mon Sep 17 00:00:00 2001 From: Luke Hagar Date: Thu, 24 Aug 2023 07:57:36 -0500 Subject: [PATCH] removed md from gitignore --- .gitignore | 8 +- products/idn/api/beta/access-profiles.tag.mdx | 54 ++ .../api/beta/access-request-approvals.tag.mdx | 37 + products/idn/api/beta/access-requests.tag.mdx | 35 + .../idn/api/beta/account-activities.tag.mdx | 53 + .../idn/api/beta/account-aggregations.tag.mdx | 30 + products/idn/api/beta/accounts.tag.mdx | 47 + ...quest-recommendations-ignored-item.api.mdx | 79 ++ ...est-recommendations-requested-item.api.mdx | 79 ++ ...equest-recommendations-viewed-item.api.mdx | 79 ++ ...quest-recommendations-viewed-items.api.mdx | 79 ++ .../idn/api/beta/add-tag-to-object.api.mdx | 81 ++ .../api/beta/add-tags-to-many-objects.api.mdx | 81 ++ .../api/beta/approve-access-request.api.mdx | 79 ++ .../api/beta/approve-approval-item.api.mdx | 67 ++ .../approve-approval-items-in-bulk.api.mdx | 67 ++ .../beta/approve-non-employee-request.api.mdx | 79 ++ .../idn/api/beta/bulk-delete-roles.api.mdx | 77 ++ .../api/beta/cancel-access-request.api.mdx | 88 ++ .../beta/cancel-workflow-execution.api.mdx | 87 ++ .../api/beta/certification-campaigns.tag.mdx | 85 ++ products/idn/api/beta/certifications.tag.mdx | 33 + .../idn/api/beta/close-access-request.api.mdx | 86 ++ ...are-identity-snapshots-access-type.api.mdx | 83 ++ .../beta/compare-identity-snapshots.api.mdx | 87 ++ .../idn/api/beta/complete-campaign.api.mdx | 103 ++ .../beta/complete-trigger-invocation.api.mdx | 75 ++ .../idn/api/beta/complete-work-item.api.mdx | 67 ++ .../beta/connector-rule-management.tag.mdx | 16 + products/idn/api/beta/connectors.tag.mdx | 34 + .../api/beta/create-access-profile.api.mdx | 149 +++ .../api/beta/create-access-request.api.mdx | 114 +++ products/idn/api/beta/create-account.api.mdx | 81 ++ .../api/beta/create-campaign-template.api.mdx | 171 ++++ products/idn/api/beta/create-campaign.api.mdx | 167 ++++ .../idn/api/beta/create-common-access.api.mdx | 75 ++ .../api/beta/create-connector-rule.api.mdx | 96 ++ ...reate-custom-password-instructions.api.mdx | 67 ++ .../idn/api/beta/create-domain-dkim.api.mdx | 79 ++ ...ate-form-definition-dynamic-schema.api.mdx | 63 ++ .../api/beta/create-form-definition.api.mdx | 119 +++ .../idn/api/beta/create-form-instance.api.mdx | 107 +++ .../api/beta/create-identity-profile.api.mdx | 108 +++ .../beta/create-non-employee-record.api.mdx | 89 ++ .../beta/create-non-employee-request.api.mdx | 95 ++ ...-employee-source-schema-attributes.api.mdx | 75 ++ .../beta/create-non-employee-source.api.mdx | 109 +++ .../beta/create-notification-template.api.mdx | 77 ++ .../idn/api/beta/create-oauth-client.api.mdx | 75 ++ .../beta/create-password-org-config.api.mdx | 75 ++ .../beta/create-password-sync-group.api.mdx | 75 ++ .../beta/create-personal-access-token.api.mdx | 83 ++ ...e-potential-role-provision-request.api.mdx | 91 ++ .../beta/create-provisioning-policy.api.mdx | 90 ++ .../create-reassignment-configuration.api.mdx | 99 ++ .../beta/create-role-insight-requests.api.mdx | 71 ++ .../beta/create-role-mining-sessions.api.mdx | 99 ++ products/idn/api/beta/create-role.api.mdx | 190 ++++ .../create-search-attribute-config.api.mdx | 88 ++ products/idn/api/beta/create-segment.api.mdx | 95 ++ .../create-service-desk-integration.api.mdx | 147 +++ .../idn/api/beta/create-sod-policy.api.mdx | 92 ++ .../idn/api/beta/create-source-schema.api.mdx | 91 ++ products/idn/api/beta/create-source.api.mdx | 156 +++ .../idn/api/beta/create-subscription.api.mdx | 109 +++ .../idn/api/beta/create-transform.api.mdx | 80 ++ .../beta/create-verified-from-address.api.mdx | 75 ++ products/idn/api/beta/create-workflow.api.mdx | 119 +++ .../idn/api/beta/create-workgroup.api.mdx | 83 ++ products/idn/api/beta/custom-forms.tag.mdx | 28 + .../beta/custom-password-instructions.tag.mdx | 31 + .../api/beta/delete-access-profile.api.mdx | 79 ++ .../delete-access-profiles-in-bulk.api.mdx | 99 ++ products/idn/api/beta/delete-account.api.mdx | 88 ++ .../delete-campaign-template-schedule.api.mdx | 75 ++ .../api/beta/delete-campaign-template.api.mdx | 87 ++ .../idn/api/beta/delete-campaigns.api.mdx | 91 ++ .../api/beta/delete-connector-rule.api.mdx | 88 ++ ...elete-custom-password-instructions.api.mdx | 79 ++ .../api/beta/delete-form-definition.api.mdx | 55 ++ .../api/beta/delete-identity-profile.api.mdx | 88 ++ .../api/beta/delete-identity-profiles.api.mdx | 81 ++ products/idn/api/beta/delete-identity.api.mdx | 87 ++ ...delete-non-employee-record-in-bulk.api.mdx | 81 ++ .../beta/delete-non-employee-record.api.mdx | 75 ++ .../beta/delete-non-employee-request.api.mdx | 87 ++ ...lete-non-employee-schema-attribute.api.mdx | 76 ++ ...-employee-source-schema-attributes.api.mdx | 75 ++ .../beta/delete-non-employee-source.api.mdx | 75 ++ ...ete-notification-templates-in-bulk.api.mdx | 75 ++ .../idn/api/beta/delete-oauth-client.api.mdx | 87 ++ .../beta/delete-password-sync-group.api.mdx | 75 ++ .../beta/delete-personal-access-token.api.mdx | 87 ++ .../beta/delete-provisioning-policy.api.mdx | 88 ++ .../delete-reassignment-configuration.api.mdx | 75 ++ products/idn/api/beta/delete-role.api.mdx | 76 ++ .../delete-search-attribute-config.api.mdx | 76 ++ products/idn/api/beta/delete-segment.api.mdx | 79 ++ .../delete-service-desk-integration.api.mdx | 87 ++ .../beta/delete-sod-policy-schedule.api.mdx | 88 ++ .../idn/api/beta/delete-sod-policy.api.mdx | 88 ++ .../idn/api/beta/delete-source-schema.api.mdx | 87 ++ .../idn/api/beta/delete-subscription.api.mdx | 87 ++ .../idn/api/beta/delete-tagged-object.api.mdx | 75 ++ .../idn/api/beta/delete-transform.api.mdx | 88 ++ .../beta/delete-verified-from-address.api.mdx | 87 ++ products/idn/api/beta/delete-workflow.api.mdx | 75 ++ products/idn/api/beta/delete.api.mdx | 89 ++ .../beta/disable-account-for-identity.api.mdx | 87 ++ products/idn/api/beta/disable-account.api.mdx | 88 ++ .../disable-accounts-for-identities.api.mdx | 75 ++ .../download-custom-violation-report.api.mdx | 88 ++ .../download-default-violation-report.api.mdx | 88 ++ ...role-insights-entitlements-changes.api.mdx | 71 ++ ...oad-role-mining-potential-role-zip.api.mdx | 71 ++ .../beta/enable-account-for-identity.api.mdx | 87 ++ products/idn/api/beta/enable-account.api.mdx | 88 ++ .../enable-accounts-for-identities.api.mdx | 75 ++ products/idn/api/beta/entitlements.tag.mdx | 69 ++ .../export-form-definitions-by-tenant.api.mdx | 83 ++ .../api/beta/export-identity-profiles.api.mdx | 103 ++ .../beta/export-non-employee-records.api.mdx | 87 ++ ...on-employee-source-schema-template.api.mdx | 89 ++ .../idn/api/beta/export-outliers-zip.api.mdx | 76 ++ ...t-role-mining-potential-role-async.api.mdx | 71 ++ ...-role-mining-potential-role-status.api.mdx | 71 ++ .../export-role-mining-potential-role.api.mdx | 71 ++ .../idn/api/beta/export-sp-config.api.mdx | 97 ++ .../api/beta/forward-access-request.api.mdx | 91 ++ .../idn/api/beta/forward-work-item.api.mdx | 75 ++ .../beta/generate-campaign-template.api.mdx | 79 ++ .../idn/api/beta/generate-digit-token.api.mdx | 67 ++ .../beta/generate-identity-preview.api.mdx | 92 ++ .../get-access-profile-entitlements.api.mdx | 89 ++ .../idn/api/beta/get-access-profile.api.mdx | 113 +++ ...et-access-request-approval-summary.api.mdx | 75 ++ .../beta/get-access-request-config.api.mdx | 87 ++ ...uest-recommendations-ignored-items.api.mdx | 75 ++ ...st-recommendations-requested-items.api.mdx | 75 ++ ...quest-recommendations-viewed-items.api.mdx | 75 ++ ...get-access-request-recommendations.api.mdx | 79 ++ .../idn/api/beta/get-account-activity.api.mdx | 99 ++ .../get-account-aggregation-status.api.mdx | 83 ++ .../api/beta/get-account-entitlements.api.mdx | 100 ++ products/idn/api/beta/get-account.api.mdx | 92 ++ .../idn/api/beta/get-active-campaigns.api.mdx | 123 +++ .../beta/get-campaign-reports-config.api.mdx | 64 ++ .../idn/api/beta/get-campaign-reports.api.mdx | 76 ++ .../get-campaign-template-schedule.api.mdx | 147 +++ .../api/beta/get-campaign-template.api.mdx | 135 +++ products/idn/api/beta/get-campaign.api.mdx | 91 ++ .../beta/get-client-log-configuration.api.mdx | 95 ++ .../idn/api/beta/get-common-access.api.mdx | 75 ++ .../api/beta/get-completed-work-items.api.mdx | 67 ++ .../idn/api/beta/get-connector-list.api.mdx | 88 ++ .../api/beta/get-connector-rule-list.api.mdx | 84 ++ .../idn/api/beta/get-connector-rule.api.mdx | 96 ++ .../get-count-completed-work-items.api.mdx | 67 ++ .../idn/api/beta/get-count-work-items.api.mdx | 67 ++ .../get-custom-password-instructions.api.mdx | 79 ++ ...-default-identity-attribute-config.api.mdx | 96 ++ .../idn/api/beta/get-dkim-attributes.api.mdx | 75 ++ ...get-entitlement-changes-identities.api.mdx | 71 ++ ...lement-distribution-potential-role.api.mdx | 71 ++ .../get-entitlement-request-config.api.mdx | 91 ++ products/idn/api/beta/get-entitlement.api.mdx | 99 ++ .../get-entitlements-potential-role.api.mdx | 75 ++ ...valuate-reassignment-configuration.api.mdx | 79 ++ ...cluded-entitlements-potential-role.api.mdx | 75 ++ .../beta/get-form-definition-by-key.api.mdx | 87 ++ .../api/beta/get-form-instance-by-key.api.mdx | 99 ++ .../get-historical-identity-events.api.mdx | 127 +++ .../api/beta/get-historical-identity.api.mdx | 83 ++ .../get-identities-potential-role.api.mdx | 71 ++ ...ity-certification-item-permissions.api.mdx | 87 ++ ...entity-certification-pending-tasks.api.mdx | 87 ++ ...identity-certification-task-status.api.mdx | 87 ++ .../get-identity-outlier-snapshots.api.mdx | 84 ++ .../api/beta/get-identity-outliers.api.mdx | 80 ++ ...et-identity-password-change-status.api.mdx | 83 ++ .../idn/api/beta/get-identity-profile.api.mdx | 104 ++ .../get-identity-snapshot-summary.api.mdx | 83 ++ .../api/beta/get-identity-snapshot.api.mdx | 91 ++ .../api/beta/get-identity-start-date.api.mdx | 83 ++ products/idn/api/beta/get-identity.api.mdx | 91 ++ ...-latest-identity-outlier-snapshots.api.mdx | 80 ++ .../api/beta/get-mail-from-attributes.api.mdx | 75 ++ .../beta/get-managed-client-status.api.mdx | 87 ++ .../idn/api/beta/get-managed-cluster.api.mdx | 119 +++ .../idn/api/beta/get-managed-clusters.api.mdx | 107 +++ .../idn/api/beta/get-message-catalogs.api.mdx | 79 ++ products/idn/api/beta/get-mfa-config.api.mdx | 75 ++ .../get-non-employee-approval-summary.api.mdx | 75 ++ .../beta/get-non-employee-approval.api.mdx | 91 ++ ...et-non-employee-bulk-upload-status.api.mdx | 76 ++ .../api/beta/get-non-employee-record.api.mdx | 79 ++ .../get-non-employee-request-summary.api.mdx | 75 ++ .../api/beta/get-non-employee-request.api.mdx | 99 ++ .../get-non-employee-schema-attribute.api.mdx | 75 ++ ...-employee-source-schema-attributes.api.mdx | 87 ++ .../api/beta/get-non-employee-source.api.mdx | 83 ++ .../beta/get-notification-preference.api.mdx | 76 ++ .../beta/get-notification-template.api.mdx | 75 ++ ...get-notifications-template-context.api.mdx | 79 ++ .../idn/api/beta/get-oauth-client.api.mdx | 87 ++ products/idn/api/beta/get-org-config.api.mdx | 87 ++ .../api/beta/get-password-dictionary.api.mdx | 116 +++ .../api/beta/get-password-org-config.api.mdx | 75 ++ .../api/beta/get-password-sync-group.api.mdx | 87 ++ .../api/beta/get-password-sync-groups.api.mdx | 75 ++ ...oup-outliers-contributing-features.api.mdx | 104 ++ .../api/beta/get-peer-group-outliers.api.mdx | 83 ++ .../get-potential-role-applications.api.mdx | 71 ++ .../beta/get-potential-role-summaries.api.mdx | 79 ++ .../idn/api/beta/get-potential-role.api.mdx | 91 ++ .../api/beta/get-provisioning-policy.api.mdx | 88 ++ .../beta/get-public-identity-config.api.mdx | 79 ++ .../get-reassignment-config-types.api.mdx | 75 ++ .../get-reassignment-configuration.api.mdx | 111 +++ .../beta/get-recommendations-config.api.mdx | 71 ++ .../idn/api/beta/get-recommendations.api.mdx | 95 ++ .../beta/get-role-assigned-identities.api.mdx | 75 ++ .../idn/api/beta/get-role-insight.api.mdx | 79 ++ ...role-insights-current-entitlements.api.mdx | 71 ++ ...role-insights-entitlements-changes.api.mdx | 75 ++ .../beta/get-role-insights-requests.api.mdx | 71 ++ .../beta/get-role-insights-summary.api.mdx | 71 ++ .../idn/api/beta/get-role-insights.api.mdx | 79 ++ .../get-role-mining-session-status.api.mdx | 71 ++ .../api/beta/get-role-mining-session.api.mdx | 103 ++ .../api/beta/get-role-mining-sessions.api.mdx | 87 ++ products/idn/api/beta/get-role.api.mdx | 133 +++ .../beta/get-search-attribute-config.api.mdx | 64 ++ products/idn/api/beta/get-segment.api.mdx | 85 ++ .../get-service-desk-integration-list.api.mdx | 115 +++ ...-service-desk-integration-template.api.mdx | 103 ++ ...get-service-desk-integration-types.api.mdx | 87 ++ .../beta/get-service-desk-integration.api.mdx | 115 +++ ...get-single-search-attribute-config.api.mdx | 80 ++ .../get-sod-all-report-run-status.api.mdx | 76 ++ .../api/beta/get-sod-policy-schedule.api.mdx | 93 ++ products/idn/api/beta/get-sod-policy.api.mdx | 96 ++ ...et-sod-violation-report-run-status.api.mdx | 88 ++ .../get-sod-violation-report-status.api.mdx | 88 ++ .../beta/get-source-accounts-schema.api.mdx | 87 ++ .../beta/get-source-attr-sync-config.api.mdx | 96 ++ .../idn/api/beta/get-source-config.api.mdx | 76 ++ ...-source-entitlement-request-config.api.mdx | 89 ++ .../get-source-entitlements-schema.api.mdx | 87 ++ .../idn/api/beta/get-source-schema.api.mdx | 96 ++ products/idn/api/beta/get-source.api.mdx | 128 +++ .../beta/get-sp-config-export-status.api.mdx | 89 ++ .../idn/api/beta/get-sp-config-export.api.mdx | 101 ++ .../beta/get-sp-config-import-status.api.mdx | 90 ++ .../idn/api/beta/get-sp-config-import.api.mdx | 93 ++ .../api/beta/get-status-check-details.api.mdx | 87 ++ .../idn/api/beta/get-tagged-object.api.mdx | 75 ++ .../get-tenant-config-configuration.api.mdx | 103 ++ products/idn/api/beta/get-transform.api.mdx | 88 ++ .../idn/api/beta/get-valid-time-zones.api.mdx | 75 ++ products/idn/api/beta/get-work-item.api.mdx | 67 ++ .../api/beta/get-work-items-summary.api.mdx | 67 ++ .../get-workflow-execution-history.api.mdx | 87 ++ .../api/beta/get-workflow-execution.api.mdx | 87 ++ products/idn/api/beta/get-workflow.api.mdx | 99 ++ products/idn/api/beta/get-workgroup.api.mdx | 79 ++ .../idn/api/beta/governance-groups.tag.mdx | 25 + ...iai-access-request-recommendations.tag.mdx | 16 + .../idn/api/beta/iai-common-access.tag.mdx | 16 + products/idn/api/beta/iai-outliers.tag.mdx | 16 + .../beta/iai-peer-group-strategies.tag.mdx | 16 + .../idn/api/beta/iai-recommendations.tag.mdx | 16 + products/idn/api/beta/iai-role-mining.tag.mdx | 16 + products/idn/api/beta/identities.tag.mdx | 35 + .../idn/api/beta/identity-history.tag.mdx | 16 + .../idn/api/beta/identity-profiles.tag.mdx | 31 + .../api/beta/identitynow-beta-api.info.mdx | 36 + .../api/beta/ignore-identity-outliers.api.mdx | 76 ++ .../api/beta/import-form-definitions.api.mdx | 119 +++ .../api/beta/import-identity-profiles.api.mdx | 123 +++ ...mport-non-employee-records-in-bulk.api.mdx | 91 ++ .../import-source-accounts-schema.api.mdx | 83 ++ .../beta/import-source-connector-file.api.mdx | 116 +++ .../import-source-entitlements-schema.api.mdx | 83 ++ .../idn/api/beta/import-sp-config.api.mdx | 164 ++++ .../idn/api/beta/lifecycle-states.tag.mdx | 56 ++ .../idn/api/beta/list-access-profiles.api.mdx | 113 +++ .../beta/list-access-request-status.api.mdx | 172 ++++ .../api/beta/list-account-activities.api.mdx | 87 ++ products/idn/api/beta/list-accounts.api.mdx | 84 ++ .../api/beta/list-campaign-templates.api.mdx | 123 +++ .../beta/list-certification-reviewers.api.mdx | 87 ++ .../list-complete-workflow-library.api.mdx | 87 ++ .../api/beta/list-completed-approvals.api.mdx | 127 +++ .../beta/list-entitlement-children.api.mdx | 99 ++ .../api/beta/list-entitlement-parents.api.mdx | 99 ++ .../idn/api/beta/list-entitlements.api.mdx | 91 ++ .../idn/api/beta/list-from-addresses.api.mdx | 63 ++ .../beta/list-historical-identities.api.mdx | 75 ++ products/idn/api/beta/list-identities.api.mdx | 79 ++ .../beta/list-identity-access-items.api.mdx | 83 ++ .../api/beta/list-identity-profiles.api.mdx | 92 ++ ...ist-identity-snapshot-access-items.api.mdx | 83 ++ .../api/beta/list-identity-snapshots.api.mdx | 83 ++ .../api/beta/list-lifecycle-states.api.mdx | 78 ++ .../beta/list-non-employee-approval.api.mdx | 79 ++ .../beta/list-non-employee-records.api.mdx | 79 ++ .../beta/list-non-employee-requests.api.mdx | 87 ++ .../beta/list-non-employee-sources.api.mdx | 83 ++ ...ist-notification-template-defaults.api.mdx | 75 ++ .../beta/list-notification-templates.api.mdx | 75 ++ .../idn/api/beta/list-oauth-clients.api.mdx | 75 ++ .../api/beta/list-pending-approvals.api.mdx | 119 +++ .../beta/list-personal-access-tokens.api.mdx | 79 ++ .../beta/list-provisioning-policies.api.mdx | 88 ++ .../list-reassignment-configurations.api.mdx | 111 +++ .../api/beta/list-requestable-objects.api.mdx | 76 ++ products/idn/api/beta/list-roles.api.mdx | 133 +++ products/idn/api/beta/list-segments.api.mdx | 84 ++ .../idn/api/beta/list-sod-policies.api.mdx | 84 ++ .../idn/api/beta/list-source-schemas.api.mdx | 83 ++ products/idn/api/beta/list-sources.api.mdx | 128 +++ .../api/beta/list-sp-config-objects.api.mdx | 103 ++ .../idn/api/beta/list-subscriptions.api.mdx | 91 ++ .../beta/list-tagged-objects-by-type.api.mdx | 77 ++ .../idn/api/beta/list-tagged-objects.api.mdx | 77 ++ products/idn/api/beta/list-transforms.api.mdx | 76 ++ .../list-trigger-invocation-status.api.mdx | 89 ++ products/idn/api/beta/list-triggers.api.mdx | 259 +++++ products/idn/api/beta/list-work-items.api.mdx | 67 ++ .../api/beta/list-workflow-executions.api.mdx | 97 ++ .../list-workflow-library-actions.api.mdx | 79 ++ .../list-workflow-library-operators.api.mdx | 79 ++ .../list-workflow-library-triggers.api.mdx | 79 ++ products/idn/api/beta/list-workflows.api.mdx | 99 ++ products/idn/api/beta/list-workgroups.api.mdx | 79 ++ products/idn/api/beta/managed-clients.tag.mdx | 20 + .../idn/api/beta/managed-clusters.tag.mdx | 20 + .../idn/api/beta/mfa-configuration.tag.mdx | 20 + products/idn/api/beta/move.api.mdx | 95 ++ .../non-employee-lifecycle-management.tag.mdx | 51 + products/idn/api/beta/notifications.tag.mdx | 16 + products/idn/api/beta/o-auth-clients.tag.mdx | 23 + products/idn/api/beta/org-config.tag.mdx | 20 + .../api/beta/password-configuration.tag.mdx | 26 + .../idn/api/beta/password-dictionary.tag.mdx | 67 ++ .../idn/api/beta/password-management.tag.mdx | 44 + .../idn/api/beta/password-sync-groups.tag.mdx | 52 + .../idn/api/beta/patch-access-profile.api.mdx | 122 +++ .../api/beta/patch-campaign-template.api.mdx | 146 +++ .../idn/api/beta/patch-entitlement.api.mdx | 109 +++ .../api/beta/patch-form-definition.api.mdx | 91 ++ .../idn/api/beta/patch-form-instance.api.mdx | 107 +++ .../beta/patch-non-employee-record.api.mdx | 99 ++ ...atch-non-employee-schema-attribute.api.mdx | 96 ++ .../beta/patch-non-employee-source.api.mdx | 91 ++ .../idn/api/beta/patch-oauth-client.api.mdx | 113 +++ .../idn/api/beta/patch-org-config.api.mdx | 95 ++ .../beta/patch-personal-access-token.api.mdx | 104 ++ .../idn/api/beta/patch-potential-role.api.mdx | 115 +++ .../beta/patch-role-mining-session.api.mdx | 95 ++ products/idn/api/beta/patch-role.api.mdx | 139 +++ .../patch-search-attribute-config.api.mdx | 93 ++ products/idn/api/beta/patch-segment.api.mdx | 112 +++ .../patch-service-desk-integration.api.mdx | 135 +++ .../idn/api/beta/patch-sod-policy.api.mdx | 115 +++ .../idn/api/beta/patch-subscription.api.mdx | 109 +++ products/idn/api/beta/patch-workflow.api.mdx | 103 ++ .../api/beta/peek-resource-objects.api.mdx | 92 ++ .../api/beta/personal-access-tokens.tag.mdx | 31 + products/idn/api/beta/ping-cluster.api.mdx | 88 ++ .../post-external-execute-workflow.api.mdx | 75 ++ .../post-workflow-external-trigger.api.mdx | 75 ++ .../api/beta/predict-sod-violations.api.mdx | 105 ++ .../api/beta/public-identities-config.tag.mdx | 30 + products/idn/api/beta/put-account.api.mdx | 88 ++ .../beta/put-client-log-configuration.api.mdx | 107 +++ .../put-entitlement-request-config.api.mdx | 95 ++ .../api/beta/put-mail-from-attributes.api.mdx | 75 ++ .../beta/put-notification-preference.api.mdx | 81 ++ .../api/beta/put-provisioning-policy.api.mdx | 90 ++ .../api/beta/put-reassignment-config.api.mdx | 99 ++ .../beta/put-service-desk-integration.api.mdx | 147 +++ .../beta/put-source-attr-sync-config.api.mdx | 105 ++ .../idn/api/beta/put-source-schema.api.mdx | 108 +++ products/idn/api/beta/put-source.api.mdx | 182 ++++ .../api/beta/put-tenant-configuration.api.mdx | 95 ++ .../idn/api/beta/query-password-info.api.mdx | 87 ++ .../reassign-identity-certs-async.api.mdx | 87 ++ .../api/beta/refresh-identity-profile.api.mdx | 88 ++ .../api/beta/reject-access-request.api.mdx | 91 ++ .../idn/api/beta/reject-approval-item.api.mdx | 67 ++ .../reject-approval-items-in-bulk.api.mdx | 67 ++ .../beta/reject-non-employee-request.api.mdx | 79 ++ products/idn/api/beta/reload-account.api.mdx | 88 ++ .../beta/remove-tags-to-many-object.api.mdx | 81 ++ .../idn/api/beta/requestable-objects.tag.mdx | 23 + products/idn/api/beta/role-insights.tag.mdx | 16 + products/idn/api/beta/roles.tag.mdx | 57 ++ .../run-campaign-remediation-scan.api.mdx | 88 ++ .../idn/api/beta/run-campaign-report.api.mdx | 88 ++ .../beta/run-sod-all-policies-for-org.api.mdx | 76 ++ products/idn/api/beta/run-sod-policy.api.mdx | 88 ++ .../search-attribute-configuration.tag.mdx | 16 + .../search-form-definitions-by-tenant.api.mdx | 87 ++ ...ch-form-element-data-by-element-id.api.mdx | 60 ++ .../search-form-instances-by-tenant.api.mdx | 99 ++ .../search-pre-defined-select-options.api.mdx | 51 + products/idn/api/beta/segments.tag.mdx | 16 + .../api/beta/send-test-notification.api.mdx | 87 ++ .../api/beta/service-desk-integration.tag.mdx | 44 + .../beta/set-campaign-reports-config.api.mdx | 80 ++ .../set-campaign-template-schedule.api.mdx | 159 +++ .../api/beta/set-identity-password.api.mdx | 116 +++ products/idn/api/beta/set-mfa-config.api.mdx | 75 ++ .../api/beta/show-preview-data-source.api.mdx | 63 ++ products/idn/api/beta/sidebar.js | 1 + products/idn/api/beta/sod-policy.tag.mdx | 20 + products/idn/api/beta/sod-violations.tag.mdx | 20 + products/idn/api/beta/sources.tag.mdx | 77 ++ products/idn/api/beta/sp-config.tag.mdx | 20 + products/idn/api/beta/start-campaign.api.mdx | 96 ++ .../beta/start-identity-processing.api.mdx | 95 ++ .../start-test-trigger-invocation.api.mdx | 79 ++ .../api/beta/submit-account-selection.api.mdx | 71 ++ .../beta/sync-attributes-for-source.api.mdx | 92 ++ ...ynchronize-attributes-for-identity.api.mdx | 91 ++ products/idn/api/beta/tagged-objects.tag.mdx | 16 + .../test-external-execute-workflow.api.mdx | 75 ++ products/idn/api/beta/test-mfa-config.api.mdx | 76 ++ .../beta/test-source-configuration.api.mdx | 88 ++ .../api/beta/test-source-connection.api.mdx | 88 ++ .../api/beta/test-subscription-filter.api.mdx | 76 ++ products/idn/api/beta/test-workflow.api.mdx | 77 ++ products/idn/api/beta/transforms.tag.mdx | 20 + products/idn/api/beta/triggers.tag.mdx | 63 ++ .../beta/un-ignore-identity-outliers.api.mdx | 76 ++ products/idn/api/beta/unlock-account.api.mdx | 88 ++ .../beta/update-access-request-config.api.mdx | 100 ++ products/idn/api/beta/update-account.api.mdx | 92 ++ products/idn/api/beta/update-campaign.api.mdx | 104 ++ ...pdate-common-access-status-in-bulk.api.mdx | 79 ++ .../api/beta/update-connector-rule.api.mdx | 108 +++ .../beta/update-entitlements-in-bulk.api.mdx | 85 ++ ...update-entitlements-potential-role.api.mdx | 91 ++ .../api/beta/update-identity-profile.api.mdx | 116 +++ .../api/beta/update-lifecycle-states.api.mdx | 94 ++ .../beta/update-managed-client-status.api.mdx | 87 ++ .../beta/update-non-employee-record.api.mdx | 99 ++ .../beta/update-password-dictionary.api.mdx | 124 +++ .../beta/update-password-org-config.api.mdx | 75 ++ .../beta/update-password-sync-group.api.mdx | 87 ++ .../api/beta/update-policy-schedule.api.mdx | 110 +++ ...date-provisioning-policies-in-bulk.api.mdx | 88 ++ .../beta/update-provisioning-policy.api.mdx | 98 ++ .../update-public-identity-config.api.mdx | 83 ++ .../update-recommendations-config.api.mdx | 71 ++ .../idn/api/beta/update-sod-policy.api.mdx | 104 ++ ...-source-entitlement-request-config.api.mdx | 97 ++ .../idn/api/beta/update-source-schema.api.mdx | 132 +++ products/idn/api/beta/update-source.api.mdx | 151 +++ .../beta/update-status-check-details.api.mdx | 91 ++ .../idn/api/beta/update-subscription.api.mdx | 128 +++ .../idn/api/beta/update-tagged-object.api.mdx | 75 ++ .../idn/api/beta/update-transform.api.mdx | 92 ++ products/idn/api/beta/update-workflow.api.mdx | 119 +++ .../api/beta/validate-connector-rule.api.mdx | 80 ++ products/idn/api/beta/work-items.tag.mdx | 34 + products/idn/api/beta/workflows.tag.mdx | 21 + products/idn/api/v3/access-profiles.tag.mdx | 54 ++ .../api/v3/access-request-approvals.tag.mdx | 37 + products/idn/api/v3/access-requests.tag.mdx | 35 + .../idn/api/v3/account-activities.tag.mdx | 53 + products/idn/api/v3/accounts.tag.mdx | 47 + .../idn/api/v3/approve-access-request.api.mdx | 91 ++ .../idn/api/v3/approve-approval-item.api.mdx | 87 ++ .../v3/approve-approval-items-in-bulk.api.mdx | 87 ++ .../v3/approve-non-employee-request.api.mdx | 79 ++ .../idn/api/v3/cancel-access-request.api.mdx | 88 ++ .../api/v3/certification-campaigns.tag.mdx | 85 ++ .../api/v3/certification-summaries.tag.mdx | 34 + products/idn/api/v3/certifications.tag.mdx | 45 + .../idn/api/v3/complete-work-item.api.mdx | 87 ++ .../idn/api/v3/create-access-profile.api.mdx | 149 +++ .../idn/api/v3/create-access-request.api.mdx | 114 +++ products/idn/api/v3/create-account.api.mdx | 81 ++ products/idn/api/v3/create-campaign.api.mdx | 163 ++++ .../idn/api/v3/create-lifecycle-state.api.mdx | 88 ++ .../api/v3/create-non-employee-record.api.mdx | 88 ++ .../v3/create-non-employee-request.api.mdx | 95 ++ ...-employee-source-schema-attributes.api.mdx | 76 ++ .../api/v3/create-non-employee-source.api.mdx | 107 +++ .../idn/api/v3/create-oauth-client.api.mdx | 75 ++ .../api/v3/create-password-org-config.api.mdx | 75 ++ .../api/v3/create-password-sync-group.api.mdx | 75 ++ .../v3/create-personal-access-token.api.mdx | 83 ++ .../api/v3/create-provisioning-policy.api.mdx | 90 ++ products/idn/api/v3/create-role.api.mdx | 190 ++++ .../idn/api/v3/create-saved-search.api.mdx | 111 +++ .../api/v3/create-scheduled-search.api.mdx | 138 +++ products/idn/api/v3/create-segment.api.mdx | 95 ++ .../create-service-desk-integration.api.mdx | 147 +++ products/idn/api/v3/create-sod-policy.api.mdx | 108 +++ .../idn/api/v3/create-source-schema.api.mdx | 92 ++ products/idn/api/v3/create-source.api.mdx | 156 +++ products/idn/api/v3/create-transform.api.mdx | 903 +++++++++++++++++ .../v3/delete-access-profiles-in-bulk.api.mdx | 99 ++ products/idn/api/v3/delete-account.api.mdx | 88 ++ .../idn/api/v3/delete-lifecycle-state.api.mdx | 88 ++ .../api/v3/delete-non-employee-record.api.mdx | 76 ++ ...elete-non-employee-records-in-bulk.api.mdx | 79 ++ .../v3/delete-non-employee-request.api.mdx | 88 ++ ...lete-non-employee-schema-attribute.api.mdx | 77 ++ ...-employee-source-schema-attributes.api.mdx | 75 ++ .../api/v3/delete-non-employee-source.api.mdx | 75 ++ .../idn/api/v3/delete-oauth-client.api.mdx | 87 ++ .../api/v3/delete-password-sync-group.api.mdx | 75 ++ .../v3/delete-personal-access-token.api.mdx | 87 ++ .../api/v3/delete-provisioning-policy.api.mdx | 88 ++ .../idn/api/v3/delete-saved-search.api.mdx | 88 ++ .../api/v3/delete-scheduled-search.api.mdx | 88 ++ products/idn/api/v3/delete-segment.api.mdx | 91 ++ .../delete-service-desk-integration.api.mdx | 87 ++ .../api/v3/delete-sod-policy-schedule.api.mdx | 87 ++ products/idn/api/v3/delete-sod-policy.api.mdx | 88 ++ .../idn/api/v3/delete-source-schema.api.mdx | 87 ++ products/idn/api/v3/delete-source.api.mdx | 89 ++ .../idn/api/v3/delete-tagged-object.api.mdx | 75 ++ .../api/v3/delete-tags-to-many-object.api.mdx | 81 ++ products/idn/api/v3/delete-transform.api.mdx | 88 ++ products/idn/api/v3/disable-account.api.mdx | 88 ++ products/idn/api/v3/enable-account.api.mdx | 88 ++ .../idn/api/v3/execute-saved-search.api.mdx | 105 ++ .../api/v3/export-identity-profiles.api.mdx | 91 ++ .../v3/export-non-employee-records.api.mdx | 87 ++ ...on-employee-source-schema-template.api.mdx | 87 ++ .../idn/api/v3/forward-access-request.api.mdx | 91 ++ .../get-access-profile-entitlements.api.mdx | 81 ++ .../idn/api/v3/get-access-profile.api.mdx | 113 +++ ...et-access-request-approval-summary.api.mdx | 75 ++ .../api/v3/get-access-request-config.api.mdx | 87 ++ .../idn/api/v3/get-account-activity.api.mdx | 103 ++ .../api/v3/get-account-entitlements.api.mdx | 96 ++ products/idn/api/v3/get-account.api.mdx | 92 ++ .../idn/api/v3/get-accounts-schema.api.mdx | 88 ++ .../idn/api/v3/get-active-campaigns.api.mdx | 119 +++ products/idn/api/v3/get-campaign.api.mdx | 87 ++ .../api/v3/get-completed-work-items.api.mdx | 75 ++ .../v3/get-count-completed-work-items.api.mdx | 75 ++ .../idn/api/v3/get-count-work-items.api.mdx | 75 ++ .../v3/get-custom-violation-report.api.mdx | 87 ++ ...-default-identity-attribute-config.api.mdx | 96 ++ .../v3/get-default-violation-report.api.mdx | 87 ++ .../api/v3/get-entitlements-schema.api.mdx | 89 ++ .../v3/get-identity-access-summaries.api.mdx | 119 +++ .../api/v3/get-identity-certification.api.mdx | 87 ++ .../v3/get-identity-decision-summary.api.mdx | 87 ++ .../idn/api/v3/get-identity-profile.api.mdx | 104 ++ .../idn/api/v3/get-identity-summaries.api.mdx | 87 ++ .../idn/api/v3/get-identity-summary.api.mdx | 87 ++ .../idn/api/v3/get-lifecycle-state.api.mdx | 92 ++ .../get-non-employee-approval-summary.api.mdx | 79 ++ .../api/v3/get-non-employee-approval.api.mdx | 94 ++ ...et-non-employee-bulk-upload-status.api.mdx | 77 ++ .../api/v3/get-non-employee-record.api.mdx | 80 ++ .../get-non-employee-request-summary.api.mdx | 79 ++ .../api/v3/get-non-employee-request.api.mdx | 103 ++ .../get-non-employee-schema-attribute.api.mdx | 75 ++ ...-employee-source-schema-attributes.api.mdx | 88 ++ .../api/v3/get-non-employee-source.api.mdx | 87 ++ products/idn/api/v3/get-oauth-client.api.mdx | 87 ++ .../api/v3/get-password-change-status.api.mdx | 87 ++ .../api/v3/get-password-dictionary.api.mdx | 116 +++ .../api/v3/get-password-org-config.api.mdx | 75 ++ .../api/v3/get-password-sync-group.api.mdx | 87 ++ .../api/v3/get-password-sync-groups.api.mdx | 75 ++ .../api/v3/get-provisioning-policy.api.mdx | 88 ++ .../idn/api/v3/get-public-identities.api.mdx | 83 ++ .../api/v3/get-public-identity-config.api.mdx | 83 ++ .../v3/get-role-assigned-identities.api.mdx | 75 ++ products/idn/api/v3/get-role.api.mdx | 133 +++ products/idn/api/v3/get-saved-search.api.mdx | 116 +++ .../idn/api/v3/get-scheduled-search.api.mdx | 112 +++ products/idn/api/v3/get-segment.api.mdx | 97 ++ ...-service-desk-integration-template.api.mdx | 103 ++ ...get-service-desk-integration-types.api.mdx | 87 ++ .../v3/get-service-desk-integration.api.mdx | 115 +++ .../v3/get-service-desk-integrations.api.mdx | 115 +++ .../v3/get-sod-all-report-run-status.api.mdx | 75 ++ .../api/v3/get-sod-policy-schedule.api.mdx | 92 ++ products/idn/api/v3/get-sod-policy.api.mdx | 104 ++ ...et-sod-violation-report-run-status.api.mdx | 87 ++ .../get-sod-violation-report-status.api.mdx | 87 ++ products/idn/api/v3/get-source-health.api.mdx | 87 ++ products/idn/api/v3/get-source-schema.api.mdx | 96 ++ products/idn/api/v3/get-source.api.mdx | 128 +++ .../api/v3/get-status-check-details.api.mdx | 87 ++ products/idn/api/v3/get-tagged-object.api.mdx | 75 ++ products/idn/api/v3/get-transform.api.mdx | 494 ++++++++++ products/idn/api/v3/get-work-item.api.mdx | 75 ++ .../idn/api/v3/get-work-items-summary.api.mdx | 75 ++ products/idn/api/v3/identity-profiles.tag.mdx | 30 + .../idn/api/v3/identitynow-v-3-api.info.mdx | 36 + .../idn/api/v3/import-accounts-schema.api.mdx | 89 ++ .../idn/api/v3/import-connector-file.api.mdx | 116 +++ .../api/v3/import-entitlements-schema.api.mdx | 89 ++ .../api/v3/import-identity-profiles.api.mdx | 123 +++ ...mport-non-employee-records-in-bulk.api.mdx | 89 ++ products/idn/api/v3/lifecycle-states.tag.mdx | 58 ++ .../idn/api/v3/list-access-profiles.api.mdx | 113 +++ .../api/v3/list-access-request-status.api.mdx | 172 ++++ .../api/v3/list-account-activities.api.mdx | 91 ++ products/idn/api/v3/list-accounts.api.mdx | 80 ++ .../api/v3/list-completed-approvals.api.mdx | 135 +++ .../list-identity-access-review-items.api.mdx | 123 +++ .../v3/list-identity-certifications.api.mdx | 75 ++ .../idn/api/v3/list-identity-profiles.api.mdx | 92 ++ .../idn/api/v3/list-lifecycle-states.api.mdx | 80 ++ .../v3/list-non-employee-approvals.api.mdx | 83 ++ .../api/v3/list-non-employee-records.api.mdx | 81 ++ .../api/v3/list-non-employee-requests.api.mdx | 91 ++ .../api/v3/list-non-employee-sources.api.mdx | 87 ++ .../idn/api/v3/list-oauth-clients.api.mdx | 75 ++ .../idn/api/v3/list-pending-approvals.api.mdx | 131 +++ .../v3/list-personal-access-tokens.api.mdx | 79 ++ .../api/v3/list-provisioning-policies.api.mdx | 88 ++ .../api/v3/list-requestable-objects.api.mdx | 76 ++ products/idn/api/v3/list-roles.api.mdx | 133 +++ .../idn/api/v3/list-saved-searches.api.mdx | 88 ++ .../idn/api/v3/list-scheduled-search.api.mdx | 117 +++ products/idn/api/v3/list-segments.api.mdx | 84 ++ products/idn/api/v3/list-sod-policies.api.mdx | 92 ++ .../idn/api/v3/list-source-schemas.api.mdx | 96 ++ products/idn/api/v3/list-sources.api.mdx | 128 +++ .../v3/list-tagged-objects-by-type.api.mdx | 77 ++ .../idn/api/v3/list-tagged-objects.api.mdx | 77 ++ products/idn/api/v3/list-transforms.api.mdx | 494 ++++++++++ products/idn/api/v3/list-work-items.api.mdx | 75 ++ .../idn/api/v3/make-identity-decision.api.mdx | 91 ++ products/idn/api/v3/move.api.mdx | 95 ++ .../non-employee-lifecycle-management.tag.mdx | 51 + products/idn/api/v3/o-auth-clients.tag.mdx | 23 + .../idn/api/v3/password-configuration.tag.mdx | 26 + .../idn/api/v3/password-dictionary.tag.mdx | 67 ++ .../idn/api/v3/password-management.tag.mdx | 44 + .../idn/api/v3/password-sync-groups.tag.mdx | 52 + .../idn/api/v3/patch-access-profile.api.mdx | 122 +++ .../api/v3/patch-non-employee-record.api.mdx | 103 ++ ...atch-non-employee-schema-attribute.api.mdx | 97 ++ .../api/v3/patch-non-employee-source.api.mdx | 91 ++ .../idn/api/v3/patch-oauth-client.api.mdx | 111 +++ .../v3/patch-personal-access-token.api.mdx | 104 ++ products/idn/api/v3/patch-role.api.mdx | 139 +++ products/idn/api/v3/patch-segment.api.mdx | 112 +++ .../v3/patch-service-desk-integration.api.mdx | 135 +++ products/idn/api/v3/patch-sod-policy.api.mdx | 127 +++ .../idn/api/v3/personal-access-tokens.tag.mdx | 31 + .../api/v3/public-identities-config.tag.mdx | 30 + products/idn/api/v3/public-identities.tag.mdx | 23 + products/idn/api/v3/put-account.api.mdx | 93 ++ .../api/v3/put-provisioning-policy.api.mdx | 90 ++ products/idn/api/v3/put-saved-search.api.mdx | 141 +++ .../v3/put-service-desk-integration.api.mdx | 147 +++ products/idn/api/v3/put-source-schema.api.mdx | 113 +++ products/idn/api/v3/put-source.api.mdx | 182 ++++ products/idn/api/v3/put-tagged-object.api.mdx | 75 ++ .../idn/api/v3/query-password-info.api.mdx | 87 ++ .../reassign-identity-certifications.api.mdx | 87 ++ .../idn/api/v3/reject-access-request.api.mdx | 91 ++ .../idn/api/v3/reject-approval-item.api.mdx | 87 ++ .../v3/reject-approval-items-in-bulk.api.mdx | 87 ++ .../v3/reject-non-employee-request.api.mdx | 79 ++ products/idn/api/v3/reload-account.api.mdx | 88 ++ .../idn/api/v3/requestable-objects.tag.mdx | 23 + products/idn/api/v3/roles.tag.mdx | 57 ++ products/idn/api/v3/saved-search.tag.mdx | 30 + products/idn/api/v3/scheduled-search.tag.mdx | 46 + products/idn/api/v3/search-aggregate.api.mdx | 195 ++++ products/idn/api/v3/search-count.api.mdx | 155 +++ products/idn/api/v3/search-get.api.mdx | 115 +++ products/idn/api/v3/search-post.api.mdx | 183 ++++ products/idn/api/v3/search.tag.mdx | 43 + products/idn/api/v3/segments.tag.mdx | 16 + .../api/v3/service-desk-integration.tag.mdx | 44 + .../idn/api/v3/set-lifecycle-state.api.mdx | 88 ++ products/idn/api/v3/set-password.api.mdx | 116 +++ .../idn/api/v3/set-policy-schedule.api.mdx | 109 +++ products/idn/api/v3/set-sod-policy.api.mdx | 120 +++ products/idn/api/v3/set-tag-to-object.api.mdx | 81 ++ .../api/v3/set-tags-to-many-objects.api.mdx | 81 ++ products/idn/api/v3/sidebar.js | 1 + .../sign-off-identity-certification.api.mdx | 87 ++ products/idn/api/v3/sod-policy.tag.mdx | 20 + products/idn/api/v3/sod-violations.tag.mdx | 20 + products/idn/api/v3/sources.tag.mdx | 77 ++ products/idn/api/v3/start-campaign.api.mdx | 92 ++ .../api/v3/start-evaluate-sod-policy.api.mdx | 75 ++ .../v3/start-predict-sod-violations.api.mdx | 109 +++ .../v3/start-sod-all-policies-for-org.api.mdx | 75 ++ products/idn/api/v3/start-sod-policy.api.mdx | 87 ++ .../idn/api/v3/start-violation-check.api.mdx | 97 ++ .../api/v3/submit-account-selection.api.mdx | 91 ++ products/idn/api/v3/tagged-objects.tag.mdx | 16 + products/idn/api/v3/transforms.tag.mdx | 26 + products/idn/api/v3/unlock-account.api.mdx | 88 ++ .../v3/unsubscribe-scheduled-search.api.mdx | 73 ++ .../v3/update-access-request-config.api.mdx | 100 ++ products/idn/api/v3/update-account.api.mdx | 104 ++ .../api/v3/update-lifecycle-states.api.mdx | 108 +++ .../api/v3/update-non-employee-record.api.mdx | 103 ++ .../api/v3/update-password-dictionary.api.mdx | 124 +++ .../api/v3/update-password-org-config.api.mdx | 75 ++ .../api/v3/update-password-sync-group.api.mdx | 87 ++ ...date-provisioning-policies-in-bulk.api.mdx | 88 ++ .../api/v3/update-provisioning-policy.api.mdx | 98 ++ .../v3/update-public-identity-config.api.mdx | 91 ++ .../api/v3/update-scheduled-search.api.mdx | 142 +++ .../idn/api/v3/update-source-schema.api.mdx | 132 +++ products/idn/api/v3/update-source.api.mdx | 152 +++ .../v3/update-status-check-details.api.mdx | 91 ++ products/idn/api/v3/update-transform.api.mdx | 904 ++++++++++++++++++ products/idn/api/v3/work-items.tag.mdx | 34 + .../event-triggers/filtering-events.md | 2 +- products/iiq/api/accounts.tag.mdx | 16 + products/iiq/api/alerts.tag.mdx | 16 + products/iiq/api/applications.tag.mdx | 20 + .../iiq/api/check-policy-violations.api.mdx | 56 ++ .../iiq/api/checked-policy-violations.tag.mdx | 16 + products/iiq/api/create-account.api.mdx | 71 ++ products/iiq/api/create-alert.api.mdx | 63 ++ products/iiq/api/create-user.api.mdx | 139 +++ products/iiq/api/delete-account.api.mdx | 31 + products/iiq/api/delete-user.api.mdx | 31 + products/iiq/api/entitlements.tag.mdx | 16 + products/iiq/api/get-account-by-id.api.mdx | 63 ++ products/iiq/api/get-accounts.api.mdx | 67 ++ products/iiq/api/get-alert-by-id.api.mdx | 54 ++ products/iiq/api/get-alerts.api.mdx | 89 ++ products/iiq/api/get-application.api.mdx | 47 + products/iiq/api/get-applications.api.mdx | 64 ++ .../iiq/api/get-entitlement-by-id.api.mdx | 58 ++ products/iiq/api/get-entitlements.api.mdx | 88 ++ .../api/get-launched-workflow-by-id.api.mdx | 49 + .../iiq/api/get-object-config-by-id.api.mdx | 55 ++ products/iiq/api/get-object-configs.api.mdx | 75 ++ .../api/get-policy-violation-by-id.api.mdx | 55 ++ .../iiq/api/get-policy-violations.api.mdx | 59 ++ .../iiq/api/get-resource-type-by-id.api.mdx | 35 + products/iiq/api/get-resource-types.api.mdx | 39 + products/iiq/api/get-role.api.mdx | 59 ++ products/iiq/api/get-roles.api.mdx | 91 ++ products/iiq/api/get-schema-by-id.api.mdx | 39 + products/iiq/api/get-schemas.api.mdx | 47 + .../iiq/api/get-task-result-by-id.api.mdx | 40 + products/iiq/api/get-user-by-id.api.mdx | 127 +++ products/iiq/api/get-users.api.mdx | 131 +++ products/iiq/api/get-workflow-by-id.api.mdx | 37 + .../iiq/api/identityiq-scim-rest-api.info.mdx | 25 + products/iiq/api/launch-workflow.api.mdx | 51 + .../iiq/api/launched-workflows-get.api.mdx | 64 ++ products/iiq/api/launched-workflows.tag.mdx | 16 + products/iiq/api/object-config.tag.mdx | 16 + products/iiq/api/policy-violations.tag.mdx | 16 + products/iiq/api/resource-types.tag.mdx | 16 + products/iiq/api/roles.tag.mdx | 16 + products/iiq/api/schemas.tag.mdx | 16 + .../api/service-provider-config-get.api.mdx | 96 ++ .../iiq/api/service-provider-config.tag.mdx | 16 + products/iiq/api/sidebar.js | 1 + products/iiq/api/task-results-get.api.mdx | 48 + products/iiq/api/task-results.tag.mdx | 16 + products/iiq/api/update-account.api.mdx | 71 ++ products/iiq/api/update-user.api.mdx | 135 +++ products/iiq/api/users.tag.mdx | 16 + products/iiq/api/workflows-get.api.mdx | 40 + products/iiq/api/workflows.tag.mdx | 16 + 776 files changed, 66969 insertions(+), 5 deletions(-) create mode 100644 products/idn/api/beta/access-profiles.tag.mdx create mode 100644 products/idn/api/beta/access-request-approvals.tag.mdx create mode 100644 products/idn/api/beta/access-requests.tag.mdx create mode 100644 products/idn/api/beta/account-activities.tag.mdx create mode 100644 products/idn/api/beta/account-aggregations.tag.mdx create mode 100644 products/idn/api/beta/accounts.tag.mdx create mode 100644 products/idn/api/beta/add-access-request-recommendations-ignored-item.api.mdx create mode 100644 products/idn/api/beta/add-access-request-recommendations-requested-item.api.mdx create mode 100644 products/idn/api/beta/add-access-request-recommendations-viewed-item.api.mdx create mode 100644 products/idn/api/beta/add-access-request-recommendations-viewed-items.api.mdx create mode 100644 products/idn/api/beta/add-tag-to-object.api.mdx create mode 100644 products/idn/api/beta/add-tags-to-many-objects.api.mdx create mode 100644 products/idn/api/beta/approve-access-request.api.mdx create mode 100644 products/idn/api/beta/approve-approval-item.api.mdx create mode 100644 products/idn/api/beta/approve-approval-items-in-bulk.api.mdx create mode 100644 products/idn/api/beta/approve-non-employee-request.api.mdx create mode 100644 products/idn/api/beta/bulk-delete-roles.api.mdx create mode 100644 products/idn/api/beta/cancel-access-request.api.mdx create mode 100644 products/idn/api/beta/cancel-workflow-execution.api.mdx create mode 100644 products/idn/api/beta/certification-campaigns.tag.mdx create mode 100644 products/idn/api/beta/certifications.tag.mdx create mode 100644 products/idn/api/beta/close-access-request.api.mdx create mode 100644 products/idn/api/beta/compare-identity-snapshots-access-type.api.mdx create mode 100644 products/idn/api/beta/compare-identity-snapshots.api.mdx create mode 100644 products/idn/api/beta/complete-campaign.api.mdx create mode 100644 products/idn/api/beta/complete-trigger-invocation.api.mdx create mode 100644 products/idn/api/beta/complete-work-item.api.mdx create mode 100644 products/idn/api/beta/connector-rule-management.tag.mdx create mode 100644 products/idn/api/beta/connectors.tag.mdx create mode 100644 products/idn/api/beta/create-access-profile.api.mdx create mode 100644 products/idn/api/beta/create-access-request.api.mdx create mode 100644 products/idn/api/beta/create-account.api.mdx create mode 100644 products/idn/api/beta/create-campaign-template.api.mdx create mode 100644 products/idn/api/beta/create-campaign.api.mdx create mode 100644 products/idn/api/beta/create-common-access.api.mdx create mode 100644 products/idn/api/beta/create-connector-rule.api.mdx create mode 100644 products/idn/api/beta/create-custom-password-instructions.api.mdx create mode 100644 products/idn/api/beta/create-domain-dkim.api.mdx create mode 100644 products/idn/api/beta/create-form-definition-dynamic-schema.api.mdx create mode 100644 products/idn/api/beta/create-form-definition.api.mdx create mode 100644 products/idn/api/beta/create-form-instance.api.mdx create mode 100644 products/idn/api/beta/create-identity-profile.api.mdx create mode 100644 products/idn/api/beta/create-non-employee-record.api.mdx create mode 100644 products/idn/api/beta/create-non-employee-request.api.mdx create mode 100644 products/idn/api/beta/create-non-employee-source-schema-attributes.api.mdx create mode 100644 products/idn/api/beta/create-non-employee-source.api.mdx create mode 100644 products/idn/api/beta/create-notification-template.api.mdx create mode 100644 products/idn/api/beta/create-oauth-client.api.mdx create mode 100644 products/idn/api/beta/create-password-org-config.api.mdx create mode 100644 products/idn/api/beta/create-password-sync-group.api.mdx create mode 100644 products/idn/api/beta/create-personal-access-token.api.mdx create mode 100644 products/idn/api/beta/create-potential-role-provision-request.api.mdx create mode 100644 products/idn/api/beta/create-provisioning-policy.api.mdx create mode 100644 products/idn/api/beta/create-reassignment-configuration.api.mdx create mode 100644 products/idn/api/beta/create-role-insight-requests.api.mdx create mode 100644 products/idn/api/beta/create-role-mining-sessions.api.mdx create mode 100644 products/idn/api/beta/create-role.api.mdx create mode 100644 products/idn/api/beta/create-search-attribute-config.api.mdx create mode 100644 products/idn/api/beta/create-segment.api.mdx create mode 100644 products/idn/api/beta/create-service-desk-integration.api.mdx create mode 100644 products/idn/api/beta/create-sod-policy.api.mdx create mode 100644 products/idn/api/beta/create-source-schema.api.mdx create mode 100644 products/idn/api/beta/create-source.api.mdx create mode 100644 products/idn/api/beta/create-subscription.api.mdx create mode 100644 products/idn/api/beta/create-transform.api.mdx create mode 100644 products/idn/api/beta/create-verified-from-address.api.mdx create mode 100644 products/idn/api/beta/create-workflow.api.mdx create mode 100644 products/idn/api/beta/create-workgroup.api.mdx create mode 100644 products/idn/api/beta/custom-forms.tag.mdx create mode 100644 products/idn/api/beta/custom-password-instructions.tag.mdx create mode 100644 products/idn/api/beta/delete-access-profile.api.mdx create mode 100644 products/idn/api/beta/delete-access-profiles-in-bulk.api.mdx create mode 100644 products/idn/api/beta/delete-account.api.mdx create mode 100644 products/idn/api/beta/delete-campaign-template-schedule.api.mdx create mode 100644 products/idn/api/beta/delete-campaign-template.api.mdx create mode 100644 products/idn/api/beta/delete-campaigns.api.mdx create mode 100644 products/idn/api/beta/delete-connector-rule.api.mdx create mode 100644 products/idn/api/beta/delete-custom-password-instructions.api.mdx create mode 100644 products/idn/api/beta/delete-form-definition.api.mdx create mode 100644 products/idn/api/beta/delete-identity-profile.api.mdx create mode 100644 products/idn/api/beta/delete-identity-profiles.api.mdx create mode 100644 products/idn/api/beta/delete-identity.api.mdx create mode 100644 products/idn/api/beta/delete-non-employee-record-in-bulk.api.mdx create mode 100644 products/idn/api/beta/delete-non-employee-record.api.mdx create mode 100644 products/idn/api/beta/delete-non-employee-request.api.mdx create mode 100644 products/idn/api/beta/delete-non-employee-schema-attribute.api.mdx create mode 100644 products/idn/api/beta/delete-non-employee-source-schema-attributes.api.mdx create mode 100644 products/idn/api/beta/delete-non-employee-source.api.mdx create mode 100644 products/idn/api/beta/delete-notification-templates-in-bulk.api.mdx create mode 100644 products/idn/api/beta/delete-oauth-client.api.mdx create mode 100644 products/idn/api/beta/delete-password-sync-group.api.mdx create mode 100644 products/idn/api/beta/delete-personal-access-token.api.mdx create mode 100644 products/idn/api/beta/delete-provisioning-policy.api.mdx create mode 100644 products/idn/api/beta/delete-reassignment-configuration.api.mdx create mode 100644 products/idn/api/beta/delete-role.api.mdx create mode 100644 products/idn/api/beta/delete-search-attribute-config.api.mdx create mode 100644 products/idn/api/beta/delete-segment.api.mdx create mode 100644 products/idn/api/beta/delete-service-desk-integration.api.mdx create mode 100644 products/idn/api/beta/delete-sod-policy-schedule.api.mdx create mode 100644 products/idn/api/beta/delete-sod-policy.api.mdx create mode 100644 products/idn/api/beta/delete-source-schema.api.mdx create mode 100644 products/idn/api/beta/delete-subscription.api.mdx create mode 100644 products/idn/api/beta/delete-tagged-object.api.mdx create mode 100644 products/idn/api/beta/delete-transform.api.mdx create mode 100644 products/idn/api/beta/delete-verified-from-address.api.mdx create mode 100644 products/idn/api/beta/delete-workflow.api.mdx create mode 100644 products/idn/api/beta/delete.api.mdx create mode 100644 products/idn/api/beta/disable-account-for-identity.api.mdx create mode 100644 products/idn/api/beta/disable-account.api.mdx create mode 100644 products/idn/api/beta/disable-accounts-for-identities.api.mdx create mode 100644 products/idn/api/beta/download-custom-violation-report.api.mdx create mode 100644 products/idn/api/beta/download-default-violation-report.api.mdx create mode 100644 products/idn/api/beta/download-role-insights-entitlements-changes.api.mdx create mode 100644 products/idn/api/beta/download-role-mining-potential-role-zip.api.mdx create mode 100644 products/idn/api/beta/enable-account-for-identity.api.mdx create mode 100644 products/idn/api/beta/enable-account.api.mdx create mode 100644 products/idn/api/beta/enable-accounts-for-identities.api.mdx create mode 100644 products/idn/api/beta/entitlements.tag.mdx create mode 100644 products/idn/api/beta/export-form-definitions-by-tenant.api.mdx create mode 100644 products/idn/api/beta/export-identity-profiles.api.mdx create mode 100644 products/idn/api/beta/export-non-employee-records.api.mdx create mode 100644 products/idn/api/beta/export-non-employee-source-schema-template.api.mdx create mode 100644 products/idn/api/beta/export-outliers-zip.api.mdx create mode 100644 products/idn/api/beta/export-role-mining-potential-role-async.api.mdx create mode 100644 products/idn/api/beta/export-role-mining-potential-role-status.api.mdx create mode 100644 products/idn/api/beta/export-role-mining-potential-role.api.mdx create mode 100644 products/idn/api/beta/export-sp-config.api.mdx create mode 100644 products/idn/api/beta/forward-access-request.api.mdx create mode 100644 products/idn/api/beta/forward-work-item.api.mdx create mode 100644 products/idn/api/beta/generate-campaign-template.api.mdx create mode 100644 products/idn/api/beta/generate-digit-token.api.mdx create mode 100644 products/idn/api/beta/generate-identity-preview.api.mdx create mode 100644 products/idn/api/beta/get-access-profile-entitlements.api.mdx create mode 100644 products/idn/api/beta/get-access-profile.api.mdx create mode 100644 products/idn/api/beta/get-access-request-approval-summary.api.mdx create mode 100644 products/idn/api/beta/get-access-request-config.api.mdx create mode 100644 products/idn/api/beta/get-access-request-recommendations-ignored-items.api.mdx create mode 100644 products/idn/api/beta/get-access-request-recommendations-requested-items.api.mdx create mode 100644 products/idn/api/beta/get-access-request-recommendations-viewed-items.api.mdx create mode 100644 products/idn/api/beta/get-access-request-recommendations.api.mdx create mode 100644 products/idn/api/beta/get-account-activity.api.mdx create mode 100644 products/idn/api/beta/get-account-aggregation-status.api.mdx create mode 100644 products/idn/api/beta/get-account-entitlements.api.mdx create mode 100644 products/idn/api/beta/get-account.api.mdx create mode 100644 products/idn/api/beta/get-active-campaigns.api.mdx create mode 100644 products/idn/api/beta/get-campaign-reports-config.api.mdx create mode 100644 products/idn/api/beta/get-campaign-reports.api.mdx create mode 100644 products/idn/api/beta/get-campaign-template-schedule.api.mdx create mode 100644 products/idn/api/beta/get-campaign-template.api.mdx create mode 100644 products/idn/api/beta/get-campaign.api.mdx create mode 100644 products/idn/api/beta/get-client-log-configuration.api.mdx create mode 100644 products/idn/api/beta/get-common-access.api.mdx create mode 100644 products/idn/api/beta/get-completed-work-items.api.mdx create mode 100644 products/idn/api/beta/get-connector-list.api.mdx create mode 100644 products/idn/api/beta/get-connector-rule-list.api.mdx create mode 100644 products/idn/api/beta/get-connector-rule.api.mdx create mode 100644 products/idn/api/beta/get-count-completed-work-items.api.mdx create mode 100644 products/idn/api/beta/get-count-work-items.api.mdx create mode 100644 products/idn/api/beta/get-custom-password-instructions.api.mdx create mode 100644 products/idn/api/beta/get-default-identity-attribute-config.api.mdx create mode 100644 products/idn/api/beta/get-dkim-attributes.api.mdx create mode 100644 products/idn/api/beta/get-entitlement-changes-identities.api.mdx create mode 100644 products/idn/api/beta/get-entitlement-distribution-potential-role.api.mdx create mode 100644 products/idn/api/beta/get-entitlement-request-config.api.mdx create mode 100644 products/idn/api/beta/get-entitlement.api.mdx create mode 100644 products/idn/api/beta/get-entitlements-potential-role.api.mdx create mode 100644 products/idn/api/beta/get-evaluate-reassignment-configuration.api.mdx create mode 100644 products/idn/api/beta/get-excluded-entitlements-potential-role.api.mdx create mode 100644 products/idn/api/beta/get-form-definition-by-key.api.mdx create mode 100644 products/idn/api/beta/get-form-instance-by-key.api.mdx create mode 100644 products/idn/api/beta/get-historical-identity-events.api.mdx create mode 100644 products/idn/api/beta/get-historical-identity.api.mdx create mode 100644 products/idn/api/beta/get-identities-potential-role.api.mdx create mode 100644 products/idn/api/beta/get-identity-certification-item-permissions.api.mdx create mode 100644 products/idn/api/beta/get-identity-certification-pending-tasks.api.mdx create mode 100644 products/idn/api/beta/get-identity-certification-task-status.api.mdx create mode 100644 products/idn/api/beta/get-identity-outlier-snapshots.api.mdx create mode 100644 products/idn/api/beta/get-identity-outliers.api.mdx create mode 100644 products/idn/api/beta/get-identity-password-change-status.api.mdx create mode 100644 products/idn/api/beta/get-identity-profile.api.mdx create mode 100644 products/idn/api/beta/get-identity-snapshot-summary.api.mdx create mode 100644 products/idn/api/beta/get-identity-snapshot.api.mdx create mode 100644 products/idn/api/beta/get-identity-start-date.api.mdx create mode 100644 products/idn/api/beta/get-identity.api.mdx create mode 100644 products/idn/api/beta/get-latest-identity-outlier-snapshots.api.mdx create mode 100644 products/idn/api/beta/get-mail-from-attributes.api.mdx create mode 100644 products/idn/api/beta/get-managed-client-status.api.mdx create mode 100644 products/idn/api/beta/get-managed-cluster.api.mdx create mode 100644 products/idn/api/beta/get-managed-clusters.api.mdx create mode 100644 products/idn/api/beta/get-message-catalogs.api.mdx create mode 100644 products/idn/api/beta/get-mfa-config.api.mdx create mode 100644 products/idn/api/beta/get-non-employee-approval-summary.api.mdx create mode 100644 products/idn/api/beta/get-non-employee-approval.api.mdx create mode 100644 products/idn/api/beta/get-non-employee-bulk-upload-status.api.mdx create mode 100644 products/idn/api/beta/get-non-employee-record.api.mdx create mode 100644 products/idn/api/beta/get-non-employee-request-summary.api.mdx create mode 100644 products/idn/api/beta/get-non-employee-request.api.mdx create mode 100644 products/idn/api/beta/get-non-employee-schema-attribute.api.mdx create mode 100644 products/idn/api/beta/get-non-employee-source-schema-attributes.api.mdx create mode 100644 products/idn/api/beta/get-non-employee-source.api.mdx create mode 100644 products/idn/api/beta/get-notification-preference.api.mdx create mode 100644 products/idn/api/beta/get-notification-template.api.mdx create mode 100644 products/idn/api/beta/get-notifications-template-context.api.mdx create mode 100644 products/idn/api/beta/get-oauth-client.api.mdx create mode 100644 products/idn/api/beta/get-org-config.api.mdx create mode 100644 products/idn/api/beta/get-password-dictionary.api.mdx create mode 100644 products/idn/api/beta/get-password-org-config.api.mdx create mode 100644 products/idn/api/beta/get-password-sync-group.api.mdx create mode 100644 products/idn/api/beta/get-password-sync-groups.api.mdx create mode 100644 products/idn/api/beta/get-peer-group-outliers-contributing-features.api.mdx create mode 100644 products/idn/api/beta/get-peer-group-outliers.api.mdx create mode 100644 products/idn/api/beta/get-potential-role-applications.api.mdx create mode 100644 products/idn/api/beta/get-potential-role-summaries.api.mdx create mode 100644 products/idn/api/beta/get-potential-role.api.mdx create mode 100644 products/idn/api/beta/get-provisioning-policy.api.mdx create mode 100644 products/idn/api/beta/get-public-identity-config.api.mdx create mode 100644 products/idn/api/beta/get-reassignment-config-types.api.mdx create mode 100644 products/idn/api/beta/get-reassignment-configuration.api.mdx create mode 100644 products/idn/api/beta/get-recommendations-config.api.mdx create mode 100644 products/idn/api/beta/get-recommendations.api.mdx create mode 100644 products/idn/api/beta/get-role-assigned-identities.api.mdx create mode 100644 products/idn/api/beta/get-role-insight.api.mdx create mode 100644 products/idn/api/beta/get-role-insights-current-entitlements.api.mdx create mode 100644 products/idn/api/beta/get-role-insights-entitlements-changes.api.mdx create mode 100644 products/idn/api/beta/get-role-insights-requests.api.mdx create mode 100644 products/idn/api/beta/get-role-insights-summary.api.mdx create mode 100644 products/idn/api/beta/get-role-insights.api.mdx create mode 100644 products/idn/api/beta/get-role-mining-session-status.api.mdx create mode 100644 products/idn/api/beta/get-role-mining-session.api.mdx create mode 100644 products/idn/api/beta/get-role-mining-sessions.api.mdx create mode 100644 products/idn/api/beta/get-role.api.mdx create mode 100644 products/idn/api/beta/get-search-attribute-config.api.mdx create mode 100644 products/idn/api/beta/get-segment.api.mdx create mode 100644 products/idn/api/beta/get-service-desk-integration-list.api.mdx create mode 100644 products/idn/api/beta/get-service-desk-integration-template.api.mdx create mode 100644 products/idn/api/beta/get-service-desk-integration-types.api.mdx create mode 100644 products/idn/api/beta/get-service-desk-integration.api.mdx create mode 100644 products/idn/api/beta/get-single-search-attribute-config.api.mdx create mode 100644 products/idn/api/beta/get-sod-all-report-run-status.api.mdx create mode 100644 products/idn/api/beta/get-sod-policy-schedule.api.mdx create mode 100644 products/idn/api/beta/get-sod-policy.api.mdx create mode 100644 products/idn/api/beta/get-sod-violation-report-run-status.api.mdx create mode 100644 products/idn/api/beta/get-sod-violation-report-status.api.mdx create mode 100644 products/idn/api/beta/get-source-accounts-schema.api.mdx create mode 100644 products/idn/api/beta/get-source-attr-sync-config.api.mdx create mode 100644 products/idn/api/beta/get-source-config.api.mdx create mode 100644 products/idn/api/beta/get-source-entitlement-request-config.api.mdx create mode 100644 products/idn/api/beta/get-source-entitlements-schema.api.mdx create mode 100644 products/idn/api/beta/get-source-schema.api.mdx create mode 100644 products/idn/api/beta/get-source.api.mdx create mode 100644 products/idn/api/beta/get-sp-config-export-status.api.mdx create mode 100644 products/idn/api/beta/get-sp-config-export.api.mdx create mode 100644 products/idn/api/beta/get-sp-config-import-status.api.mdx create mode 100644 products/idn/api/beta/get-sp-config-import.api.mdx create mode 100644 products/idn/api/beta/get-status-check-details.api.mdx create mode 100644 products/idn/api/beta/get-tagged-object.api.mdx create mode 100644 products/idn/api/beta/get-tenant-config-configuration.api.mdx create mode 100644 products/idn/api/beta/get-transform.api.mdx create mode 100644 products/idn/api/beta/get-valid-time-zones.api.mdx create mode 100644 products/idn/api/beta/get-work-item.api.mdx create mode 100644 products/idn/api/beta/get-work-items-summary.api.mdx create mode 100644 products/idn/api/beta/get-workflow-execution-history.api.mdx create mode 100644 products/idn/api/beta/get-workflow-execution.api.mdx create mode 100644 products/idn/api/beta/get-workflow.api.mdx create mode 100644 products/idn/api/beta/get-workgroup.api.mdx create mode 100644 products/idn/api/beta/governance-groups.tag.mdx create mode 100644 products/idn/api/beta/iai-access-request-recommendations.tag.mdx create mode 100644 products/idn/api/beta/iai-common-access.tag.mdx create mode 100644 products/idn/api/beta/iai-outliers.tag.mdx create mode 100644 products/idn/api/beta/iai-peer-group-strategies.tag.mdx create mode 100644 products/idn/api/beta/iai-recommendations.tag.mdx create mode 100644 products/idn/api/beta/iai-role-mining.tag.mdx create mode 100644 products/idn/api/beta/identities.tag.mdx create mode 100644 products/idn/api/beta/identity-history.tag.mdx create mode 100644 products/idn/api/beta/identity-profiles.tag.mdx create mode 100644 products/idn/api/beta/identitynow-beta-api.info.mdx create mode 100644 products/idn/api/beta/ignore-identity-outliers.api.mdx create mode 100644 products/idn/api/beta/import-form-definitions.api.mdx create mode 100644 products/idn/api/beta/import-identity-profiles.api.mdx create mode 100644 products/idn/api/beta/import-non-employee-records-in-bulk.api.mdx create mode 100644 products/idn/api/beta/import-source-accounts-schema.api.mdx create mode 100644 products/idn/api/beta/import-source-connector-file.api.mdx create mode 100644 products/idn/api/beta/import-source-entitlements-schema.api.mdx create mode 100644 products/idn/api/beta/import-sp-config.api.mdx create mode 100644 products/idn/api/beta/lifecycle-states.tag.mdx create mode 100644 products/idn/api/beta/list-access-profiles.api.mdx create mode 100644 products/idn/api/beta/list-access-request-status.api.mdx create mode 100644 products/idn/api/beta/list-account-activities.api.mdx create mode 100644 products/idn/api/beta/list-accounts.api.mdx create mode 100644 products/idn/api/beta/list-campaign-templates.api.mdx create mode 100644 products/idn/api/beta/list-certification-reviewers.api.mdx create mode 100644 products/idn/api/beta/list-complete-workflow-library.api.mdx create mode 100644 products/idn/api/beta/list-completed-approvals.api.mdx create mode 100644 products/idn/api/beta/list-entitlement-children.api.mdx create mode 100644 products/idn/api/beta/list-entitlement-parents.api.mdx create mode 100644 products/idn/api/beta/list-entitlements.api.mdx create mode 100644 products/idn/api/beta/list-from-addresses.api.mdx create mode 100644 products/idn/api/beta/list-historical-identities.api.mdx create mode 100644 products/idn/api/beta/list-identities.api.mdx create mode 100644 products/idn/api/beta/list-identity-access-items.api.mdx create mode 100644 products/idn/api/beta/list-identity-profiles.api.mdx create mode 100644 products/idn/api/beta/list-identity-snapshot-access-items.api.mdx create mode 100644 products/idn/api/beta/list-identity-snapshots.api.mdx create mode 100644 products/idn/api/beta/list-lifecycle-states.api.mdx create mode 100644 products/idn/api/beta/list-non-employee-approval.api.mdx create mode 100644 products/idn/api/beta/list-non-employee-records.api.mdx create mode 100644 products/idn/api/beta/list-non-employee-requests.api.mdx create mode 100644 products/idn/api/beta/list-non-employee-sources.api.mdx create mode 100644 products/idn/api/beta/list-notification-template-defaults.api.mdx create mode 100644 products/idn/api/beta/list-notification-templates.api.mdx create mode 100644 products/idn/api/beta/list-oauth-clients.api.mdx create mode 100644 products/idn/api/beta/list-pending-approvals.api.mdx create mode 100644 products/idn/api/beta/list-personal-access-tokens.api.mdx create mode 100644 products/idn/api/beta/list-provisioning-policies.api.mdx create mode 100644 products/idn/api/beta/list-reassignment-configurations.api.mdx create mode 100644 products/idn/api/beta/list-requestable-objects.api.mdx create mode 100644 products/idn/api/beta/list-roles.api.mdx create mode 100644 products/idn/api/beta/list-segments.api.mdx create mode 100644 products/idn/api/beta/list-sod-policies.api.mdx create mode 100644 products/idn/api/beta/list-source-schemas.api.mdx create mode 100644 products/idn/api/beta/list-sources.api.mdx create mode 100644 products/idn/api/beta/list-sp-config-objects.api.mdx create mode 100644 products/idn/api/beta/list-subscriptions.api.mdx create mode 100644 products/idn/api/beta/list-tagged-objects-by-type.api.mdx create mode 100644 products/idn/api/beta/list-tagged-objects.api.mdx create mode 100644 products/idn/api/beta/list-transforms.api.mdx create mode 100644 products/idn/api/beta/list-trigger-invocation-status.api.mdx create mode 100644 products/idn/api/beta/list-triggers.api.mdx create mode 100644 products/idn/api/beta/list-work-items.api.mdx create mode 100644 products/idn/api/beta/list-workflow-executions.api.mdx create mode 100644 products/idn/api/beta/list-workflow-library-actions.api.mdx create mode 100644 products/idn/api/beta/list-workflow-library-operators.api.mdx create mode 100644 products/idn/api/beta/list-workflow-library-triggers.api.mdx create mode 100644 products/idn/api/beta/list-workflows.api.mdx create mode 100644 products/idn/api/beta/list-workgroups.api.mdx create mode 100644 products/idn/api/beta/managed-clients.tag.mdx create mode 100644 products/idn/api/beta/managed-clusters.tag.mdx create mode 100644 products/idn/api/beta/mfa-configuration.tag.mdx create mode 100644 products/idn/api/beta/move.api.mdx create mode 100644 products/idn/api/beta/non-employee-lifecycle-management.tag.mdx create mode 100644 products/idn/api/beta/notifications.tag.mdx create mode 100644 products/idn/api/beta/o-auth-clients.tag.mdx create mode 100644 products/idn/api/beta/org-config.tag.mdx create mode 100644 products/idn/api/beta/password-configuration.tag.mdx create mode 100644 products/idn/api/beta/password-dictionary.tag.mdx create mode 100644 products/idn/api/beta/password-management.tag.mdx create mode 100644 products/idn/api/beta/password-sync-groups.tag.mdx create mode 100644 products/idn/api/beta/patch-access-profile.api.mdx create mode 100644 products/idn/api/beta/patch-campaign-template.api.mdx create mode 100644 products/idn/api/beta/patch-entitlement.api.mdx create mode 100644 products/idn/api/beta/patch-form-definition.api.mdx create mode 100644 products/idn/api/beta/patch-form-instance.api.mdx create mode 100644 products/idn/api/beta/patch-non-employee-record.api.mdx create mode 100644 products/idn/api/beta/patch-non-employee-schema-attribute.api.mdx create mode 100644 products/idn/api/beta/patch-non-employee-source.api.mdx create mode 100644 products/idn/api/beta/patch-oauth-client.api.mdx create mode 100644 products/idn/api/beta/patch-org-config.api.mdx create mode 100644 products/idn/api/beta/patch-personal-access-token.api.mdx create mode 100644 products/idn/api/beta/patch-potential-role.api.mdx create mode 100644 products/idn/api/beta/patch-role-mining-session.api.mdx create mode 100644 products/idn/api/beta/patch-role.api.mdx create mode 100644 products/idn/api/beta/patch-search-attribute-config.api.mdx create mode 100644 products/idn/api/beta/patch-segment.api.mdx create mode 100644 products/idn/api/beta/patch-service-desk-integration.api.mdx create mode 100644 products/idn/api/beta/patch-sod-policy.api.mdx create mode 100644 products/idn/api/beta/patch-subscription.api.mdx create mode 100644 products/idn/api/beta/patch-workflow.api.mdx create mode 100644 products/idn/api/beta/peek-resource-objects.api.mdx create mode 100644 products/idn/api/beta/personal-access-tokens.tag.mdx create mode 100644 products/idn/api/beta/ping-cluster.api.mdx create mode 100644 products/idn/api/beta/post-external-execute-workflow.api.mdx create mode 100644 products/idn/api/beta/post-workflow-external-trigger.api.mdx create mode 100644 products/idn/api/beta/predict-sod-violations.api.mdx create mode 100644 products/idn/api/beta/public-identities-config.tag.mdx create mode 100644 products/idn/api/beta/put-account.api.mdx create mode 100644 products/idn/api/beta/put-client-log-configuration.api.mdx create mode 100644 products/idn/api/beta/put-entitlement-request-config.api.mdx create mode 100644 products/idn/api/beta/put-mail-from-attributes.api.mdx create mode 100644 products/idn/api/beta/put-notification-preference.api.mdx create mode 100644 products/idn/api/beta/put-provisioning-policy.api.mdx create mode 100644 products/idn/api/beta/put-reassignment-config.api.mdx create mode 100644 products/idn/api/beta/put-service-desk-integration.api.mdx create mode 100644 products/idn/api/beta/put-source-attr-sync-config.api.mdx create mode 100644 products/idn/api/beta/put-source-schema.api.mdx create mode 100644 products/idn/api/beta/put-source.api.mdx create mode 100644 products/idn/api/beta/put-tenant-configuration.api.mdx create mode 100644 products/idn/api/beta/query-password-info.api.mdx create mode 100644 products/idn/api/beta/reassign-identity-certs-async.api.mdx create mode 100644 products/idn/api/beta/refresh-identity-profile.api.mdx create mode 100644 products/idn/api/beta/reject-access-request.api.mdx create mode 100644 products/idn/api/beta/reject-approval-item.api.mdx create mode 100644 products/idn/api/beta/reject-approval-items-in-bulk.api.mdx create mode 100644 products/idn/api/beta/reject-non-employee-request.api.mdx create mode 100644 products/idn/api/beta/reload-account.api.mdx create mode 100644 products/idn/api/beta/remove-tags-to-many-object.api.mdx create mode 100644 products/idn/api/beta/requestable-objects.tag.mdx create mode 100644 products/idn/api/beta/role-insights.tag.mdx create mode 100644 products/idn/api/beta/roles.tag.mdx create mode 100644 products/idn/api/beta/run-campaign-remediation-scan.api.mdx create mode 100644 products/idn/api/beta/run-campaign-report.api.mdx create mode 100644 products/idn/api/beta/run-sod-all-policies-for-org.api.mdx create mode 100644 products/idn/api/beta/run-sod-policy.api.mdx create mode 100644 products/idn/api/beta/search-attribute-configuration.tag.mdx create mode 100644 products/idn/api/beta/search-form-definitions-by-tenant.api.mdx create mode 100644 products/idn/api/beta/search-form-element-data-by-element-id.api.mdx create mode 100644 products/idn/api/beta/search-form-instances-by-tenant.api.mdx create mode 100644 products/idn/api/beta/search-pre-defined-select-options.api.mdx create mode 100644 products/idn/api/beta/segments.tag.mdx create mode 100644 products/idn/api/beta/send-test-notification.api.mdx create mode 100644 products/idn/api/beta/service-desk-integration.tag.mdx create mode 100644 products/idn/api/beta/set-campaign-reports-config.api.mdx create mode 100644 products/idn/api/beta/set-campaign-template-schedule.api.mdx create mode 100644 products/idn/api/beta/set-identity-password.api.mdx create mode 100644 products/idn/api/beta/set-mfa-config.api.mdx create mode 100644 products/idn/api/beta/show-preview-data-source.api.mdx create mode 100644 products/idn/api/beta/sidebar.js create mode 100644 products/idn/api/beta/sod-policy.tag.mdx create mode 100644 products/idn/api/beta/sod-violations.tag.mdx create mode 100644 products/idn/api/beta/sources.tag.mdx create mode 100644 products/idn/api/beta/sp-config.tag.mdx create mode 100644 products/idn/api/beta/start-campaign.api.mdx create mode 100644 products/idn/api/beta/start-identity-processing.api.mdx create mode 100644 products/idn/api/beta/start-test-trigger-invocation.api.mdx create mode 100644 products/idn/api/beta/submit-account-selection.api.mdx create mode 100644 products/idn/api/beta/sync-attributes-for-source.api.mdx create mode 100644 products/idn/api/beta/synchronize-attributes-for-identity.api.mdx create mode 100644 products/idn/api/beta/tagged-objects.tag.mdx create mode 100644 products/idn/api/beta/test-external-execute-workflow.api.mdx create mode 100644 products/idn/api/beta/test-mfa-config.api.mdx create mode 100644 products/idn/api/beta/test-source-configuration.api.mdx create mode 100644 products/idn/api/beta/test-source-connection.api.mdx create mode 100644 products/idn/api/beta/test-subscription-filter.api.mdx create mode 100644 products/idn/api/beta/test-workflow.api.mdx create mode 100644 products/idn/api/beta/transforms.tag.mdx create mode 100644 products/idn/api/beta/triggers.tag.mdx create mode 100644 products/idn/api/beta/un-ignore-identity-outliers.api.mdx create mode 100644 products/idn/api/beta/unlock-account.api.mdx create mode 100644 products/idn/api/beta/update-access-request-config.api.mdx create mode 100644 products/idn/api/beta/update-account.api.mdx create mode 100644 products/idn/api/beta/update-campaign.api.mdx create mode 100644 products/idn/api/beta/update-common-access-status-in-bulk.api.mdx create mode 100644 products/idn/api/beta/update-connector-rule.api.mdx create mode 100644 products/idn/api/beta/update-entitlements-in-bulk.api.mdx create mode 100644 products/idn/api/beta/update-entitlements-potential-role.api.mdx create mode 100644 products/idn/api/beta/update-identity-profile.api.mdx create mode 100644 products/idn/api/beta/update-lifecycle-states.api.mdx create mode 100644 products/idn/api/beta/update-managed-client-status.api.mdx create mode 100644 products/idn/api/beta/update-non-employee-record.api.mdx create mode 100644 products/idn/api/beta/update-password-dictionary.api.mdx create mode 100644 products/idn/api/beta/update-password-org-config.api.mdx create mode 100644 products/idn/api/beta/update-password-sync-group.api.mdx create mode 100644 products/idn/api/beta/update-policy-schedule.api.mdx create mode 100644 products/idn/api/beta/update-provisioning-policies-in-bulk.api.mdx create mode 100644 products/idn/api/beta/update-provisioning-policy.api.mdx create mode 100644 products/idn/api/beta/update-public-identity-config.api.mdx create mode 100644 products/idn/api/beta/update-recommendations-config.api.mdx create mode 100644 products/idn/api/beta/update-sod-policy.api.mdx create mode 100644 products/idn/api/beta/update-source-entitlement-request-config.api.mdx create mode 100644 products/idn/api/beta/update-source-schema.api.mdx create mode 100644 products/idn/api/beta/update-source.api.mdx create mode 100644 products/idn/api/beta/update-status-check-details.api.mdx create mode 100644 products/idn/api/beta/update-subscription.api.mdx create mode 100644 products/idn/api/beta/update-tagged-object.api.mdx create mode 100644 products/idn/api/beta/update-transform.api.mdx create mode 100644 products/idn/api/beta/update-workflow.api.mdx create mode 100644 products/idn/api/beta/validate-connector-rule.api.mdx create mode 100644 products/idn/api/beta/work-items.tag.mdx create mode 100644 products/idn/api/beta/workflows.tag.mdx create mode 100644 products/idn/api/v3/access-profiles.tag.mdx create mode 100644 products/idn/api/v3/access-request-approvals.tag.mdx create mode 100644 products/idn/api/v3/access-requests.tag.mdx create mode 100644 products/idn/api/v3/account-activities.tag.mdx create mode 100644 products/idn/api/v3/accounts.tag.mdx create mode 100644 products/idn/api/v3/approve-access-request.api.mdx create mode 100644 products/idn/api/v3/approve-approval-item.api.mdx create mode 100644 products/idn/api/v3/approve-approval-items-in-bulk.api.mdx create mode 100644 products/idn/api/v3/approve-non-employee-request.api.mdx create mode 100644 products/idn/api/v3/cancel-access-request.api.mdx create mode 100644 products/idn/api/v3/certification-campaigns.tag.mdx create mode 100644 products/idn/api/v3/certification-summaries.tag.mdx create mode 100644 products/idn/api/v3/certifications.tag.mdx create mode 100644 products/idn/api/v3/complete-work-item.api.mdx create mode 100644 products/idn/api/v3/create-access-profile.api.mdx create mode 100644 products/idn/api/v3/create-access-request.api.mdx create mode 100644 products/idn/api/v3/create-account.api.mdx create mode 100644 products/idn/api/v3/create-campaign.api.mdx create mode 100644 products/idn/api/v3/create-lifecycle-state.api.mdx create mode 100644 products/idn/api/v3/create-non-employee-record.api.mdx create mode 100644 products/idn/api/v3/create-non-employee-request.api.mdx create mode 100644 products/idn/api/v3/create-non-employee-source-schema-attributes.api.mdx create mode 100644 products/idn/api/v3/create-non-employee-source.api.mdx create mode 100644 products/idn/api/v3/create-oauth-client.api.mdx create mode 100644 products/idn/api/v3/create-password-org-config.api.mdx create mode 100644 products/idn/api/v3/create-password-sync-group.api.mdx create mode 100644 products/idn/api/v3/create-personal-access-token.api.mdx create mode 100644 products/idn/api/v3/create-provisioning-policy.api.mdx create mode 100644 products/idn/api/v3/create-role.api.mdx create mode 100644 products/idn/api/v3/create-saved-search.api.mdx create mode 100644 products/idn/api/v3/create-scheduled-search.api.mdx create mode 100644 products/idn/api/v3/create-segment.api.mdx create mode 100644 products/idn/api/v3/create-service-desk-integration.api.mdx create mode 100644 products/idn/api/v3/create-sod-policy.api.mdx create mode 100644 products/idn/api/v3/create-source-schema.api.mdx create mode 100644 products/idn/api/v3/create-source.api.mdx create mode 100644 products/idn/api/v3/create-transform.api.mdx create mode 100644 products/idn/api/v3/delete-access-profiles-in-bulk.api.mdx create mode 100644 products/idn/api/v3/delete-account.api.mdx create mode 100644 products/idn/api/v3/delete-lifecycle-state.api.mdx create mode 100644 products/idn/api/v3/delete-non-employee-record.api.mdx create mode 100644 products/idn/api/v3/delete-non-employee-records-in-bulk.api.mdx create mode 100644 products/idn/api/v3/delete-non-employee-request.api.mdx create mode 100644 products/idn/api/v3/delete-non-employee-schema-attribute.api.mdx create mode 100644 products/idn/api/v3/delete-non-employee-source-schema-attributes.api.mdx create mode 100644 products/idn/api/v3/delete-non-employee-source.api.mdx create mode 100644 products/idn/api/v3/delete-oauth-client.api.mdx create mode 100644 products/idn/api/v3/delete-password-sync-group.api.mdx create mode 100644 products/idn/api/v3/delete-personal-access-token.api.mdx create mode 100644 products/idn/api/v3/delete-provisioning-policy.api.mdx create mode 100644 products/idn/api/v3/delete-saved-search.api.mdx create mode 100644 products/idn/api/v3/delete-scheduled-search.api.mdx create mode 100644 products/idn/api/v3/delete-segment.api.mdx create mode 100644 products/idn/api/v3/delete-service-desk-integration.api.mdx create mode 100644 products/idn/api/v3/delete-sod-policy-schedule.api.mdx create mode 100644 products/idn/api/v3/delete-sod-policy.api.mdx create mode 100644 products/idn/api/v3/delete-source-schema.api.mdx create mode 100644 products/idn/api/v3/delete-source.api.mdx create mode 100644 products/idn/api/v3/delete-tagged-object.api.mdx create mode 100644 products/idn/api/v3/delete-tags-to-many-object.api.mdx create mode 100644 products/idn/api/v3/delete-transform.api.mdx create mode 100644 products/idn/api/v3/disable-account.api.mdx create mode 100644 products/idn/api/v3/enable-account.api.mdx create mode 100644 products/idn/api/v3/execute-saved-search.api.mdx create mode 100644 products/idn/api/v3/export-identity-profiles.api.mdx create mode 100644 products/idn/api/v3/export-non-employee-records.api.mdx create mode 100644 products/idn/api/v3/export-non-employee-source-schema-template.api.mdx create mode 100644 products/idn/api/v3/forward-access-request.api.mdx create mode 100644 products/idn/api/v3/get-access-profile-entitlements.api.mdx create mode 100644 products/idn/api/v3/get-access-profile.api.mdx create mode 100644 products/idn/api/v3/get-access-request-approval-summary.api.mdx create mode 100644 products/idn/api/v3/get-access-request-config.api.mdx create mode 100644 products/idn/api/v3/get-account-activity.api.mdx create mode 100644 products/idn/api/v3/get-account-entitlements.api.mdx create mode 100644 products/idn/api/v3/get-account.api.mdx create mode 100644 products/idn/api/v3/get-accounts-schema.api.mdx create mode 100644 products/idn/api/v3/get-active-campaigns.api.mdx create mode 100644 products/idn/api/v3/get-campaign.api.mdx create mode 100644 products/idn/api/v3/get-completed-work-items.api.mdx create mode 100644 products/idn/api/v3/get-count-completed-work-items.api.mdx create mode 100644 products/idn/api/v3/get-count-work-items.api.mdx create mode 100644 products/idn/api/v3/get-custom-violation-report.api.mdx create mode 100644 products/idn/api/v3/get-default-identity-attribute-config.api.mdx create mode 100644 products/idn/api/v3/get-default-violation-report.api.mdx create mode 100644 products/idn/api/v3/get-entitlements-schema.api.mdx create mode 100644 products/idn/api/v3/get-identity-access-summaries.api.mdx create mode 100644 products/idn/api/v3/get-identity-certification.api.mdx create mode 100644 products/idn/api/v3/get-identity-decision-summary.api.mdx create mode 100644 products/idn/api/v3/get-identity-profile.api.mdx create mode 100644 products/idn/api/v3/get-identity-summaries.api.mdx create mode 100644 products/idn/api/v3/get-identity-summary.api.mdx create mode 100644 products/idn/api/v3/get-lifecycle-state.api.mdx create mode 100644 products/idn/api/v3/get-non-employee-approval-summary.api.mdx create mode 100644 products/idn/api/v3/get-non-employee-approval.api.mdx create mode 100644 products/idn/api/v3/get-non-employee-bulk-upload-status.api.mdx create mode 100644 products/idn/api/v3/get-non-employee-record.api.mdx create mode 100644 products/idn/api/v3/get-non-employee-request-summary.api.mdx create mode 100644 products/idn/api/v3/get-non-employee-request.api.mdx create mode 100644 products/idn/api/v3/get-non-employee-schema-attribute.api.mdx create mode 100644 products/idn/api/v3/get-non-employee-source-schema-attributes.api.mdx create mode 100644 products/idn/api/v3/get-non-employee-source.api.mdx create mode 100644 products/idn/api/v3/get-oauth-client.api.mdx create mode 100644 products/idn/api/v3/get-password-change-status.api.mdx create mode 100644 products/idn/api/v3/get-password-dictionary.api.mdx create mode 100644 products/idn/api/v3/get-password-org-config.api.mdx create mode 100644 products/idn/api/v3/get-password-sync-group.api.mdx create mode 100644 products/idn/api/v3/get-password-sync-groups.api.mdx create mode 100644 products/idn/api/v3/get-provisioning-policy.api.mdx create mode 100644 products/idn/api/v3/get-public-identities.api.mdx create mode 100644 products/idn/api/v3/get-public-identity-config.api.mdx create mode 100644 products/idn/api/v3/get-role-assigned-identities.api.mdx create mode 100644 products/idn/api/v3/get-role.api.mdx create mode 100644 products/idn/api/v3/get-saved-search.api.mdx create mode 100644 products/idn/api/v3/get-scheduled-search.api.mdx create mode 100644 products/idn/api/v3/get-segment.api.mdx create mode 100644 products/idn/api/v3/get-service-desk-integration-template.api.mdx create mode 100644 products/idn/api/v3/get-service-desk-integration-types.api.mdx create mode 100644 products/idn/api/v3/get-service-desk-integration.api.mdx create mode 100644 products/idn/api/v3/get-service-desk-integrations.api.mdx create mode 100644 products/idn/api/v3/get-sod-all-report-run-status.api.mdx create mode 100644 products/idn/api/v3/get-sod-policy-schedule.api.mdx create mode 100644 products/idn/api/v3/get-sod-policy.api.mdx create mode 100644 products/idn/api/v3/get-sod-violation-report-run-status.api.mdx create mode 100644 products/idn/api/v3/get-sod-violation-report-status.api.mdx create mode 100644 products/idn/api/v3/get-source-health.api.mdx create mode 100644 products/idn/api/v3/get-source-schema.api.mdx create mode 100644 products/idn/api/v3/get-source.api.mdx create mode 100644 products/idn/api/v3/get-status-check-details.api.mdx create mode 100644 products/idn/api/v3/get-tagged-object.api.mdx create mode 100644 products/idn/api/v3/get-transform.api.mdx create mode 100644 products/idn/api/v3/get-work-item.api.mdx create mode 100644 products/idn/api/v3/get-work-items-summary.api.mdx create mode 100644 products/idn/api/v3/identity-profiles.tag.mdx create mode 100644 products/idn/api/v3/identitynow-v-3-api.info.mdx create mode 100644 products/idn/api/v3/import-accounts-schema.api.mdx create mode 100644 products/idn/api/v3/import-connector-file.api.mdx create mode 100644 products/idn/api/v3/import-entitlements-schema.api.mdx create mode 100644 products/idn/api/v3/import-identity-profiles.api.mdx create mode 100644 products/idn/api/v3/import-non-employee-records-in-bulk.api.mdx create mode 100644 products/idn/api/v3/lifecycle-states.tag.mdx create mode 100644 products/idn/api/v3/list-access-profiles.api.mdx create mode 100644 products/idn/api/v3/list-access-request-status.api.mdx create mode 100644 products/idn/api/v3/list-account-activities.api.mdx create mode 100644 products/idn/api/v3/list-accounts.api.mdx create mode 100644 products/idn/api/v3/list-completed-approvals.api.mdx create mode 100644 products/idn/api/v3/list-identity-access-review-items.api.mdx create mode 100644 products/idn/api/v3/list-identity-certifications.api.mdx create mode 100644 products/idn/api/v3/list-identity-profiles.api.mdx create mode 100644 products/idn/api/v3/list-lifecycle-states.api.mdx create mode 100644 products/idn/api/v3/list-non-employee-approvals.api.mdx create mode 100644 products/idn/api/v3/list-non-employee-records.api.mdx create mode 100644 products/idn/api/v3/list-non-employee-requests.api.mdx create mode 100644 products/idn/api/v3/list-non-employee-sources.api.mdx create mode 100644 products/idn/api/v3/list-oauth-clients.api.mdx create mode 100644 products/idn/api/v3/list-pending-approvals.api.mdx create mode 100644 products/idn/api/v3/list-personal-access-tokens.api.mdx create mode 100644 products/idn/api/v3/list-provisioning-policies.api.mdx create mode 100644 products/idn/api/v3/list-requestable-objects.api.mdx create mode 100644 products/idn/api/v3/list-roles.api.mdx create mode 100644 products/idn/api/v3/list-saved-searches.api.mdx create mode 100644 products/idn/api/v3/list-scheduled-search.api.mdx create mode 100644 products/idn/api/v3/list-segments.api.mdx create mode 100644 products/idn/api/v3/list-sod-policies.api.mdx create mode 100644 products/idn/api/v3/list-source-schemas.api.mdx create mode 100644 products/idn/api/v3/list-sources.api.mdx create mode 100644 products/idn/api/v3/list-tagged-objects-by-type.api.mdx create mode 100644 products/idn/api/v3/list-tagged-objects.api.mdx create mode 100644 products/idn/api/v3/list-transforms.api.mdx create mode 100644 products/idn/api/v3/list-work-items.api.mdx create mode 100644 products/idn/api/v3/make-identity-decision.api.mdx create mode 100644 products/idn/api/v3/move.api.mdx create mode 100644 products/idn/api/v3/non-employee-lifecycle-management.tag.mdx create mode 100644 products/idn/api/v3/o-auth-clients.tag.mdx create mode 100644 products/idn/api/v3/password-configuration.tag.mdx create mode 100644 products/idn/api/v3/password-dictionary.tag.mdx create mode 100644 products/idn/api/v3/password-management.tag.mdx create mode 100644 products/idn/api/v3/password-sync-groups.tag.mdx create mode 100644 products/idn/api/v3/patch-access-profile.api.mdx create mode 100644 products/idn/api/v3/patch-non-employee-record.api.mdx create mode 100644 products/idn/api/v3/patch-non-employee-schema-attribute.api.mdx create mode 100644 products/idn/api/v3/patch-non-employee-source.api.mdx create mode 100644 products/idn/api/v3/patch-oauth-client.api.mdx create mode 100644 products/idn/api/v3/patch-personal-access-token.api.mdx create mode 100644 products/idn/api/v3/patch-role.api.mdx create mode 100644 products/idn/api/v3/patch-segment.api.mdx create mode 100644 products/idn/api/v3/patch-service-desk-integration.api.mdx create mode 100644 products/idn/api/v3/patch-sod-policy.api.mdx create mode 100644 products/idn/api/v3/personal-access-tokens.tag.mdx create mode 100644 products/idn/api/v3/public-identities-config.tag.mdx create mode 100644 products/idn/api/v3/public-identities.tag.mdx create mode 100644 products/idn/api/v3/put-account.api.mdx create mode 100644 products/idn/api/v3/put-provisioning-policy.api.mdx create mode 100644 products/idn/api/v3/put-saved-search.api.mdx create mode 100644 products/idn/api/v3/put-service-desk-integration.api.mdx create mode 100644 products/idn/api/v3/put-source-schema.api.mdx create mode 100644 products/idn/api/v3/put-source.api.mdx create mode 100644 products/idn/api/v3/put-tagged-object.api.mdx create mode 100644 products/idn/api/v3/query-password-info.api.mdx create mode 100644 products/idn/api/v3/reassign-identity-certifications.api.mdx create mode 100644 products/idn/api/v3/reject-access-request.api.mdx create mode 100644 products/idn/api/v3/reject-approval-item.api.mdx create mode 100644 products/idn/api/v3/reject-approval-items-in-bulk.api.mdx create mode 100644 products/idn/api/v3/reject-non-employee-request.api.mdx create mode 100644 products/idn/api/v3/reload-account.api.mdx create mode 100644 products/idn/api/v3/requestable-objects.tag.mdx create mode 100644 products/idn/api/v3/roles.tag.mdx create mode 100644 products/idn/api/v3/saved-search.tag.mdx create mode 100644 products/idn/api/v3/scheduled-search.tag.mdx create mode 100644 products/idn/api/v3/search-aggregate.api.mdx create mode 100644 products/idn/api/v3/search-count.api.mdx create mode 100644 products/idn/api/v3/search-get.api.mdx create mode 100644 products/idn/api/v3/search-post.api.mdx create mode 100644 products/idn/api/v3/search.tag.mdx create mode 100644 products/idn/api/v3/segments.tag.mdx create mode 100644 products/idn/api/v3/service-desk-integration.tag.mdx create mode 100644 products/idn/api/v3/set-lifecycle-state.api.mdx create mode 100644 products/idn/api/v3/set-password.api.mdx create mode 100644 products/idn/api/v3/set-policy-schedule.api.mdx create mode 100644 products/idn/api/v3/set-sod-policy.api.mdx create mode 100644 products/idn/api/v3/set-tag-to-object.api.mdx create mode 100644 products/idn/api/v3/set-tags-to-many-objects.api.mdx create mode 100644 products/idn/api/v3/sidebar.js create mode 100644 products/idn/api/v3/sign-off-identity-certification.api.mdx create mode 100644 products/idn/api/v3/sod-policy.tag.mdx create mode 100644 products/idn/api/v3/sod-violations.tag.mdx create mode 100644 products/idn/api/v3/sources.tag.mdx create mode 100644 products/idn/api/v3/start-campaign.api.mdx create mode 100644 products/idn/api/v3/start-evaluate-sod-policy.api.mdx create mode 100644 products/idn/api/v3/start-predict-sod-violations.api.mdx create mode 100644 products/idn/api/v3/start-sod-all-policies-for-org.api.mdx create mode 100644 products/idn/api/v3/start-sod-policy.api.mdx create mode 100644 products/idn/api/v3/start-violation-check.api.mdx create mode 100644 products/idn/api/v3/submit-account-selection.api.mdx create mode 100644 products/idn/api/v3/tagged-objects.tag.mdx create mode 100644 products/idn/api/v3/transforms.tag.mdx create mode 100644 products/idn/api/v3/unlock-account.api.mdx create mode 100644 products/idn/api/v3/unsubscribe-scheduled-search.api.mdx create mode 100644 products/idn/api/v3/update-access-request-config.api.mdx create mode 100644 products/idn/api/v3/update-account.api.mdx create mode 100644 products/idn/api/v3/update-lifecycle-states.api.mdx create mode 100644 products/idn/api/v3/update-non-employee-record.api.mdx create mode 100644 products/idn/api/v3/update-password-dictionary.api.mdx create mode 100644 products/idn/api/v3/update-password-org-config.api.mdx create mode 100644 products/idn/api/v3/update-password-sync-group.api.mdx create mode 100644 products/idn/api/v3/update-provisioning-policies-in-bulk.api.mdx create mode 100644 products/idn/api/v3/update-provisioning-policy.api.mdx create mode 100644 products/idn/api/v3/update-public-identity-config.api.mdx create mode 100644 products/idn/api/v3/update-scheduled-search.api.mdx create mode 100644 products/idn/api/v3/update-source-schema.api.mdx create mode 100644 products/idn/api/v3/update-source.api.mdx create mode 100644 products/idn/api/v3/update-status-check-details.api.mdx create mode 100644 products/idn/api/v3/update-transform.api.mdx create mode 100644 products/idn/api/v3/work-items.tag.mdx create mode 100644 products/iiq/api/accounts.tag.mdx create mode 100644 products/iiq/api/alerts.tag.mdx create mode 100644 products/iiq/api/applications.tag.mdx create mode 100644 products/iiq/api/check-policy-violations.api.mdx create mode 100644 products/iiq/api/checked-policy-violations.tag.mdx create mode 100644 products/iiq/api/create-account.api.mdx create mode 100644 products/iiq/api/create-alert.api.mdx create mode 100644 products/iiq/api/create-user.api.mdx create mode 100644 products/iiq/api/delete-account.api.mdx create mode 100644 products/iiq/api/delete-user.api.mdx create mode 100644 products/iiq/api/entitlements.tag.mdx create mode 100644 products/iiq/api/get-account-by-id.api.mdx create mode 100644 products/iiq/api/get-accounts.api.mdx create mode 100644 products/iiq/api/get-alert-by-id.api.mdx create mode 100644 products/iiq/api/get-alerts.api.mdx create mode 100644 products/iiq/api/get-application.api.mdx create mode 100644 products/iiq/api/get-applications.api.mdx create mode 100644 products/iiq/api/get-entitlement-by-id.api.mdx create mode 100644 products/iiq/api/get-entitlements.api.mdx create mode 100644 products/iiq/api/get-launched-workflow-by-id.api.mdx create mode 100644 products/iiq/api/get-object-config-by-id.api.mdx create mode 100644 products/iiq/api/get-object-configs.api.mdx create mode 100644 products/iiq/api/get-policy-violation-by-id.api.mdx create mode 100644 products/iiq/api/get-policy-violations.api.mdx create mode 100644 products/iiq/api/get-resource-type-by-id.api.mdx create mode 100644 products/iiq/api/get-resource-types.api.mdx create mode 100644 products/iiq/api/get-role.api.mdx create mode 100644 products/iiq/api/get-roles.api.mdx create mode 100644 products/iiq/api/get-schema-by-id.api.mdx create mode 100644 products/iiq/api/get-schemas.api.mdx create mode 100644 products/iiq/api/get-task-result-by-id.api.mdx create mode 100644 products/iiq/api/get-user-by-id.api.mdx create mode 100644 products/iiq/api/get-users.api.mdx create mode 100644 products/iiq/api/get-workflow-by-id.api.mdx create mode 100644 products/iiq/api/identityiq-scim-rest-api.info.mdx create mode 100644 products/iiq/api/launch-workflow.api.mdx create mode 100644 products/iiq/api/launched-workflows-get.api.mdx create mode 100644 products/iiq/api/launched-workflows.tag.mdx create mode 100644 products/iiq/api/object-config.tag.mdx create mode 100644 products/iiq/api/policy-violations.tag.mdx create mode 100644 products/iiq/api/resource-types.tag.mdx create mode 100644 products/iiq/api/roles.tag.mdx create mode 100644 products/iiq/api/schemas.tag.mdx create mode 100644 products/iiq/api/service-provider-config-get.api.mdx create mode 100644 products/iiq/api/service-provider-config.tag.mdx create mode 100644 products/iiq/api/sidebar.js create mode 100644 products/iiq/api/task-results-get.api.mdx create mode 100644 products/iiq/api/task-results.tag.mdx create mode 100644 products/iiq/api/update-account.api.mdx create mode 100644 products/iiq/api/update-user.api.mdx create mode 100644 products/iiq/api/users.tag.mdx create mode 100644 products/iiq/api/workflows-get.api.mdx create mode 100644 products/iiq/api/workflows.tag.mdx diff --git a/.gitignore b/.gitignore index 96df41f54..84e830cb0 100644 --- a/.gitignore +++ b/.gitignore @@ -19,10 +19,10 @@ npm-debug.log* yarn-debug.log* yarn-error.log* -/products/arm/api -/products/idn/api/v3 -products/idn/api/beta -/products/iiq/api +# /products/arm/api +# /products/idn/api/v3 +# /products/idn/api/beta +# /products/iiq/api #Alogolia env file /algolia/.env diff --git a/products/idn/api/beta/access-profiles.tag.mdx b/products/idn/api/beta/access-profiles.tag.mdx new file mode 100644 index 000000000..d3bf40ab7 --- /dev/null +++ b/products/idn/api/beta/access-profiles.tag.mdx @@ -0,0 +1,54 @@ +--- +id: access-profiles +title: "Access Profiles" +description: "Access Profiles" +custom_edit_url: null +--- + + + +Use this API to implement and customize access profile functionality. +With this functionality in place, administrators can create access profiles and configure them for use throughout IdentityNow, enabling users to get the access they need quickly and securely. + +Access profiles group entitlements, which represent access rights on sources. + +For example, an Active Directory source in IdentityNow can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +Access profiles are the most important units of access in IdentityNow. IdentityNow uses access profiles in many features, including the following: + +- Provisioning: When you use the Provisioning Service, lifecycle states and roles both grant access to users in the form of access profiles. + +- Certifications: You can approve or revoke access profiles in certification campaigns, just like entitlements. + +- Access Requests: You can assign access profiles to applications, and when a user requests access to the app associated with an access profile and someone approves the request, access is granted to both the application and its associated access profile. + +- Roles: You can group one or more access profiles into a role to quickly assign access items based on an identity's role. + +In IdentityNow, administrators can use the Access drop-down menu and select Access Profiles to view, configure, and delete existing access profiles, as well as create new ones. +Administrators can enable and disable an access profile, and they can also make the following configurations: + +- Manage Entitlements: Manage the profile's access by adding and removing entitlements. + +- Access Requests: Configure access profiles to be requestable and establish an approval process for any requests that the access profile be granted or revoked. +Do not configure an access profile to be requestable without first establishing a secure access request approval process for the access profile. + +- Multiple Account Options: Define the logic IdentityNow uses to provision access to an identity with multiple accounts on the source. + +Refer to [Managing Access Profiles](https://documentation.sailpoint.com/saas/help/access/access-profiles.html) for more information about access profiles. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/access-request-approvals.tag.mdx b/products/idn/api/beta/access-request-approvals.tag.mdx new file mode 100644 index 000000000..b9442f841 --- /dev/null +++ b/products/idn/api/beta/access-request-approvals.tag.mdx @@ -0,0 +1,37 @@ +--- +id: access-request-approvals +title: "Access Request Approvals" +description: "Access Request Approvals" +custom_edit_url: null +--- + + + +Use this API to implement and customize access request approval functionality. +With this functionality in place, administrators can delegate qualified users to review users' requests for access or managers' requests to revoke team members' access to applications, entitlements, or roles. +This enables more qualified users to review access requests and the others to spend their time on other tasks. + +In IdentityNow, users can request access to applications, entitlements, and roles, and managers can request that team members' access be revoked. +For applications and entitlements, administrators can set access profiles to require approval from the access profile owner, the application owner, the source owner, the requesting user's manager, or a governance group for access to be granted or revoked. +For roles, administrators can also set roles to allow access requests and require approval from the role owner, the requesting user's manager, or a governance group for access to be granted or revoked. +If the administrator designates a governance group as the required approver, any governance group member can approve the requests. + +When a user submits an access request, IdentityNow sends the first required approver in the queue an email notification, based on the access request configuration's approval and reminder escalation configuration. + +In Approvals in IdentityNow, required approvers can view pending access requests under the Requested tab and approve or deny them, or the approvers can reassign the requests to different reviewers for approval. +If the required approver approves the request and is the only reviewer required, IdentityNow grants or revokes access, based on the request. +If multiple reviewers are required, IdentityNow sends the request to the next reviewer in the queue, based on the access request configuration's approval reminder and escalation configuration. +The required approver can then view any completed access requests under the Reviewed tab. + +Refer to [Access Requests](https://documentation.sailpoint.com/saas/help/requests/index.html) for more information about access request approvals. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/access-requests.tag.mdx b/products/idn/api/beta/access-requests.tag.mdx new file mode 100644 index 000000000..17b532dc1 --- /dev/null +++ b/products/idn/api/beta/access-requests.tag.mdx @@ -0,0 +1,35 @@ +--- +id: access-requests +title: "Access Requests" +description: "Access Requests" +custom_edit_url: null +--- + + + +Use this API to implement and customize access request functionality. +With this functionality in place, users can request access to applications, entitlements, or roles, and managers can request that team members' access be revoked. +This allows users to get access to the tools they need quickly and securely, and it allows managers to take away access to those tools. + +IdentityNow's Access Request service allows end users to request access that requires approval before it can be granted to users and enables qualified users to review those requests and approve or deny them. + +In the Request Center in IdentityNow, users can view available applications, roles, and entitlements and request access to them. +If the requested tools requires approval, the requests appear as 'Pending' under the My Requests tab until the required approver approves, rejects, or cancels them. + +Users can use My Requests to track and/or cancel the requests. + +In My Team on the IdentityNow Home, managers can submit requests to revoke their team members' access. +They can use the My Requests tab under Request Center to track and/or cancel the requests. + +Refer to [Requesting Access](https://documentation.sailpoint.com/saas/user-help/requests/requesting_access.html) for more information about access requests. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/account-activities.tag.mdx b/products/idn/api/beta/account-activities.tag.mdx new file mode 100644 index 000000000..21e93473c --- /dev/null +++ b/products/idn/api/beta/account-activities.tag.mdx @@ -0,0 +1,53 @@ +--- +id: account-activities +title: "Account Activities" +description: "Account Activities" +custom_edit_url: null +--- + + + +Use this API to implement account activity tracking functionality. +With this functionality in place, users can track source account activity in IdentityNow, which greatly improves traceability in the system. + +An account activity refers to a log of each action performed on a source account. This is useful for auditing the changes that occur on an account throughout its life. +In IdentityNow's Search, users can search for account activities and select the activity's row to get an overview of the activity's account action and view its progress, its involved sources, and its most basic metadata, such as the identity requesting the option and the recipient. + +Account activity includes most actions IdentityNow completes on source accounts. Users can search in IdentityNow for the following account action types: + +- Access Request: These include any access requests the source account is involved in. + +- Account Attribute Updates: These include updates to a single attribute on an account on a source. + +- Account State Update: These include locking or unlocking actions on an account on a source. + +- Certification: These include actions removing an entitlement from an account on a source as a result of the entitlement's revocation during a certification. + +- Cloud Automated `Lifecyclestate`: These include automated lifecycle state changes that result in a source account's correlated identity being assigned to a different lifecycle state. +IdentityNow replaces the `Lifecyclestate` variable with the name of the lifecycle state it has moved the account's identity to. + +- Identity Attribute Update: These include updates to a source account's correlated identity attributes as the result of a provisioning action. +When you update an identity attribute that also updates an identity's lifecycle state, the cloud automated `Lifecyclestate` event also displays. +Account Activity does not include attribute updates that occur as a result of aggregation. + +- Identity Refresh: These include correlated identity refreshes that occur for an account on a source whenever the account's correlated identity profile gets a new role or updates. +These also include refreshes that occur whenever IdentityNow assigns an application to the account's correlated identity based on the application's being assigned to All Users From Source or Specific Users From Source. + +- Lifecycle State Refresh: These include the actions that took place when a lifecycle state changed. This event only occurs after a cloud automated `Lifecyclestate` change or a lifecycle state change. + +- Lifecycle State Change: These include the account activities that result from an identity's manual assignment to a null lifecycle state. + +- Password Change: These include password changes on sources. + +Refer to [Account Activity](https://documentation.sailpoint.com/saas/help/search/index.html#account-activity) for more information about account activities. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/account-aggregations.tag.mdx b/products/idn/api/beta/account-aggregations.tag.mdx new file mode 100644 index 000000000..b8e9b4ffb --- /dev/null +++ b/products/idn/api/beta/account-aggregations.tag.mdx @@ -0,0 +1,30 @@ +--- +id: account-aggregations +title: "Account Aggregations" +description: "Account Aggregations" +custom_edit_url: null +--- + + + +Use this API to implement account aggregation progress tracking functionality. +With this functionality in place, administrators can view in-progress account aggregations, their statuses, and their relevant details. + +An account aggregation refers to the process IdentityNow uses to gather and load account data from a source into IdentityNow. + +Whenever IdentityNow is in the process of aggregating a source, it adds an entry to the Aggregation Activity Log, along with its relevant details. +To view aggregation activity, administrators can select the Connections drop-down menu, select Sources, and select the relevant source, select its Import Data tab, and select Account Aggregation. +In Account Aggregation, administrators can view the account aggregations' statuses and details in the Account Activity Log. + +Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about account aggregations. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/accounts.tag.mdx b/products/idn/api/beta/accounts.tag.mdx new file mode 100644 index 000000000..e95316e4b --- /dev/null +++ b/products/idn/api/beta/accounts.tag.mdx @@ -0,0 +1,47 @@ +--- +id: accounts +title: "Accounts" +description: "Accounts" +custom_edit_url: null +--- + + + +Use this API to implement and customize account functionality. +With this functionality in place, administrators can manage users' access across sources in IdentityNow. + +In IdentityNow, an account refers to a user's account on a supported source. +This typically includes a unique identifier for the user, a unique password, a set of permissions associated with the source and a set of attributes. IdentityNow loads accounts through the creation of sources in IdentityNow. + +Administrators can correlate users' identities with the users' accounts on the different sources they use. +This allows IdentityNow to govern the access of identities and all their correlated accounts securely and cohesively. + +To view the accounts on a source and their correlated identities, administrators can use the Connections drop-down menu, select Sources, select the relevant source, and select its Account tab. + +To view and edit source account statuses for an identity in IdentityNow, administrators can use the Identities drop-down menu, select Identity List, select the relevant identity, and select its Accounts tab. +Administrators can toggle an account's Actions to aggregate the account, enable/disable it, unlock it, or remove it from the identity. + +Accounts can have the following statuses: + +- Enabled: The account is enabled. The user can access it. + +- Disabled: The account is disabled, and the user cannot access it, but the identity is not disabled in IdentityNow. This can occur when an administrator disables the account or when the user's lifecycle state changes. + +- Locked: The account is locked. This may occur when someone has entered an incorrect password for the account too many times. + +- Pending: The account is currently updating. This status typically lasts seconds. + +Administrators can select the source account to view its attributes, entitlements, and the last time the account's password was changed. + +Refer to [Managing User Accounts](https://documentation.sailpoint.com/saas/help/common/users/user_access.html#managing-user-accounts) for more information about accounts. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/add-access-request-recommendations-ignored-item.api.mdx b/products/idn/api/beta/add-access-request-recommendations-ignored-item.api.mdx new file mode 100644 index 000000000..03cd52e4c --- /dev/null +++ b/products/idn/api/beta/add-access-request-recommendations-ignored-item.api.mdx @@ -0,0 +1,79 @@ +--- +id: add-access-request-recommendations-ignored-item +sidebar_label: Notification of Ignored Access Request Recommendations +hide_title: true +hide_table_of_contents: true +api: {"operationId":"addAccessRequestRecommendationsIgnoredItem","tags":["IAI Access Request Recommendations"],"description":"This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations.","requestBody":{"description":"The recommended access item to ignore for an identity.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","format":"UUID","description":"The identity ID taking the action.","example":"2c91808570313110017040b06f344ec9"},"access":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"},"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE"}}}},"required":["identityId","access"]}}}},"responses":{"201":{"description":"Recommendation successfully stored as ignored.","content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","format":"UUID","description":"The identity ID taking the action.","example":"2c91808570313110017040b06f344ec9"},"access":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"},"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE"}}},"timestamp":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/ai-access-request-recommendations/ignored-items","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"identityId":"2c91808570313110017040b06f344ec9","access":{"id":"2c9180835d2e5168015d32f890ca1581","type":"ACCESS_PROFILE"}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Notification of Ignored Access Request Recommendations","description":{"content":"This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations.","type":"text/plain"},"url":{"path":["ai-access-request-recommendations","ignored-items"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Notification of Ignored Access Request Recommendations' (add-access-request-recommendations-ignored-item)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Notification of Ignored Access Request Recommendations + + + +This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. + +
Request Body required
+ +The recommended access item to ignore for an identity. + +
    access object required
+ +Recommendation successfully stored as ignored. + +
Schema
    access object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/add-access-request-recommendations-requested-item.api.mdx b/products/idn/api/beta/add-access-request-recommendations-requested-item.api.mdx new file mode 100644 index 000000000..3dabd6f3a --- /dev/null +++ b/products/idn/api/beta/add-access-request-recommendations-requested-item.api.mdx @@ -0,0 +1,79 @@ +--- +id: add-access-request-recommendations-requested-item +sidebar_label: Notification of Requested Access Request Recommendations +hide_title: true +hide_table_of_contents: true +api: {"operationId":"addAccessRequestRecommendationsRequestedItem","tags":["IAI Access Request Recommendations"],"description":"This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations.","requestBody":{"description":"The recommended access item that was requested for an identity.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","format":"UUID","description":"The identity ID taking the action.","example":"2c91808570313110017040b06f344ec9"},"access":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"},"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE"}}}},"required":["identityId","access"]}}}},"responses":{"201":{"description":"Notification successfully acknowledged.","content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","format":"UUID","description":"The identity ID taking the action.","example":"2c91808570313110017040b06f344ec9"},"access":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"},"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE"}}},"timestamp":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/ai-access-request-recommendations/requested-items","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"identityId":"2c91808570313110017040b06f344ec9","access":{"id":"2c9180835d2e5168015d32f890ca1581","type":"ACCESS_PROFILE"}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Notification of Requested Access Request Recommendations","description":{"content":"This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations.","type":"text/plain"},"url":{"path":["ai-access-request-recommendations","requested-items"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Notification of Requested Access Request Recommendations' (add-access-request-recommendations-requested-item)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Notification of Requested Access Request Recommendations + + + +This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. + +
Request Body required
+ +The recommended access item that was requested for an identity. + +
    access object required
+ +Notification successfully acknowledged. + +
Schema
    access object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/add-access-request-recommendations-viewed-item.api.mdx b/products/idn/api/beta/add-access-request-recommendations-viewed-item.api.mdx new file mode 100644 index 000000000..d48f300e5 --- /dev/null +++ b/products/idn/api/beta/add-access-request-recommendations-viewed-item.api.mdx @@ -0,0 +1,79 @@ +--- +id: add-access-request-recommendations-viewed-item +sidebar_label: Notification of Viewed Access Request Recommendations +hide_title: true +hide_table_of_contents: true +api: {"operationId":"addAccessRequestRecommendationsViewedItem","tags":["IAI Access Request Recommendations"],"description":"This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations.","requestBody":{"description":"The recommended access that was viewed for an identity.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","format":"UUID","description":"The identity ID taking the action.","example":"2c91808570313110017040b06f344ec9"},"access":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"},"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE"}}}},"required":["identityId","access"]}}}},"responses":{"201":{"description":"Recommendation successfully stored as viewed.","content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","format":"UUID","description":"The identity ID taking the action.","example":"2c91808570313110017040b06f344ec9"},"access":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"},"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE"}}},"timestamp":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/ai-access-request-recommendations/viewed-items","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"identityId":"2c91808570313110017040b06f344ec9","access":{"id":"2c9180835d2e5168015d32f890ca1581","type":"ACCESS_PROFILE"}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Notification of Viewed Access Request Recommendations","description":{"content":"This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations.","type":"text/plain"},"url":{"path":["ai-access-request-recommendations","viewed-items"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Notification of Viewed Access Request Recommendations' (add-access-request-recommendations-viewed-item)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Notification of Viewed Access Request Recommendations + + + +This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. + +
Request Body required
+ +The recommended access that was viewed for an identity. + +
    access object required
+ +Recommendation successfully stored as viewed. + +
Schema
    access object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/add-access-request-recommendations-viewed-items.api.mdx b/products/idn/api/beta/add-access-request-recommendations-viewed-items.api.mdx new file mode 100644 index 000000000..7dc1b13d9 --- /dev/null +++ b/products/idn/api/beta/add-access-request-recommendations-viewed-items.api.mdx @@ -0,0 +1,79 @@ +--- +id: add-access-request-recommendations-viewed-items +sidebar_label: Notification of Viewed Access Request Recommendations in Bulk +hide_title: true +hide_table_of_contents: true +api: {"operationId":"addAccessRequestRecommendationsViewedItems","tags":["IAI Access Request Recommendations"],"description":"This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations.","requestBody":{"description":"The recommended access items that were viewed for an identity.","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"identityId":{"type":"string","format":"UUID","description":"The identity ID taking the action.","example":"2c91808570313110017040b06f344ec9"},"access":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"},"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE"}}}},"required":["identityId","access"]}}}}},"responses":{"201":{"description":"Recommendations successfully stored as viewed.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"identityId":{"type":"string","format":"UUID","description":"The identity ID taking the action.","example":"2c91808570313110017040b06f344ec9"},"access":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"},"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE"}}},"timestamp":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/ai-access-request-recommendations/viewed-items/bulk-create","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"identityId":"2c91808570313110017040b06f344ec9","access":{"id":"2c9180835d2e5168015d32f890ca1581","type":"ACCESS_PROFILE"}}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Notification of Viewed Access Request Recommendations in Bulk","description":{"content":"This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations.","type":"text/plain"},"url":{"path":["ai-access-request-recommendations","viewed-items","bulk-create"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Notification of Viewed Access Request Recommendations in Bulk' (add-access-request-recommendations-viewed-items)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Notification of Viewed Access Request Recommendations in Bulk + + + +This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. + +
Request Body array required
+ +The recommended access items that were viewed for an identity. + +
    access object required
+ +Recommendations successfully stored as viewed. + +
Schema array
    access object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/add-tag-to-object.api.mdx b/products/idn/api/beta/add-tag-to-object.api.mdx new file mode 100644 index 000000000..3d08d68ae --- /dev/null +++ b/products/idn/api/beta/add-tag-to-object.api.mdx @@ -0,0 +1,81 @@ +--- +id: add-tag-to-object +sidebar_label: Add Tag to Object +hide_title: true +hide_table_of_contents: true +api: {"operationId":"addTagToObject","security":[{"oauth2":["idn:tag:manage"]}],"tags":["Tagged Objects"],"description":"This adds a tag to an object.\n\nAny authenticated token may be used to call this API.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"objectRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"tags":{"type":"array","items":{"type":"string"},"description":"Labels to be applied to an Object","example":["BU_FINANCE","PCI"]}}}}}},"responses":{"200":{"description":"Request succeeded.","content":{"application/json":{"schema":{"type":"object","properties":{"objectRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"tags":{"type":"array","items":{"type":"string"},"description":"Labels to be applied to an Object","example":["BU_FINANCE","PCI"]}}}}}},"201":{"description":"Created."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/tagged-objects","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"objectRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"},"tags":["BU_FINANCE","PCI"]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Add Tag to Object","description":{"content":"This adds a tag to an object.\n\nAny authenticated token may be used to call this API.","type":"text/plain"},"url":{"path":["tagged-objects"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Add Tag to Object' (add-tag-to-object)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Add Tag to Object + + + +This adds a tag to an object. + +Any authenticated token may be used to call this API. + +
Request Body required
    objectRef object
+ +Request succeeded. + +
Schema
    objectRef object
+ +Created. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/add-tags-to-many-objects.api.mdx b/products/idn/api/beta/add-tags-to-many-objects.api.mdx new file mode 100644 index 000000000..5df22b6fb --- /dev/null +++ b/products/idn/api/beta/add-tags-to-many-objects.api.mdx @@ -0,0 +1,81 @@ +--- +id: add-tags-to-many-objects +sidebar_label: Tag Multiple Objects +hide_title: true +hide_table_of_contents: true +api: {"operationId":"addTagsToManyObjects","tags":["Tagged Objects"],"description":"This API adds tags to multiple objects.\n\nA token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","requestBody":{"required":true,"description":"Supported object types are ROLE, IDENTITY and SOD_POLICY.","content":{"application/json":{"schema":{"type":"object","properties":{"objectRefs":{"type":"array","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}},"tags":{"type":"array","items":{"type":"string"},"description":"Label to be applied to an Object","example":["BU_FINANCE","PCI"]},"operation":{"type":"string","enum":["APPEND","MERGE"],"default":"APPEND","description":"If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object.\n\nIf MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored.","example":"MERGE"}}}}}},"responses":{"200":{"description":"Request succeeded.","content":{"application/json":{"schema":{"type":"object","properties":{"objectRefs":{"type":"array","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}},"tags":{"type":"array","items":{"type":"string"},"description":"Label to be applied to an Object","example":["BU_FINANCE","PCI"]},"operation":{"type":"string","enum":["APPEND","MERGE"],"default":"APPEND","description":"If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object.\n\nIf MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored.","example":"MERGE"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/tagged-objects/bulk-add","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"objectRefs":[{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"}],"tags":["BU_FINANCE","PCI"],"operation":"MERGE"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Tag Multiple Objects","description":{"content":"This API adds tags to multiple objects.\n\nA token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["tagged-objects","bulk-add"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Tag Multiple Objects' (add-tags-to-many-objects)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Tag Multiple Objects + + + +This API adds tags to multiple objects. + +A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +
Request Body required
+ +Supported object types are ROLE, IDENTITY and SOD_POLICY. + +
    objectRefs object[]
+ +Request succeeded. + +
Schema
    objectRefs object[]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/approve-access-request.api.mdx b/products/idn/api/beta/approve-access-request.api.mdx new file mode 100644 index 000000000..3bf9e49b0 --- /dev/null +++ b/products/idn/api/beta/approve-access-request.api.mdx @@ -0,0 +1,79 @@ +--- +id: approve-access-request +sidebar_label: Approves an access request approval. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"approveAccessRequest","tags":["Access Request Approvals"],"description":"This endpoint approves an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.","parameters":[{"in":"path","name":"approvalId","schema":{"type":"string"},"required":true,"description":"The id of the approval.","example":"2c91808b7294bea301729568c68c002e"}],"requestBody":{"description":"Reviewer's comment.","required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"comment":{"type":"string"}}}}}},"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/access-request-approvals/{approvalId}/approve","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"comment":"string"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Approves an access request approval.","description":{"content":"This endpoint approves an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.","type":"text/plain"},"url":{"path":["access-request-approvals",":approvalId","approve"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The id of the approval.","type":"text/plain"},"type":"any","value":"","key":"approvalId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Approves an access request approval.' (approve-access-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Approves an access request approval. + + + +This endpoint approves an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +
Path Parameters
Request Body
+ +Reviewer's comment. + +
+ +Accepted - Returned if the request was successfully accepted into the system. + +
Schema
  • object
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/approve-approval-item.api.mdx b/products/idn/api/beta/approve-approval-item.api.mdx new file mode 100644 index 000000000..687522eb7 --- /dev/null +++ b/products/idn/api/beta/approve-approval-item.api.mdx @@ -0,0 +1,67 @@ +--- +id: approve-approval-item +sidebar_label: Approve an Approval Item +hide_title: true +hide_table_of_contents: true +api: {"operationId":"approveApprovalItem","tags":["Work Items"],"description":"This API approves an Approval Item. Either an admin, or the owning/current user must make this request.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the work item","example":"ef38f94347e94562b5bb8424a56397d8"},{"in":"path","name":"approvalItemId","schema":{"type":"string"},"required":true,"description":"The ID of the approval item.","example":"1211bcaa32112bcef6122adb21cef1ac"}],"responses":{"200":{"description":"A work items details object.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the work item","example":"2c9180835d2e5168015d32f890ca1581"},"requesterId":{"type":"string","description":"ID of the requester","example":"2c9180835d2e5168015d32f890ca1581"},"requesterDisplayName":{"type":"string","description":"The displayname of the requester","example":"John Smith"},"ownerId":{"type":"string","description":"The ID of the owner","example":"2c9180835d2e5168015d32f890ca1581"},"ownerName":{"type":"string","description":"The name of the owner","example":"Jason Smith"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z"},"description":{"type":"string","description":"The description of the work item","example":"Create account on source 'AD'"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"},"type":{"type":"string","enum":["UNKNOWN","GENERIC","CERTIFICATION","REMEDIATION","DELEGATION","APPROVAL","VIOLATIONREVIEW","FORM","POLICYVIOLATION","CHALLENGE","IMPACTANALYSIS","SIGNOFF","EVENT","MANUALACTION","TEST"],"example":"GENERIC","description":"The type of the work item"},"remediationItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the certification","example":"2c9180835d2e5168015d32f890ca1581"},"targetId":{"type":"string","description":"The ID of the certification target","example":"2c9180835d2e5168015d32f890ca1581"},"targetName":{"type":"string","description":"The name of the certification target","example":"john.smith"},"targetDisplayName":{"type":"string","description":"The display name of the certification target","example":"emailAddress"},"applicationName":{"type":"string","description":"The name of the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute being certified","example":"phoneNumber"},"attributeOperation":{"type":"string","description":"The operation of the certification on the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute being certified","example":"512-555-1212"},"nativeIdentity":{"type":"string","description":"The native identity of the target","example":"jason.smith2"}}},"approvalItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the approval item","example":"2c9180835d2e5168015d32f890ca1581"},"account":{"type":"string","description":"The account referenced by the approval item","example":"john.smith"},"application":{"type":"string","description":"The name the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute","example":"emailAddress"},"attributeOperation":{"type":"string","description":"The operation of the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute","example":"a@b.com"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"}}},"name":{"type":"string","description":"The work item name","example":"Account Create"},"completed":{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z"},"numItems":{"type":"integer","description":"The number of items in the work item","example":19},"errors":{"type":"array","items":{"type":"string"},"example":["The work item ID that was specified was not found."]}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}}},"method":"post","path":"/work-items/{id}/approve/{approvalItemId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Approve an Approval Item","description":{"content":"This API approves an Approval Item. Either an admin, or the owning/current user must make this request.","type":"text/plain"},"url":{"path":["work-items",":id","approve",":approvalItemId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the work item","type":"text/plain"},"type":"any","value":"","key":"id"},{"disabled":false,"description":{"content":"(Required) The ID of the approval item.","type":"text/plain"},"type":"any","value":"","key":"approvalItemId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Approve an Approval Item' (approve-approval-item)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Approve an Approval Item + + + +This API approves an Approval Item. Either an admin, or the owning/current user must make this request. + +
Path Parameters
+ +A work items details object. + +
Schema
    remediationItems object
    approvalItems object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

\ No newline at end of file diff --git a/products/idn/api/beta/approve-approval-items-in-bulk.api.mdx b/products/idn/api/beta/approve-approval-items-in-bulk.api.mdx new file mode 100644 index 000000000..85e33580a --- /dev/null +++ b/products/idn/api/beta/approve-approval-items-in-bulk.api.mdx @@ -0,0 +1,67 @@ +--- +id: approve-approval-items-in-bulk +sidebar_label: Bulk approve Approval Items +hide_title: true +hide_table_of_contents: true +api: {"operationId":"approveApprovalItemsInBulk","tags":["Work Items"],"description":"This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the work item","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"A work items details object.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the work item","example":"2c9180835d2e5168015d32f890ca1581"},"requesterId":{"type":"string","description":"ID of the requester","example":"2c9180835d2e5168015d32f890ca1581"},"requesterDisplayName":{"type":"string","description":"The displayname of the requester","example":"John Smith"},"ownerId":{"type":"string","description":"The ID of the owner","example":"2c9180835d2e5168015d32f890ca1581"},"ownerName":{"type":"string","description":"The name of the owner","example":"Jason Smith"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z"},"description":{"type":"string","description":"The description of the work item","example":"Create account on source 'AD'"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"},"type":{"type":"string","enum":["UNKNOWN","GENERIC","CERTIFICATION","REMEDIATION","DELEGATION","APPROVAL","VIOLATIONREVIEW","FORM","POLICYVIOLATION","CHALLENGE","IMPACTANALYSIS","SIGNOFF","EVENT","MANUALACTION","TEST"],"example":"GENERIC","description":"The type of the work item"},"remediationItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the certification","example":"2c9180835d2e5168015d32f890ca1581"},"targetId":{"type":"string","description":"The ID of the certification target","example":"2c9180835d2e5168015d32f890ca1581"},"targetName":{"type":"string","description":"The name of the certification target","example":"john.smith"},"targetDisplayName":{"type":"string","description":"The display name of the certification target","example":"emailAddress"},"applicationName":{"type":"string","description":"The name of the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute being certified","example":"phoneNumber"},"attributeOperation":{"type":"string","description":"The operation of the certification on the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute being certified","example":"512-555-1212"},"nativeIdentity":{"type":"string","description":"The native identity of the target","example":"jason.smith2"}}},"approvalItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the approval item","example":"2c9180835d2e5168015d32f890ca1581"},"account":{"type":"string","description":"The account referenced by the approval item","example":"john.smith"},"application":{"type":"string","description":"The name the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute","example":"emailAddress"},"attributeOperation":{"type":"string","description":"The operation of the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute","example":"a@b.com"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"}}},"name":{"type":"string","description":"The work item name","example":"Account Create"},"completed":{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z"},"numItems":{"type":"integer","description":"The number of items in the work item","example":19},"errors":{"type":"array","items":{"type":"string"},"example":["The work item ID that was specified was not found."]}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}}},"method":"post","path":"/work-items/bulk-approve/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Bulk approve Approval Items","description":{"content":"This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request.","type":"text/plain"},"url":{"path":["work-items","bulk-approve",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the work item","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Bulk approve Approval Items' (approve-approval-items-in-bulk)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Bulk approve Approval Items + + + +This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. + +
Path Parameters
+ +A work items details object. + +
Schema
    remediationItems object
    approvalItems object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

\ No newline at end of file diff --git a/products/idn/api/beta/approve-non-employee-request.api.mdx b/products/idn/api/beta/approve-non-employee-request.api.mdx new file mode 100644 index 000000000..89e9fd0a2 --- /dev/null +++ b/products/idn/api/beta/approve-non-employee-request.api.mdx @@ -0,0 +1,79 @@ +--- +id: approve-non-employee-request +sidebar_label: Approve a Non-Employee Request +hide_title: true +hide_table_of_contents: true +api: {"operationId":"approveNonEmployeeRequest","security":[{"oauth2":["idn:nelm:manage"]}],"tags":["Non-Employee Lifecycle Management"],"description":"Approves a non-employee approval request and notifies the next approver.","parameters":[{"in":"path","name":"id","description":"Non-Employee approval item id (UUID)","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"comment":{"type":"string","description":"Comment on the approval item.","maxLength":4000}}}}}},"responses":{"200":{"description":"Non-Employee approval item object.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee approval item id","example":"2c1e388b-1e55-4b0a-ab5c-897f1204159c"},"approver":{"description":"Reference to the associated Identity","type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}},"accountName":{"type":"string","description":"Requested identity account name","example":"test.account"},"approvalStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status"},"approvalOrder":{"type":"number","description":"Approval order","example":1},"comment":{"type":"string","description":"comment of approver"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}},{"type":"object","properties":{"nonEmployeeRequest":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee request id."},"requester":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}},"example":{"type":"IDENTITY","id":"2c9180866166b5b0016167c32ef31a66","name":"William Smith"}}}}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/non-employee-approvals/{id}/approve","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"comment":"string"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Approve a Non-Employee Request","description":{"content":"Approves a non-employee approval request and notifies the next approver.","type":"text/plain"},"url":{"path":["non-employee-approvals",":id","approve"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Non-Employee approval item id (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Approve a Non-Employee Request' (approve-non-employee-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Approve a Non-Employee Request + + + +Approves a non-employee approval request and notifies the next approver. + +
Path Parameters
Request Body required
+ +Non-Employee approval item object. + +
Schema
    approver object
    + +Reference to the associated Identity + +
    nonEmployeeRequest object
    requester object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/bulk-delete-roles.api.mdx b/products/idn/api/beta/bulk-delete-roles.api.mdx new file mode 100644 index 000000000..5a2d7227a --- /dev/null +++ b/products/idn/api/beta/bulk-delete-roles.api.mdx @@ -0,0 +1,77 @@ +--- +id: bulk-delete-roles +sidebar_label: Delete Role(s) +hide_title: true +hide_table_of_contents: true +api: {"operationId":"bulkDeleteRoles","tags":["Roles"],"description":"This API initiates a bulk deletion of one or more Roles.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Roles included in the request are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"roleIds":{"description":"List of IDs of Roles to be deleted.","type":"array","items":{"type":"string"},"example":["2c9180847812e0b1017817051919ecca","2c9180887812e0b201781e129f151816"]}},"required":["roleIds"]},"example":{"roleIds":["2c91808876438bb2017668b91919ecca","2c91808876438ba801766e129f151816"]}}}},"responses":{"202":{"description":"Returns an object with the id of the task performing the delete operation.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"example":{"type":"TASK_RESULT","id":"464ae7bf791e49fdb74606a2e4a89635","name":null}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"400.1 Bad Request Content":{"description":"Response for bad request content","value":{"detailCode":"400.1 Bad Request Content","trackingId":"1ea1adcb84da4dcb890145e05745774e","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The request was syntactically correct but its content is semantically invalid."}]}},"400.1 Role ids limit violation":{"description":"Role ids limit violation response","value":{"detailCode":"400.1 Bad Request Content","trackingId":"77aa89ac6f0e422dbc588866abc22be9","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"roleIds count exceeded max limit of 50 for bulk-delete."}]}},"400.1.404 Referenced object not found":{"description":"Referenced object not found response","value":{"detailCode":"400.1.404 Referenced object not found","trackingId":"77aa89ac6f0e422dbc588866abc22be9","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"Referenced roleIds [\"2c91808876438bb2017668b91919ecca\"] was not found."}]}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:role-unchecked:manage","idn:role-checked:manage"]}],"method":"post","path":"/roles/bulk-delete","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"roleIds":["2c9180847812e0b1017817051919ecca","2c9180887812e0b201781e129f151816"]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete Role(s)","description":{"content":"This API initiates a bulk deletion of one or more Roles.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Roles included in the request are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.","type":"text/plain"},"url":{"path":["roles","bulk-delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Role(s)' (bulk-delete-roles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Role(s) + + + +This API initiates a bulk deletion of one or more Roles. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Roles included in the request are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +
Request Body required
+ +Returns an object with the id of the task performing the delete operation. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/cancel-access-request.api.mdx b/products/idn/api/beta/cancel-access-request.api.mdx new file mode 100644 index 000000000..5b8e5b0c2 --- /dev/null +++ b/products/idn/api/beta/cancel-access-request.api.mdx @@ -0,0 +1,88 @@ +--- +id: cancel-access-request +sidebar_label: Cancel Access Request +hide_title: true +hide_table_of_contents: true +api: {"operationId":"cancelAccessRequest","tags":["Access Requests"],"description":"This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step.\nAny token with ORG_ADMIN authority or token of the user who originally requested the access request is required to cancel it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request body payload for cancel access request endpoint.","required":["accountActivityId","comment"],"properties":{"accountActivityId":{"type":"string","description":"ID of the account activity object corresponding to the access request.","example":"2c9180835d2e5168015d32f890ca1581"},"comment":{"type":"string","description":"Reason for cancelling the pending access request.","example":"I requested this role by mistake."}}},"example":{"accountActivityId":"2c91808568c529c60168cca6f90c1313","comment":"I requested this role by mistake."}}}},"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/access-requests/cancel","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"accountActivityId":"2c9180835d2e5168015d32f890ca1581","comment":"I requested this role by mistake."},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Cancel Access Request","description":{"content":"This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step.\nAny token with ORG_ADMIN authority or token of the user who originally requested the access request is required to cancel it.","type":"text/plain"},"url":{"path":["access-requests","cancel"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Cancel Access Request' (cancel-access-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Cancel Access Request + + + +This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. +Any token with ORG_ADMIN authority or token of the user who originally requested the access request is required to cancel it. + +
Request Body required
+ +Accepted - Returned if the request was successfully accepted into the system. + +
Schema
  • object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/cancel-workflow-execution.api.mdx b/products/idn/api/beta/cancel-workflow-execution.api.mdx new file mode 100644 index 000000000..d510342b4 --- /dev/null +++ b/products/idn/api/beta/cancel-workflow-execution.api.mdx @@ -0,0 +1,87 @@ +--- +id: cancel-workflow-execution +sidebar_label: Cancel Workflow Execution by ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"cancelWorkflowExecution","tags":["Workflows"],"description":"Use this API to cancel a running workflow execution.","security":[{"oauth2":["sp:workflow-execute:external"]}],"parameters":[{"name":"id","in":"path","description":"The workflow execution ID","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b"}}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/workflow-executions/{id}/cancel","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Cancel Workflow Execution by ID","description":{"content":"Use this API to cancel a running workflow execution.","type":"text/plain"},"url":{"path":["workflow-executions",":id","cancel"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The workflow execution ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Cancel Workflow Execution by ID' (cancel-workflow-execution)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Cancel Workflow Execution by ID + + + +Use this API to cancel a running workflow execution. + +
Path Parameters
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/certification-campaigns.tag.mdx b/products/idn/api/beta/certification-campaigns.tag.mdx new file mode 100644 index 000000000..537aa586f --- /dev/null +++ b/products/idn/api/beta/certification-campaigns.tag.mdx @@ -0,0 +1,85 @@ +--- +id: certification-campaigns +title: "Certification Campaigns" +description: "Certification Campaigns" +custom_edit_url: null +--- + + + +Use this API to implement certification campaign functionality. +With this functionality in place, administrators can create, customize, and manage certification campaigns for their organizations' use. +Certification campaigns provide IdentityNow (IDN) users with an interactive review process they can use to identify and verify access to systems. +Campaigns help organizations reduce risk of inappropriate access and satisfy audit requirements. + +A certification refers to IDN's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification campaign as a way of showing that a user's access has been reviewed and approved by multiple managers. +Once this campaign has been completed, IDN would provision all the access the user needs, nothing more. + +IDN provides two simple campaign types users can create without using search queries, Manager and Source Owner campaigns: + +You can create these types of campaigns without using any search queries in IDN: + +- ManagerCampaign: IDN provides this campaign type as a way to ensure that an identity's access is certified by their managers. +You only need to provide a name and description to create one. + +- Source Owner Campaign: IDN provides this campaign type as a way to ensure that an identity's access to a source is certified by its source owners. +You only need to provide a name and description to create one. +You can specify the sources whose owners you want involved or just run it across all sources. + +For more information about these campaign types, refer to [Starting a Manager or Source Owner Campaign](https://documentation.sailpoint.com/saas/help/certs/starting_campaign.html). + +One useful way to create certification campaigns in IDN is to use a specific search and then run a campaign on the results returned by that search. +This allows you to be much more specific about whom you are certifying in your campaigns and what access you are certifying in your campaigns. +For example, you can search for all identities who are managed by "Amanda.Ross" and also have the access to the "Accounting" role and then run a certification campaign based on that search to ensure that the returned identities are appropriately certified. + +You can use IDN search queries to create these types of campaigns: + +- Identities: Use this campaign type to review and revoke access items for specific identities. +You can either build a search query and create a campaign certifying all identities returned by that query, or you can search for individual identities and add those identities to the certification campaign. + +- Access Items: Use this campaign type to review and revoke a set of roles, access profiles, or entitlements from the identities that have them. +You can either build a search query and create a campaign certifying all access items returned by that query, or you can search for individual access items and add those items to the certification campaign. + +- Role Composition: Use this campaign type to review a role's composition, including its title, description, and membership criteria. +You can either build a search query and create a campaign certifying all roles returned by that query, or you can search for individual roles and add those roles to the certification campaign. + +- Uncorrelated Accounts: Use this campaign type to certify source accounts that aren't linked to an authoritative identity in IDN. +You can use this campaign type to view all the uncorrelated accounts for a source and certify them. + +For more information about search-based campaigns, refer to [Starting a Campaign from Search](https://documentation.sailpoint.com/saas/help/certs/starting_search_campaign.html). + +Once you have generated your campaign, it becomes available for preview. +An administrator can review the campaign and make changes, or if it's ready and accurate, activate it. + +Once the campaign is active, organization administrators or certification administrators can designate other IDN users as certification reviewers. +Those reviewers can view any of the certifications they either need to review (active) or have already reviewed (completed). + +When a certification campaign is in progress, certification reviewers see the listed active certifications whose involved identities they can review. +Reviewers can then make decisions to grant or revoke access, as well as reassign the ceritifcation to another reviewer. If the reviewer chooses this option, they must provide a reason for reassignment in the form of a comment. + +Once a reviewer has made decisions on all the certification's involved access items, he or she must "Sign Off" to complete the review process. +Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. + +Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. +In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. +In this situation, the certification campaign completes once all the remediation requests are completed. + +The end of a certification campaign is determined by its deadline, its completion status, or by an administrator's decision. + +For more information about certifications and certification campaigns, refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html). + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/certifications.tag.mdx b/products/idn/api/beta/certifications.tag.mdx new file mode 100644 index 000000000..1fc1d110d --- /dev/null +++ b/products/idn/api/beta/certifications.tag.mdx @@ -0,0 +1,33 @@ +--- +id: certifications +title: "Certifications" +description: "Certifications" +custom_edit_url: null +--- + + + +Use this API to implement certification functionality. +This API provides specific functionality that improves an organization's ability to manage its certification process. + +A certification refers to IdentityNow's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. +Once this certification has been completed, IdentityNow would provision all the access the user needs, nothing more. + +This API enables administrators and reviewers to get useful information about certifications at a high level, such as the reviewers involved, and at a more granular level, such as the permissions affected by changes to entitlements within those certifications. +It also provides the useful ability to reassign identities and items within certifications to other reviewers, rather than [reassigning the entire certifications themselves](https://developer.sailpoint.com/idn/api/beta/reassign-identity-certs-async). + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/close-access-request.api.mdx b/products/idn/api/beta/close-access-request.api.mdx new file mode 100644 index 000000000..e5a22931b --- /dev/null +++ b/products/idn/api/beta/close-access-request.api.mdx @@ -0,0 +1,86 @@ +--- +id: close-access-request +sidebar_label: Close Access Request +hide_title: true +hide_table_of_contents: true +api: {"operationId":"closeAccessRequest","tags":["Access Requests"],"description":"This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle (even after the approval state, unlike Cancel Access Request). A token with ORG_ADMIN authority is required.\n\nTo find pending access requests via the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \"Tracking Number,\" and the Download button to export a CSV containing the Tracking Numbers.\n\nTo find pending access requests via the API, use List Account Activities.\n\nInput the ids from either source\n\nTo track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated, and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the Identity Request IDs that finished in error.\n\nThis API triggers the Provisioning Action Completed event trigger for each access request that is closed.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request body payload for close access requests endpoint.","required":["accessRequestIds"],"properties":{"accessRequestIds":{"type":"array","description":"Access Request IDs for the requests to be closed. Accepts 1-500 Identity Request IDs per request.","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"message":{"type":"string","description":"Reason for closing the access request. Displayed under Warnings in IdentityNow.","default":"The IdentityNow Administrator manually closed this request.","example":"The IdentityNow Administrator manually closed this request."},"executionStatus":{"type":"string","enum":["Terminated","Completed"],"description":"The request's provisioning status. Displayed as Stage in IdentityNow.","default":"Terminated","example":"Terminated"},"completionStatus":{"type":"string","enum":["Success","Incomplete","Failure"],"description":"The request's overall status. Displayed as Status in IdentityNow.","default":"Failure","example":"Failure"}}},"example":{"accessRequestIds":["2c90ad2a70ace7d50170acf22ca90010"],"executionStatus":"Terminated","completionStatus":"Failure","message":"The IdentityNow Administrator manually closed this request."}}}},"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/access-requests/close","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"accessRequestIds":["2c90ad2a70ace7d50170acf22ca90010"],"message":"The IdentityNow Administrator manually closed this request.","executionStatus":"Terminated","completionStatus":"Failure"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Close Access Request","description":{"content":"This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle (even after the approval state, unlike Cancel Access Request). A token with ORG_ADMIN authority is required.\n\nTo find pending access requests via the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \"Tracking Number,\" and the Download button to export a CSV containing the Tracking Numbers.\n\nTo find pending access requests via the API, use List Account Activities.\n\nInput the ids from either source\n\nTo track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated, and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the Identity Request IDs that finished in error.\n\nThis API triggers the Provisioning Action Completed event trigger for each access request that is closed.\n","type":"text/plain"},"url":{"path":["access-requests","close"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Close Access Request' (close-access-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Close Access Request + + + +This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle (even after the approval state, unlike Cancel Access Request). A token with ORG_ADMIN authority is required. + +To find pending access requests via the UI, navigate to Search and use this query: status: Pending AND "Access Request". Use the Column Chooser to select "Tracking Number," and the Download button to export a CSV containing the Tracking Numbers. + +To find pending access requests via the API, use List Account Activities. + +Input the ids from either source + +To track the status of endpoint requests, navigate to Search and use this query: name:"Close Identity Requests". Search will include "Close Identity Requests Started" audits when requests are initiated, and "Close Identity Requests Completed" audits when requests are completed. The completion audit will list the Identity Request IDs that finished in error. + +This API triggers the Provisioning Action Completed event trigger for each access request that is closed. + + +
Request Body required
+ +Accepted - Returned if the request was successfully accepted into the system. + +
Schema
  • object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/compare-identity-snapshots-access-type.api.mdx b/products/idn/api/beta/compare-identity-snapshots-access-type.api.mdx new file mode 100644 index 000000000..28b99d152 --- /dev/null +++ b/products/idn/api/beta/compare-identity-snapshots-access-type.api.mdx @@ -0,0 +1,83 @@ +--- +id: compare-identity-snapshots-access-type +sidebar_label: Gets a list of differences of specific accessType for the given identity between 2 snapshots +hide_title: true +hide_table_of_contents: true +api: {"operationId":"compareIdentitySnapshotsAccessType","tags":["Identity History"],"description":"This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' ","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity id","example":"8c190e6787aa4ed9a90bd9d5344523fb"},{"in":"path","name":"accessType","schema":{"type":"string"},"required":true,"description":"The specific type which needs to be compared","example":"role"},{"in":"query","name":"access-associated","schema":{"type":"boolean"},"description":"Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed","example":"2007-03-01T13:00:00Z"},{"in":"query","name":"snapshot1","schema":{"type":"string"},"description":"The snapshot 1 of identity","example":"2008-03-01T13:00:00Z"},{"in":"query","name":"snapshot2","schema":{"type":"string"},"description":"The snapshot 2 of identity","example":"2009-03-01T13:00:00Z"},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"A list of events for the identity","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"the id of the access item"},"eventType":{"type":"string","enum":["ADD","REMOVE"]},"displayName":{"type":"string","description":"the display name of the access item"},"sourceName":{"type":"string","description":"the source name of the access item"}},"example":{"id":"2c91808c7726345b017726a0a2fb013b","eventType":"ADD","displayName":"Test","sourceName":"Source"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/historical-identities/{id}/compare/{access-type}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Gets a list of differences of specific accessType for the given identity between 2 snapshots","description":{"content":"This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' ","type":"text/plain"},"url":{"path":["historical-identities",":id","compare",":access-type"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed","type":"text/plain"},"key":"access-associated","value":""},{"disabled":false,"description":{"content":"The snapshot 1 of identity","type":"text/plain"},"key":"snapshot1","value":""},{"disabled":false,"description":{"content":"The snapshot 2 of identity","type":"text/plain"},"key":"snapshot2","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identity id","type":"text/plain"},"type":"any","value":"","key":"id"},{"disabled":false,"description":{"content":"(Required) The specific type which needs to be compared","type":"text/plain"},"type":"any","value":"","key":"accessType"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Gets a list of differences of specific accessType for the given identity between 2 snapshots' (compare-identity-snapshots-access-type)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Gets a list of differences of specific accessType for the given identity between 2 snapshots + + + +This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' + +
Path Parameters
Query Parameters
+ +A list of events for the identity + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/compare-identity-snapshots.api.mdx b/products/idn/api/beta/compare-identity-snapshots.api.mdx new file mode 100644 index 000000000..e80119882 --- /dev/null +++ b/products/idn/api/beta/compare-identity-snapshots.api.mdx @@ -0,0 +1,87 @@ +--- +id: compare-identity-snapshots +sidebar_label: Gets a difference of count for each access item types for the given identity between 2 snapshots +hide_title: true +hide_table_of_contents: true +api: {"operationId":"compareIdentitySnapshots","tags":["Identity History"],"description":"This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' ","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity id","example":"8c190e6787aa4ed9a90bd9d5344523fb"},{"in":"query","name":"snapshot1","schema":{"type":"string"},"description":"The snapshot 1 of identity","example":"2007-03-01T13:00:00Z"},{"in":"query","name":"snapshot2","schema":{"type":"string"},"description":"The snapshot 2 of identity","example":"2008-03-01T13:00:00Z"},{"in":"query","name":"accessItemTypes","schema":{"type":"array","items":{"type":"string"}},"description":"An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned "},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"A IdentityCompare object with difference details for each access item type","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"accessItemDiff":{"type":"object","description":"Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check.","additionalProperties":{"type":"object"}}},"example":{"accessItemDiff":{"role":{"accessAdded":2,"accessRemoved":3},"entitlement":{"accessAdded":4,"accessRemoved":0},"accessProfile":{"accessAdded":0,"accessRemoved":1}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/historical-identities/{id}/compare","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Gets a difference of count for each access item types for the given identity between 2 snapshots","description":{"content":"This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' ","type":"text/plain"},"url":{"path":["historical-identities",":id","compare"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The snapshot 1 of identity","type":"text/plain"},"key":"snapshot1","value":""},{"disabled":false,"description":{"content":"The snapshot 2 of identity","type":"text/plain"},"key":"snapshot2","value":""},{"disabled":false,"description":{"content":"An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned ","type":"text/plain"},"key":"accessItemTypes","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identity id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Gets a difference of count for each access item types for the given identity between 2 snapshots' (compare-identity-snapshots)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Gets a difference of count for each access item types for the given identity between 2 snapshots + + + +This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' + +
Path Parameters
Query Parameters
+ +A IdentityCompare object with difference details for each access item type + +
Schema array
    accessItemDiff object
    + +Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. + +
  • property name* object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/complete-campaign.api.mdx b/products/idn/api/beta/complete-campaign.api.mdx new file mode 100644 index 000000000..2581ce47a --- /dev/null +++ b/products/idn/api/beta/complete-campaign.api.mdx @@ -0,0 +1,103 @@ +--- +id: complete-campaign +sidebar_label: Complete a Campaign +hide_title: true +hide_table_of_contents: true +api: {"operationId":"completeCampaign","tags":["Certification Campaigns"],"description":":::caution\n\nThis endpoint will run successfully for any campaigns that are **past due**.\n\nThis endpoint will return a content error if the campaign is **not past due**.\n\n:::\n\nCompletes a certification campaign. This is provided to admins so that they\ncan complete a certification even if all items have not been completed.\n\nRequires roles of CERT_ADMIN and ORG_ADMIN\n","requestBody":{"description":"Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE","required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"autoCompleteAction":{"description":"Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion.","type":"string","enum":["APPROVE","REVOKE"],"default":"APPROVE","example":"REVOKE"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The campaign id","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/campaigns/{id}/complete","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"autoCompleteAction":"REVOKE"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Complete a Campaign","description":{"content":":::caution\n\nThis endpoint will run successfully for any campaigns that are **past due**.\n\nThis endpoint will return a content error if the campaign is **not past due**.\n\n:::\n\nCompletes a certification campaign. This is provided to admins so that they\ncan complete a certification even if all items have not been completed.\n\nRequires roles of CERT_ADMIN and ORG_ADMIN\n","type":"text/plain"},"url":{"path":["campaigns",":id","complete"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The campaign id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Complete a Campaign' (complete-campaign)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Complete a Campaign + + + +:::caution + +This endpoint will run successfully for any campaigns that are **past due**. + +This endpoint will return a content error if the campaign is **not past due**. + +::: + +Completes a certification campaign. This is provided to admins so that they +can complete a certification even if all items have not been completed. + +Requires roles of CERT_ADMIN and ORG_ADMIN + + +
Path Parameters
Request Body
+ +Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE + +
+ +Accepted - Returned if the request was successfully accepted into the system. + +
Schema
  • object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/complete-trigger-invocation.api.mdx b/products/idn/api/beta/complete-trigger-invocation.api.mdx new file mode 100644 index 000000000..1205b7a20 --- /dev/null +++ b/products/idn/api/beta/complete-trigger-invocation.api.mdx @@ -0,0 +1,75 @@ +--- +id: complete-trigger-invocation +sidebar_label: Complete Trigger Invocation +hide_title: true +hide_table_of_contents: true +api: {"operationId":"completeTriggerInvocation","tags":["Triggers"],"description":"Completes an invocation to a REQUEST_RESPONSE type trigger.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the invocation to complete.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"secret":{"type":"string","description":"Unique invocation secret that was generated when the invocation was created. Required to authenticate to the endpoint.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"error":{"type":"string","description":"The error message to indicate a failed invocation or error if any.","example":"Access request is denied."},"output":{"type":"object","example":{"approved":false},"description":"Trigger output to complete the invocation. Its schema is defined in the trigger definition."}},"required":["secret","output"]},"example":{"secret":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","output":{"approved":false}}}}},"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/trigger-invocations/{id}/complete","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"secret":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","error":"Access request is denied.","output":{"approved":false}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Complete Trigger Invocation","description":{"content":"Completes an invocation to a REQUEST_RESPONSE type trigger.","type":"text/plain"},"url":{"path":["trigger-invocations",":id","complete"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the invocation to complete.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Complete Trigger Invocation' (complete-trigger-invocation)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Complete Trigger Invocation + + + +Completes an invocation to a REQUEST_RESPONSE type trigger. + +
Path Parameters
Request Body required
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/complete-work-item.api.mdx b/products/idn/api/beta/complete-work-item.api.mdx new file mode 100644 index 000000000..0d435c76d --- /dev/null +++ b/products/idn/api/beta/complete-work-item.api.mdx @@ -0,0 +1,67 @@ +--- +id: complete-work-item +sidebar_label: Complete a Work Item +hide_title: true +hide_table_of_contents: true +api: {"operationId":"completeWorkItem","tags":["Work Items"],"description":"This API completes a work item. Either an admin, or the owning/current user must make this request.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the work item","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"A WorkItems object","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the work item","example":"2c9180835d2e5168015d32f890ca1581"},"requesterId":{"type":"string","description":"ID of the requester","example":"2c9180835d2e5168015d32f890ca1581"},"requesterDisplayName":{"type":"string","description":"The displayname of the requester","example":"John Smith"},"ownerId":{"type":"string","description":"The ID of the owner","example":"2c9180835d2e5168015d32f890ca1581"},"ownerName":{"type":"string","description":"The name of the owner","example":"Jason Smith"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z"},"description":{"type":"string","description":"The description of the work item","example":"Create account on source 'AD'"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"},"type":{"type":"string","enum":["UNKNOWN","GENERIC","CERTIFICATION","REMEDIATION","DELEGATION","APPROVAL","VIOLATIONREVIEW","FORM","POLICYVIOLATION","CHALLENGE","IMPACTANALYSIS","SIGNOFF","EVENT","MANUALACTION","TEST"],"example":"GENERIC","description":"The type of the work item"},"remediationItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the certification","example":"2c9180835d2e5168015d32f890ca1581"},"targetId":{"type":"string","description":"The ID of the certification target","example":"2c9180835d2e5168015d32f890ca1581"},"targetName":{"type":"string","description":"The name of the certification target","example":"john.smith"},"targetDisplayName":{"type":"string","description":"The display name of the certification target","example":"emailAddress"},"applicationName":{"type":"string","description":"The name of the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute being certified","example":"phoneNumber"},"attributeOperation":{"type":"string","description":"The operation of the certification on the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute being certified","example":"512-555-1212"},"nativeIdentity":{"type":"string","description":"The native identity of the target","example":"jason.smith2"}}},"approvalItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the approval item","example":"2c9180835d2e5168015d32f890ca1581"},"account":{"type":"string","description":"The account referenced by the approval item","example":"john.smith"},"application":{"type":"string","description":"The name the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute","example":"emailAddress"},"attributeOperation":{"type":"string","description":"The operation of the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute","example":"a@b.com"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"}}},"name":{"type":"string","description":"The work item name","example":"Account Create"},"completed":{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z"},"numItems":{"type":"integer","description":"The number of items in the work item","example":19},"errors":{"type":"array","items":{"type":"string"},"example":["The work item ID that was specified was not found."]}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}}},"method":"post","path":"/work-items/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Complete a Work Item","description":{"content":"This API completes a work item. Either an admin, or the owning/current user must make this request.","type":"text/plain"},"url":{"path":["work-items",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the work item","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Complete a Work Item' (complete-work-item)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Complete a Work Item + + + +This API completes a work item. Either an admin, or the owning/current user must make this request. + +
Path Parameters
+ +A WorkItems object + +
Schema
    remediationItems object
    approvalItems object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

\ No newline at end of file diff --git a/products/idn/api/beta/connector-rule-management.tag.mdx b/products/idn/api/beta/connector-rule-management.tag.mdx new file mode 100644 index 000000000..8fa8cc7a0 --- /dev/null +++ b/products/idn/api/beta/connector-rule-management.tag.mdx @@ -0,0 +1,16 @@ +--- +id: connector-rule-management +title: "Connector Rule Management" +description: "Connector Rule Management" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/connectors.tag.mdx b/products/idn/api/beta/connectors.tag.mdx new file mode 100644 index 000000000..11f6a76b8 --- /dev/null +++ b/products/idn/api/beta/connectors.tag.mdx @@ -0,0 +1,34 @@ +--- +id: connectors +title: "Connectors" +description: "Connectors" +custom_edit_url: null +--- + + + +Use this API to implement connector functionality. +With this functionality in place, administrators can view available connectors. + +Connectors are the bridges IdentityNow uses to communicate with and aggregate data from sources. +For example, if it is necessary to set up a connection between IdentityNow and the Active Directory source, a connector can bridge the two and enable IdentityNow to synchronize data between the systems. +This ensures account entitlements and states are correct throughout the organization. + +In IdentityNow, administrators can use the Connections drop-down menu and select Sources to view the available source connectors. + +Refer to [IdentityNow Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about the connectors available in IdentityNow. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/idn/docs/saas-connectivity) for more information about the SaaS custom connectors that do not need VAs (virtual appliances) to communicate with their sources. + +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about using connectors in IdentityNow. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/create-access-profile.api.mdx b/products/idn/api/beta/create-access-profile.api.mdx new file mode 100644 index 000000000..dc6350f95 --- /dev/null +++ b/products/idn/api/beta/create-access-profile.api.mdx @@ -0,0 +1,149 @@ +--- +id: create-access-profile +sidebar_label: Create an Access Profile +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createAccessProfile","tags":["Access Profiles"],"description":"This API creates an Access Profile.\nA token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the Access Profile's Source.\nThe maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Access Profile","example":"2c91808a7190d06e01719938fcd20792","readOnly":true},"name":{"type":"string","description":"Name of the Access Profile","example":"Employee-database-read-write"},"description":{"type":"string","nullable":true,"description":"Information about the Access Profile","example":"Collection of entitlements to read/write the employee database"},"created":{"type":"string","description":"Date the Access Profile was created","format":"date-time","example":"2021-03-01T22:32:58.104Z","readOnly":true},"modified":{"type":"string","description":"Date the Access Profile was last modified.","format":"date-time","example":"2021-03-02T20:22:28.104Z","readOnly":true},"enabled":{"type":"boolean","description":"Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement.","example":true},"owner":{"description":"Owner of the Access Profile","type":"object","nullable":true,"properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"source":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Source with with which the Access Profile is associated","example":"2c91809773dee3610173fdb0b6061ef4"},"type":{"type":"string","enum":["SOURCE"],"description":"The type of the Source, will always be SOURCE","example":"SOURCE"},"name":{"type":"string","description":"The display name of the associated Source","example":"ODS-AD-SOURCE"}}},"entitlements":{"type":"array","description":"A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement.","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Entitlement","example":"2c91809773dee32014e13e122092014e"},"type":{"type":"string","enum":["ENTITLEMENT"],"description":"The type of the Entitlement, will always be ENTITLEMENT","example":"ENTITLEMENT"},"name":{"type":"string","description":"The display name of the Entitlement","example":"CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"}}}},"requestable":{"type":"boolean","description":"Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error.","example":true},"accessRequestConfig":{"nullable":true,"description":"Access request configuration for this object","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":true},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":true},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"revocationRequestConfig":{"nullable":true,"description":"Revocation request configuration for this object.","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":false,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":false,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the revocation request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"segments":{"type":"array","nullable":true,"items":{"type":"string"},"description":"List of IDs of segments, if any, to which this Access Profile is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]},"provisioningCriteria":{"description":"When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression is evaluated against those Accounts to choose one to provision with the Access Profile.","nullable":true,"example":{"operation":"OR","children":[{"operation":"AND","children":[{"attribute":"dn","operation":"CONTAINS","value":"useast"},{"attribute":"manager","operation":"CONTAINS","value":"Scott.Clark"}]},{"operation":"AND","children":[{"attribute":"dn","operation":"EQUALS","value":"Gibson"},{"attribute":"telephoneNumber","operation":"CONTAINS","value":"512"}]}]},"type":"object","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","nullable":true,"description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines matching criteria for an Account to be provisioned with a specific Access Profile","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","nullable":true,"description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines matching criteria for an Account to be provisioned with a specific Access Profile","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.","example":null}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.","example":null}}}},"required":["owner","name","source"]}}}},"responses":{"201":{"description":"Access Profile created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Access Profile","example":"2c91808a7190d06e01719938fcd20792","readOnly":true},"name":{"type":"string","description":"Name of the Access Profile","example":"Employee-database-read-write"},"description":{"type":"string","nullable":true,"description":"Information about the Access Profile","example":"Collection of entitlements to read/write the employee database"},"created":{"type":"string","description":"Date the Access Profile was created","format":"date-time","example":"2021-03-01T22:32:58.104Z","readOnly":true},"modified":{"type":"string","description":"Date the Access Profile was last modified.","format":"date-time","example":"2021-03-02T20:22:28.104Z","readOnly":true},"enabled":{"type":"boolean","description":"Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement.","example":true},"owner":{"description":"Owner of the Access Profile","type":"object","nullable":true,"properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"source":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Source with with which the Access Profile is associated","example":"2c91809773dee3610173fdb0b6061ef4"},"type":{"type":"string","enum":["SOURCE"],"description":"The type of the Source, will always be SOURCE","example":"SOURCE"},"name":{"type":"string","description":"The display name of the associated Source","example":"ODS-AD-SOURCE"}}},"entitlements":{"type":"array","description":"A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement.","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Entitlement","example":"2c91809773dee32014e13e122092014e"},"type":{"type":"string","enum":["ENTITLEMENT"],"description":"The type of the Entitlement, will always be ENTITLEMENT","example":"ENTITLEMENT"},"name":{"type":"string","description":"The display name of the Entitlement","example":"CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"}}}},"requestable":{"type":"boolean","description":"Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error.","example":true},"accessRequestConfig":{"nullable":true,"description":"Access request configuration for this object","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":true},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":true},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"revocationRequestConfig":{"nullable":true,"description":"Revocation request configuration for this object.","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":false,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":false,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the revocation request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"segments":{"type":"array","nullable":true,"items":{"type":"string"},"description":"List of IDs of segments, if any, to which this Access Profile is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]},"provisioningCriteria":{"description":"When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression is evaluated against those Accounts to choose one to provision with the Access Profile.","nullable":true,"example":{"operation":"OR","children":[{"operation":"AND","children":[{"attribute":"dn","operation":"CONTAINS","value":"useast"},{"attribute":"manager","operation":"CONTAINS","value":"Scott.Clark"}]},{"operation":"AND","children":[{"attribute":"dn","operation":"EQUALS","value":"Gibson"},{"attribute":"telephoneNumber","operation":"CONTAINS","value":"512"}]}]},"type":"object","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","nullable":true,"description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines matching criteria for an Account to be provisioned with a specific Access Profile","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","nullable":true,"description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines matching criteria for an Account to be provisioned with a specific Access Profile","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.","example":null}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.","example":null}}}},"required":["owner","name","source"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:access-profile:manage"]}],"method":"post","path":"/access-profiles","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"Employee-database-read-write","description":"Collection of entitlements to read/write the employee database","enabled":true,"owner":{"type":"IDENTITY","id":"2c9180a46faadee4016fb4e018c20639","name":"support"},"source":{"id":"2c91809773dee3610173fdb0b6061ef4","type":"SOURCE","name":"ODS-AD-SOURCE"},"entitlements":[{"id":"2c91809773dee32014e13e122092014e","type":"ENTITLEMENT","name":"CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"}],"requestable":true,"accessRequestConfig":{"commentsRequired":true,"denialCommentsRequired":true,"approvalSchemes":[{"approverType":"GOVERNANCE_GROUP","approverId":"46c79819-a69f-49a2-becb-12c971ae66c6"}]},"revocationRequestConfig":{"commentsRequired":false,"denialCommentsRequired":false,"approvalSchemes":[{"approverType":"GOVERNANCE_GROUP","approverId":"46c79819-a69f-49a2-becb-12c971ae66c6"}]},"segments":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"],"provisioningCriteria":{"operation":"OR","children":[{"operation":"AND","children":[{"attribute":"dn","operation":"CONTAINS","value":"useast"},{"attribute":"manager","operation":"CONTAINS","value":"Scott.Clark"}]},{"operation":"AND","children":[{"attribute":"dn","operation":"EQUALS","value":"Gibson"},{"attribute":"telephoneNumber","operation":"CONTAINS","value":"512"}]}]}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create an Access Profile","description":{"content":"This API creates an Access Profile.\nA token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the Access Profile's Source.\nThe maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters.","type":"text/plain"},"url":{"path":["access-profiles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create an Access Profile' (create-access-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create an Access Profile + + + +This API creates an Access Profile. +A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the Access Profile's Source. +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. + +
Request Body required
    owner object required
    + +Owner of the Access Profile + +
    source object required
    entitlements object[]
    + +A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. + +
    accessRequestConfig object
    + +Access request configuration for this object + +
    approvalSchemes object[]
    + +List describing the steps in approving the request + +
    revocationRequestConfig object
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]
    + +List describing the steps in approving the revocation request + +
    provisioningCriteria object
    + +When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression is evaluated against those Accounts to choose one to provision with the Access Profile. + +
    children object[]
    + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + +
    children object[]
    + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + +
+ +Access Profile created + +
Schema
    owner object
    + +Owner of the Access Profile + +
    source object
    entitlements object[]
    + +A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. + +
    accessRequestConfig object
    + +Access request configuration for this object + +
    approvalSchemes object[]
    + +List describing the steps in approving the request + +
    revocationRequestConfig object
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]
    + +List describing the steps in approving the revocation request + +
    provisioningCriteria object
    + +When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression is evaluated against those Accounts to choose one to provision with the Access Profile. + +
    children object[]
    + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + +
    children object[]
    + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-access-request.api.mdx b/products/idn/api/beta/create-access-request.api.mdx new file mode 100644 index 000000000..72ea3a203 --- /dev/null +++ b/products/idn/api/beta/create-access-request.api.mdx @@ -0,0 +1,114 @@ +--- +id: create-access-request +sidebar_label: Submit an Access Request +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createAccessRequest","security":[{"oauth2":["idn:access-request:manage"]}],"tags":["Access Requests"],"description":"This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes.\n\nAccess requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request\nhas been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error\nif you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected.\nIt is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can\nbe accomplished by using the [access request status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [pending access request approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) endpoints. You can also\nuse the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting\nan access request to ensure you are not requesting access that is already granted.\n\nThere are two types of access request:\n\n__GRANT_ACCESS__\n* Can be requested for multiple identities in a single request.\n* Supports self request and request on behalf of other users, see '/beta/access-request-config' endpoint for request configuration options. \n* Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others.\n* Roles, Access Profiles and Entitlements can be requested.\n* While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request.\n \n__REVOKE_ACCESS__\n* Can only be requested for a single identity at a time.\n* Does not support self request. Only manager can request to revoke access for their directly managed employees.\n* If removeDate is specified, then the access will be removed on that date and time only for Roles and Access Profiles. Entitlements are currently unsupported for removeDate.\n* Roles, Access Profiles, and Entitlements can be requested for revocation.\n* Revoke requests for entitlements are limited to 1 entitlement per access request currently.\n* [Roles, Access Profiles] RemoveData can be specified only if access don't have a sunset date.\n* Allows a manager to request to revoke access for direct employees. A token with ORG_ADMIN authority can also request to revoke access from anyone.\n\nNOTE: There is no indication to the approver in the IdentityNow UI that the approval request is for a revoke action. Take this into consideration when calling this API.\n\nA token with API authority cannot be used to call this endpoint. \n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"requestedFor":{"description":"A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID.","type":"array","items":{"type":"string","example":"2c918084660f45d6016617daa9210584"}},"requestType":{"type":"string","enum":["GRANT_ACCESS","REVOKE_ACCESS"],"description":"Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field.","example":"GRANT_ACCESS"},"requestedItems":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"The type of the item being requested.","example":"ACCESS_PROFILE"},"id":{"type":"string","description":"ID of Role, Access Profile or Entitlement being requested.","example":"2c9180835d2e5168015d32f890ca1581"},"comment":{"type":"string","description":"Comment provided by requester.\n* Comment is required when the request is of type Revoke Access.\n","example":"Requesting access profile for John Doe"},"clientMetadata":{"type":"object","additionalProperties":{"type":"string","example":{"requestedAppId":"2c91808f7892918f0178b78da4a305a1","requestedAppName":"test-app"}},"example":{"requestedAppName":"test-app","requestedAppId":"2c91808f7892918f0178b78da4a305a1"},"description":"Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status."},"removeDate":{"type":"string","description":"The date the role or access profile is no longer assigned to the specified identity.\n* Specify a date in the future.\n* The current SLA for the deprovisioning is 24 hours.\n* This date can be modified to either extend or decrease the duration of access item assignments for the specified identity.\n* Currently it is not supported for entitlements.\n* If sunset date for role or access profile specified, removeDate cannot be established. This rule doesn't apply for entitlements.\n","format":"date-time","example":"2020-07-11T21:23:15.000Z"}},"required":["id","type"]}},"clientMetadata":{"type":"object","additionalProperties":{"type":"string","example":{"requestedAppId":"2c91808f7892918f0178b78da4a305a1","requestedAppName":"test-app"}},"example":{"requestedAppId":"2c91808f7892918f0178b78da4a305a1","requestedAppName":"test-app"},"description":"Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities."}},"required":["requestedFor","requestedItems"]}}}},"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/access-requests","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"requestedFor":["2c918084660f45d6016617daa9210584"],"requestType":"GRANT_ACCESS","requestedItems":[{"type":"ACCESS_PROFILE","id":"2c9180835d2e5168015d32f890ca1581","comment":"Requesting access profile for John Doe","clientMetadata":{"requestedAppName":"test-app","requestedAppId":"2c91808f7892918f0178b78da4a305a1"},"removeDate":"2020-07-11T21:23:15.000Z"}],"clientMetadata":{"requestedAppId":"2c91808f7892918f0178b78da4a305a1","requestedAppName":"test-app"}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Submit an Access Request","description":{"content":"This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes.\n\nAccess requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request\nhas been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error\nif you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected.\nIt is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can\nbe accomplished by using the [access request status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [pending access request approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) endpoints. You can also\nuse the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting\nan access request to ensure you are not requesting access that is already granted.\n\nThere are two types of access request:\n\n__GRANT_ACCESS__\n* Can be requested for multiple identities in a single request.\n* Supports self request and request on behalf of other users, see '/beta/access-request-config' endpoint for request configuration options. \n* Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others.\n* Roles, Access Profiles and Entitlements can be requested.\n* While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request.\n \n__REVOKE_ACCESS__\n* Can only be requested for a single identity at a time.\n* Does not support self request. Only manager can request to revoke access for their directly managed employees.\n* If removeDate is specified, then the access will be removed on that date and time only for Roles and Access Profiles. Entitlements are currently unsupported for removeDate.\n* Roles, Access Profiles, and Entitlements can be requested for revocation.\n* Revoke requests for entitlements are limited to 1 entitlement per access request currently.\n* [Roles, Access Profiles] RemoveData can be specified only if access don't have a sunset date.\n* Allows a manager to request to revoke access for direct employees. A token with ORG_ADMIN authority can also request to revoke access from anyone.\n\nNOTE: There is no indication to the approver in the IdentityNow UI that the approval request is for a revoke action. Take this into consideration when calling this API.\n\nA token with API authority cannot be used to call this endpoint. \n","type":"text/plain"},"url":{"path":["access-requests"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Submit an Access Request' (create-access-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Submit an Access Request + + + +This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes. + +Access requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request +has been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error +if you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected. +It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can +be accomplished by using the [access request status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [pending access request approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) endpoints. You can also +use the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting +an access request to ensure you are not requesting access that is already granted. + +There are two types of access request: + +__GRANT_ACCESS__ +* Can be requested for multiple identities in a single request. +* Supports self request and request on behalf of other users, see '/beta/access-request-config' endpoint for request configuration options. +* Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. +* Roles, Access Profiles and Entitlements can be requested. +* While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. + +__REVOKE_ACCESS__ +* Can only be requested for a single identity at a time. +* Does not support self request. Only manager can request to revoke access for their directly managed employees. +* If removeDate is specified, then the access will be removed on that date and time only for Roles and Access Profiles. Entitlements are currently unsupported for removeDate. +* Roles, Access Profiles, and Entitlements can be requested for revocation. +* Revoke requests for entitlements are limited to 1 entitlement per access request currently. +* [Roles, Access Profiles] RemoveData can be specified only if access don't have a sunset date. +* Allows a manager to request to revoke access for direct employees. A token with ORG_ADMIN authority can also request to revoke access from anyone. + +NOTE: There is no indication to the approver in the IdentityNow UI that the approval request is for a revoke action. Take this into consideration when calling this API. + +A token with API authority cannot be used to call this endpoint. + + +
Request Body required
    requestedItems object[] required
    clientMetadata object
    + +Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. + +
  • property name* string
    • clientMetadata object
    + +Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. + +
  • property name* string
+ +Accepted - Returned if the request was successfully accepted into the system. + +
Schema
  • object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-account.api.mdx b/products/idn/api/beta/create-account.api.mdx new file mode 100644 index 000000000..d3328421f --- /dev/null +++ b/products/idn/api/beta/create-account.api.mdx @@ -0,0 +1,81 @@ +--- +id: create-account +sidebar_label: Create Account +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createAccount","tags":["Accounts"],"description":"This API submits an account creation task and returns the task ID. \nThe `sourceId` where this account will be created must be included in the `attributes` object.\nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:accounts:manage"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["attributes"],"properties":{"attributes":{"description":"The schema attribute values for the account","type":"object","required":["sourceId"],"properties":{"sourceId":{"type":"string","description":"Target source to create an account","example":"34bfcbe116c9407464af37acbaf7a4dc"}},"additionalProperties":{"type":"string"},"example":{"sourceId":"34bfcbe116c9407464af37acbaf7a4dc","city":"Austin","displayName":"John Doe","userName":"jdoe","sAMAccountName":"jDoe","mail":"john.doe@sailpoint.com"}}}}}}},"responses":{"202":{"description":"Async task details","content":{"application/json":{"schema":{"description":"Accounts async response containing details on started async process","required":["id"],"type":"object","properties":{"id":{"description":"id of the task","type":"string","example":"2c91808474683da6017468693c260195"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/accounts","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"attributes":{"sourceId":"34bfcbe116c9407464af37acbaf7a4dc","city":"Austin","displayName":"John Doe","userName":"jdoe","sAMAccountName":"jDoe","mail":"john.doe@sailpoint.com"}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create Account","description":{"content":"This API submits an account creation task and returns the task ID. \nThe `sourceId` where this account will be created must be included in the `attributes` object.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Account' (create-account)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Account + + + +This API submits an account creation task and returns the task ID. +The `sourceId` where this account will be created must be included in the `attributes` object. +A token with ORG_ADMIN authority is required to call this API. + +
Request Body required
    attributes object required
    + +The schema attribute values for the account + +
+ +Async task details + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-campaign-template.api.mdx b/products/idn/api/beta/create-campaign-template.api.mdx new file mode 100644 index 000000000..17993ff34 --- /dev/null +++ b/products/idn/api/beta/create-campaign-template.api.mdx @@ -0,0 +1,171 @@ +--- +id: create-campaign-template +sidebar_label: Create a Campaign Template +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createCampaignTemplate","tags":["Certification Campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Campaign Template","properties":{"id":{"type":"string","description":"Id of the campaign template","example":"2c9079b270a266a60170a277bb960008"},"name":{"type":"string","description":"This template's name. Has no bearing on generated campaigns' names.","example":"Manager Campaign Template"},"description":{"type":"string","description":"This template's description. Has no bearing on generated campaigns' descriptions.","example":"Template for the annual manager campaign."},"created":{"type":"string","description":"Creation date of Campaign Template","readOnly":true,"format":"date-time","example":"2020-03-05T22:44:00.364Z"},"modified":{"type":"string","description":"Modification date of Campaign Template","readOnly":true,"format":"date-time","example":"2020-03-05T22:52:09.969Z"},"scheduled":{"type":"boolean","readOnly":true,"description":"Indicates if this campaign template has been scheduled.","example":false},"ownerRef":{"type":"object","description":"The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user.","properties":{"id":{"type":"string","description":"Id of the owner","example":"2c918086676d3e0601677611dbde220f"},"type":{"type":"string","enum":["IDENTITY"],"description":"Type of the owner","example":"IDENTITY"},"name":{"type":"string","description":"Name of the owner","example":"Mister Manager"},"email":{"type":"string","description":"Email of the owner","example":"mr.manager@example.com"}}},"deadlineDuration":{"type":"string","description":"The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign's deadline would be 2020-01-15 (the current date plus 14 days).","example":"P2W"},"campaign":{"type":"object","title":"Campaign","allOf":[{"type":"object","title":"Slim Campaign","required":["name","description","type"],"properties":{"id":{"type":"string","readOnly":true,"description":"Id of the campaign","example":"2c9079b270a266a60170a2779fcb0007"},"name":{"description":"The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","type":"string","example":"Manager Campaign"},"description":{"type":"string","description":"The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","example":"Everyone needs to be reviewed by their manager"},"deadline":{"type":"string","format":"date-time","description":"The campaign's completion deadline.","example":"2020-03-15T10:00:01.456Z"},"type":{"type":"string","description":"The type of campaign. Could be extended in the future.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"},"emailNotificationEnabled":{"type":"boolean","description":"Enables email notification for this campaign","default":false,"example":false},"autoRevokeAllowed":{"type":"boolean","description":"Allows auto revoke for this campaign","default":false,"example":false},"recommendationsEnabled":{"type":"boolean","description":"Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.","default":false,"example":true},"status":{"type":"string","description":"The campaign's current status.","readOnly":true,"enum":["PENDING","STAGED","CANCELING","ACTIVATING","ACTIVE","COMPLETING","COMPLETED","ERROR","ARCHIVED"],"example":"ACTIVE"},"correlatedStatus":{"type":"string","description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"}}},{"type":"object","properties":{"created":{"type":"string","readOnly":true,"format":"date-time","description":"Created time of the campaign","example":"2020-03-03T22:15:13.611Z"},"modified":{"type":"string","readOnly":true,"format":"date-time","description":"Modified time of the campaign","example":"2020-03-03T22:20:12.674Z"},"correlatedStatus":{"description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"},"filter":{"type":"object","description":"Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank.","properties":{"id":{"type":"string","description":"The ID of whatever type of filter is being used.","example":"0fbe863c063c4c88a35fd7f17e8a3df5"},"type":{"type":"string","description":"Type of the filter","enum":["CAMPAIGN_FILTER","RULE"],"example":"CAMPAIGN_FILTER"},"name":{"type":"string","description":"Name of the filter","example":"Test Filter"}}},"sunsetCommentsRequired":{"type":"boolean","description":"Determines if comments on sunset date changes are required.","default":true,"example":true},"sourceOwnerCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SOURCE_OWNER.","properties":{"sourceIds":{"type":"array","description":"The list of sources to be included in the campaign.","items":{"type":"string"},"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]}}},"searchCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SEARCH.","properties":{"type":{"type":"string","description":"The type of search campaign represented.","enum":["IDENTITY","ACCESS"],"example":"ACCESS"},"description":{"type":"string","description":"Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available.","example":"Search Campaign description"},"reviewer":{"description":"If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"query":{"type":"string","description":"The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set.","example":"Search Campaign query description"},"identityIds":{"type":"array","description":"A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set.","items":{"type":"string"},"maxItems":1000,"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]},"accessConstraints":{"type":"array","description":"Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT","ACCESS_PROFILE","ROLE"],"description":"Type of Access","example":"ENTITLEMENT"},"ids":{"description":"Must be set only if operator is SELECTED.","type":"array","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"operator":{"type":"string","enum":["ALL","SELECTED"],"description":"Used to determine whether the scope of the campaign should be reduced for selected ids or all.","example":"SELECTED"}},"required":["type","operator"]},"maxItems":1000}},"required":["type"]},"roleCompositionCampaignInfo":{"type":"object","description":"Optional configuration options for role composition campaigns.","properties":{"reviewer":{"description":"If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"roleIds":{"type":"array","description":"Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"remediatorRef":{"type":"object","description":"This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin.","properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Legal Remediator Type","example":"IDENTITY"},"id":{"type":"string","description":"The ID of the remediator.","example":"2c90ad2a70ace7d50170acf22ca90010"},"name":{"type":"string","description":"The name of the remediator.","readOnly":true,"example":"Role Admin"}},"required":["type","id"]},"query":{"type":"string","description":"Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","example":"Search Query"},"description":{"type":"string","description":"Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available.","example":"Role Composition Description"}},"required":["remediatorRef"]},"alerts":{"type":"array","description":"A list of errors and warnings that have accumulated.","readOnly":true,"items":{"type":"object","properties":{"level":{"type":"string","enum":["ERROR","WARN","INFO"],"description":"Denotes the level of the message","example":"ERROR"},"localizations":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}},"totalCertifications":{"type":"integer","description":"The total number of certifications in this campaign.","readOnly":true,"example":100},"completedCertifications":{"type":"integer","description":"The number of completed certifications in this campaign.","readOnly":true,"example":10},"sourcesWithOrphanEntitlements":{"type":"array","description":"A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented).","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the source","example":"2c90ad2a70ace7d50170acf22ca90010"},"type":{"type":"string","enum":["SOURCE"],"description":"Type","example":"SOURCE"},"name":{"type":"string","description":"Name of the source","example":"Source with orphan entitlements"}}}},"mandatoryCommentRequirement":{"type":"string","description":"Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.","enum":["ALL_DECISIONS","REVOKE_ONLY_DECISIONS","NO_DECISIONS"],"example":"NO_DECISIONS"}}}]}},"required":["name","description","created","modified","campaign"]},"examples":{"Manager":{"description":"This creates a template that can be used to generate manager campaigns. The campaigns will have a due date that is two weeks after their creation date, and will be named \"{current date} Manager Review\" (e.g. \"2020-03-16 Manager Review\").","value":{"name":"Manager Review","description":"A review of everyone's access by their manager.","deadlineDuration":"P2W","campaign":{"name":"Manager Review","description":"Review everyone's access.","type":"MANAGER","filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c"},"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"mandatoryCommentRequirement":"NO_DECISIONS"}}},"Search":{"description":"This creates a template that can be used to generate search access campaigns. The campaigns will cover the \"reporter\" access item for across all identities.","value":{"name":"Reporting Access Review","description":"A review of everyone's access to the reporting system.","deadlineDuration":"P2W","campaign":{"name":"Search Review","description":"Review everyone's access to the reporting system.","type":"SEARCH","filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c"},"searchCampaignInfo":{"type":"ACCESS","query":"@access(name: (\"reporter\"))","description":"Identities with reporting abilities"},"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"mandatoryCommentRequirement":"NO_DECISIONS"}}},"Source Owner":{"description":"This creates a template that can be used to generate source owner campaigns. The campaigns will have a due date that is one month after their creation date, and will review one source.","value":{"name":"AD Source Review","description":"A review of our AD source.","deadlineDuration":"P1M","campaign":{"name":"Source Review","description":"Review everyone's access.","type":"SOURCE_OWNER","filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c"},"sourceOwnerCampaignInfo":{"sourceIds":["2c918084707deba501709d45ce4e5569"]},"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"}}},"RoleComposition":{"description":"This creates a template that can be used to generate role composition campaigns. The campaigns will have a due date that is two weeks after their creation date, and will be named \"{current date} Role Composition Review\" (e.g. \"2020-03-16 Role Composition Review\").","value":{"name":"Role Composition Review","description":"A review of every role's access items, by the specified reviewer.","deadlineDuration":"P2W","campaign":{"name":"Role Composition Review","description":"Review all our roles.","type":"ROLE_COMPOSITION","roleCompositionCampaignInfo":{"remediatorRef":{"type":"IDENTITY","id":"2c9180876ab2c053016ab6f65dfd5aaa"}},"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"mandatoryCommentRequirement":"NO_DECISIONS"}}}}}}},"responses":{"200":{"description":"Created successfully.","content":{"application/json":{"schema":{"type":"object","description":"Campaign Template","properties":{"id":{"type":"string","description":"Id of the campaign template","example":"2c9079b270a266a60170a277bb960008"},"name":{"type":"string","description":"This template's name. Has no bearing on generated campaigns' names.","example":"Manager Campaign Template"},"description":{"type":"string","description":"This template's description. Has no bearing on generated campaigns' descriptions.","example":"Template for the annual manager campaign."},"created":{"type":"string","description":"Creation date of Campaign Template","readOnly":true,"format":"date-time","example":"2020-03-05T22:44:00.364Z"},"modified":{"type":"string","description":"Modification date of Campaign Template","readOnly":true,"format":"date-time","example":"2020-03-05T22:52:09.969Z"},"scheduled":{"type":"boolean","readOnly":true,"description":"Indicates if this campaign template has been scheduled.","example":false},"ownerRef":{"type":"object","description":"The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user.","properties":{"id":{"type":"string","description":"Id of the owner","example":"2c918086676d3e0601677611dbde220f"},"type":{"type":"string","enum":["IDENTITY"],"description":"Type of the owner","example":"IDENTITY"},"name":{"type":"string","description":"Name of the owner","example":"Mister Manager"},"email":{"type":"string","description":"Email of the owner","example":"mr.manager@example.com"}}},"deadlineDuration":{"type":"string","description":"The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign's deadline would be 2020-01-15 (the current date plus 14 days).","example":"P2W"},"campaign":{"type":"object","title":"Campaign","allOf":[{"type":"object","title":"Slim Campaign","required":["name","description","type"],"properties":{"id":{"type":"string","readOnly":true,"description":"Id of the campaign","example":"2c9079b270a266a60170a2779fcb0007"},"name":{"description":"The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","type":"string","example":"Manager Campaign"},"description":{"type":"string","description":"The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","example":"Everyone needs to be reviewed by their manager"},"deadline":{"type":"string","format":"date-time","description":"The campaign's completion deadline.","example":"2020-03-15T10:00:01.456Z"},"type":{"type":"string","description":"The type of campaign. Could be extended in the future.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"},"emailNotificationEnabled":{"type":"boolean","description":"Enables email notification for this campaign","default":false,"example":false},"autoRevokeAllowed":{"type":"boolean","description":"Allows auto revoke for this campaign","default":false,"example":false},"recommendationsEnabled":{"type":"boolean","description":"Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.","default":false,"example":true},"status":{"type":"string","description":"The campaign's current status.","readOnly":true,"enum":["PENDING","STAGED","CANCELING","ACTIVATING","ACTIVE","COMPLETING","COMPLETED","ERROR","ARCHIVED"],"example":"ACTIVE"},"correlatedStatus":{"type":"string","description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"}}},{"type":"object","properties":{"created":{"type":"string","readOnly":true,"format":"date-time","description":"Created time of the campaign","example":"2020-03-03T22:15:13.611Z"},"modified":{"type":"string","readOnly":true,"format":"date-time","description":"Modified time of the campaign","example":"2020-03-03T22:20:12.674Z"},"correlatedStatus":{"description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"},"filter":{"type":"object","description":"Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank.","properties":{"id":{"type":"string","description":"The ID of whatever type of filter is being used.","example":"0fbe863c063c4c88a35fd7f17e8a3df5"},"type":{"type":"string","description":"Type of the filter","enum":["CAMPAIGN_FILTER","RULE"],"example":"CAMPAIGN_FILTER"},"name":{"type":"string","description":"Name of the filter","example":"Test Filter"}}},"sunsetCommentsRequired":{"type":"boolean","description":"Determines if comments on sunset date changes are required.","default":true,"example":true},"sourceOwnerCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SOURCE_OWNER.","properties":{"sourceIds":{"type":"array","description":"The list of sources to be included in the campaign.","items":{"type":"string"},"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]}}},"searchCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SEARCH.","properties":{"type":{"type":"string","description":"The type of search campaign represented.","enum":["IDENTITY","ACCESS"],"example":"ACCESS"},"description":{"type":"string","description":"Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available.","example":"Search Campaign description"},"reviewer":{"description":"If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"query":{"type":"string","description":"The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set.","example":"Search Campaign query description"},"identityIds":{"type":"array","description":"A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set.","items":{"type":"string"},"maxItems":1000,"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]},"accessConstraints":{"type":"array","description":"Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT","ACCESS_PROFILE","ROLE"],"description":"Type of Access","example":"ENTITLEMENT"},"ids":{"description":"Must be set only if operator is SELECTED.","type":"array","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"operator":{"type":"string","enum":["ALL","SELECTED"],"description":"Used to determine whether the scope of the campaign should be reduced for selected ids or all.","example":"SELECTED"}},"required":["type","operator"]},"maxItems":1000}},"required":["type"]},"roleCompositionCampaignInfo":{"type":"object","description":"Optional configuration options for role composition campaigns.","properties":{"reviewer":{"description":"If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"roleIds":{"type":"array","description":"Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"remediatorRef":{"type":"object","description":"This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin.","properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Legal Remediator Type","example":"IDENTITY"},"id":{"type":"string","description":"The ID of the remediator.","example":"2c90ad2a70ace7d50170acf22ca90010"},"name":{"type":"string","description":"The name of the remediator.","readOnly":true,"example":"Role Admin"}},"required":["type","id"]},"query":{"type":"string","description":"Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","example":"Search Query"},"description":{"type":"string","description":"Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available.","example":"Role Composition Description"}},"required":["remediatorRef"]},"alerts":{"type":"array","description":"A list of errors and warnings that have accumulated.","readOnly":true,"items":{"type":"object","properties":{"level":{"type":"string","enum":["ERROR","WARN","INFO"],"description":"Denotes the level of the message","example":"ERROR"},"localizations":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}},"totalCertifications":{"type":"integer","description":"The total number of certifications in this campaign.","readOnly":true,"example":100},"completedCertifications":{"type":"integer","description":"The number of completed certifications in this campaign.","readOnly":true,"example":10},"sourcesWithOrphanEntitlements":{"type":"array","description":"A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented).","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the source","example":"2c90ad2a70ace7d50170acf22ca90010"},"type":{"type":"string","enum":["SOURCE"],"description":"Type","example":"SOURCE"},"name":{"type":"string","description":"Name of the source","example":"Source with orphan entitlements"}}}},"mandatoryCommentRequirement":{"type":"string","description":"Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.","enum":["ALL_DECISIONS","REVOKE_ONLY_DECISIONS","NO_DECISIONS"],"example":"NO_DECISIONS"}}}]}},"required":["name","description","created","modified","campaign"]},"examples":{"Manager":{"value":{"id":"e7dbec99d49349c8951bd84f58a05120","name":"Manager Review","created":"2022-08-02T19:16:42.632Z","modified":null,"description":"A review of everyone's access by their manager.","deadlineDuration":"P14D","ownerRef":{"email":"support@testmail.identitysoon.com","type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"scheduled":false,"campaign":{"created":null,"modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c","name":"Test Manager Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":null,"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":null,"completedCertifications":null,"sourcesWithOrphanEntitlements":null,"id":null,"name":"Manager Review","description":"Review everyone's access.","deadline":null,"type":"MANAGER","status":null,"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"}}},"Search":{"value":{"id":"b7e6459eed5247ac8b98a5fed81fe27f","name":"Reporting Access Review","created":"2022-07-28T19:19:40.035Z","modified":null,"description":"A review of everyone's access to the reporting system.","deadlineDuration":"P14D","ownerRef":{"email":"support@testmail.identitysoon.com","type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"scheduled":false,"campaign":{"created":null,"modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c","name":"Test Search Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":{"type":"ACCESS","description":"Identities with reporting abilities","reviewerId":null,"reviewer":null,"query":"@access(name: (\"reporter\"))","identityIds":null,"accessConstraints":[]},"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":null,"completedCertifications":null,"sourcesWithOrphanEntitlements":null,"id":null,"name":"Search Campaign Review","description":"Review everyone's access to the reporting system.","deadline":null,"type":"SEARCH","status":null,"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"}}},"Source Owner":{"value":{"id":"b9f41bc69e7a4291b9de0630396d030d","name":"AD Source Review","created":"2022-08-02T13:40:36.857Z","modified":null,"description":"A review of our AD source.","deadlineDuration":"P1M","ownerRef":{"email":"support@testmail.identitysoon.com","type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"scheduled":false,"campaign":{"created":null,"modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c","name":"Test Source Owner Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":{"sourceIds":["2c918084707deba501709d45ce4e5569"]},"searchCampaignInfo":null,"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":null,"completedCertifications":null,"sourcesWithOrphanEntitlements":null,"id":null,"name":"AD Source Review","description":"Review everyone's access.","deadline":null,"type":"SOURCE_OWNER","status":null,"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"}}},"RoleComposition":{"value":{"id":"b9f41bc69e7a4291b9de0630396d030d","name":"Campaign With Admin Role","created":"2022-08-02T13:40:36.857Z","modified":null,"description":"Campaign With Admin Role","deadlineDuration":null,"ownerRef":{"email":"support@testmail.identitysoon.com","type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"scheduled":false,"campaign":{"created":null,"modified":null,"filter":null,"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":null,"roleCompositionCampaignInfo":{"remediatorRef":{"type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"reviewerId":null,"reviewer":null,"roleIds":["b15d609fc5c8434b865fe552315fda8f"],"query":null,"description":null},"alerts":null,"totalCertifications":null,"completedCertifications":null,"sourcesWithOrphanEntitlements":null,"id":null,"name":"Campaign With Admin Role","description":"Campaign With Admin Role","deadline":null,"type":"ROLE_COMPOSITION","status":null,"emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"description":"Create a Campaign Template","method":"post","path":"/campaign-templates","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"id":"2c9079b270a266a60170a277bb960008","name":"Manager Campaign Template","description":"Template for the annual manager campaign.","ownerRef":{"id":"2c918086676d3e0601677611dbde220f","type":"IDENTITY","name":"Mister Manager","email":"mr.manager@example.com"},"deadlineDuration":"P2W","campaign":{"name":"Manager Campaign","description":"Everyone needs to be reviewed by their manager","deadline":"2020-03-15T10:00:01.456Z","type":"MANAGER","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":true,"correlatedStatus":"CORRELATED","filter":{"id":"0fbe863c063c4c88a35fd7f17e8a3df5","type":"CAMPAIGN_FILTER","name":"Test Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":{"sourceIds":["0fbe863c063c4c88a35fd7f17e8a3df5"]},"searchCampaignInfo":{"type":"ACCESS","description":"Search Campaign description","reviewer":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"},"query":"Search Campaign query description","identityIds":["0fbe863c063c4c88a35fd7f17e8a3df5"],"accessConstraints":[{"type":"ENTITLEMENT","ids":["2c90ad2a70ace7d50170acf22ca90010"],"operator":"SELECTED"}]},"roleCompositionCampaignInfo":{"reviewer":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"},"roleIds":["2c90ad2a70ace7d50170acf22ca90010"],"remediatorRef":{"type":"IDENTITY","id":"2c90ad2a70ace7d50170acf22ca90010"},"query":"Search Query","description":"Role Composition Description"},"mandatoryCommentRequirement":"NO_DECISIONS"}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create a Campaign Template","description":{"type":"text/plain"},"url":{"path":["campaign-templates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a Campaign Template' (create-campaign-template)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create a Campaign Template + + + +Create a Campaign Template + +
Request Body required
    ownerRef object
    + +The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user. + +
    campaign object
    filter object
    + +Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank. + +
    sourceOwnerCampaignInfo object
    + +Must be set only if the campaign type is SOURCE_OWNER. + +
    searchCampaignInfo object
    + +Must be set only if the campaign type is SEARCH. + +
    reviewer object
    + +If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP + +
    accessConstraints object[]
    + +**Possible values:** `<= 1000` + +
    + +Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. + +
    roleCompositionCampaignInfo object
    + +Optional configuration options for role composition campaigns. + +
    reviewer object
    + +If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP + +
    remediatorRef object required
    + +This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin. + +
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
    localizations object[]
    sourcesWithOrphanEntitlements object[]
    + +A list of sources in the campaign that contain \"orphan entitlements\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). + +
+ +Created successfully. + +
Schema
    ownerRef object
    + +The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user. + +
    campaign object
    filter object
    + +Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank. + +
    sourceOwnerCampaignInfo object
    + +Must be set only if the campaign type is SOURCE_OWNER. + +
    searchCampaignInfo object
    + +Must be set only if the campaign type is SEARCH. + +
    reviewer object
    + +If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP + +
    accessConstraints object[]
    + +**Possible values:** `<= 1000` + +
    + +Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. + +
    roleCompositionCampaignInfo object
    + +Optional configuration options for role composition campaigns. + +
    reviewer object
    + +If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP + +
    remediatorRef object
    + +This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin. + +
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
    localizations object[]
    sourcesWithOrphanEntitlements object[]
    + +A list of sources in the campaign that contain \"orphan entitlements\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-campaign.api.mdx b/products/idn/api/beta/create-campaign.api.mdx new file mode 100644 index 000000000..03b9f398a --- /dev/null +++ b/products/idn/api/beta/create-campaign.api.mdx @@ -0,0 +1,167 @@ +--- +id: create-campaign +sidebar_label: Create a campaign +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createCampaign","tags":["Certification Campaigns"],"description":"Creates a new Certification Campaign with the information provided in the request body.","security":[{"oauth2":["idn:campaign:create"]}],"deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Campaign","allOf":[{"type":"object","title":"Slim Campaign","required":["name","description","type"],"properties":{"id":{"type":"string","readOnly":true,"description":"Id of the campaign","example":"2c9079b270a266a60170a2779fcb0007"},"name":{"description":"The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","type":"string","example":"Manager Campaign"},"description":{"type":"string","description":"The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","example":"Everyone needs to be reviewed by their manager"},"deadline":{"type":"string","format":"date-time","description":"The campaign's completion deadline.","example":"2020-03-15T10:00:01.456Z"},"type":{"type":"string","description":"The type of campaign. Could be extended in the future.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"},"emailNotificationEnabled":{"type":"boolean","description":"Enables email notification for this campaign","default":false,"example":false},"autoRevokeAllowed":{"type":"boolean","description":"Allows auto revoke for this campaign","default":false,"example":false},"recommendationsEnabled":{"type":"boolean","description":"Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.","default":false,"example":true},"status":{"type":"string","description":"The campaign's current status.","readOnly":true,"enum":["PENDING","STAGED","CANCELING","ACTIVATING","ACTIVE","COMPLETING","COMPLETED","ERROR","ARCHIVED"],"example":"ACTIVE"},"correlatedStatus":{"type":"string","description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"}}},{"type":"object","properties":{"created":{"type":"string","readOnly":true,"format":"date-time","description":"Created time of the campaign","example":"2020-03-03T22:15:13.611Z"},"modified":{"type":"string","readOnly":true,"format":"date-time","description":"Modified time of the campaign","example":"2020-03-03T22:20:12.674Z"},"correlatedStatus":{"description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"},"filter":{"type":"object","description":"Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank.","properties":{"id":{"type":"string","description":"The ID of whatever type of filter is being used.","example":"0fbe863c063c4c88a35fd7f17e8a3df5"},"type":{"type":"string","description":"Type of the filter","enum":["CAMPAIGN_FILTER","RULE"],"example":"CAMPAIGN_FILTER"},"name":{"type":"string","description":"Name of the filter","example":"Test Filter"}}},"sunsetCommentsRequired":{"type":"boolean","description":"Determines if comments on sunset date changes are required.","default":true,"example":true},"sourceOwnerCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SOURCE_OWNER.","properties":{"sourceIds":{"type":"array","description":"The list of sources to be included in the campaign.","items":{"type":"string"},"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]}}},"searchCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SEARCH.","properties":{"type":{"type":"string","description":"The type of search campaign represented.","enum":["IDENTITY","ACCESS"],"example":"ACCESS"},"description":{"type":"string","description":"Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available.","example":"Search Campaign description"},"reviewer":{"description":"If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"query":{"type":"string","description":"The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set.","example":"Search Campaign query description"},"identityIds":{"type":"array","description":"A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set.","items":{"type":"string"},"maxItems":1000,"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]},"accessConstraints":{"type":"array","description":"Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT","ACCESS_PROFILE","ROLE"],"description":"Type of Access","example":"ENTITLEMENT"},"ids":{"description":"Must be set only if operator is SELECTED.","type":"array","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"operator":{"type":"string","enum":["ALL","SELECTED"],"description":"Used to determine whether the scope of the campaign should be reduced for selected ids or all.","example":"SELECTED"}},"required":["type","operator"]},"maxItems":1000}},"required":["type"]},"roleCompositionCampaignInfo":{"type":"object","description":"Optional configuration options for role composition campaigns.","properties":{"reviewer":{"description":"If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"roleIds":{"type":"array","description":"Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"remediatorRef":{"type":"object","description":"This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin.","properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Legal Remediator Type","example":"IDENTITY"},"id":{"type":"string","description":"The ID of the remediator.","example":"2c90ad2a70ace7d50170acf22ca90010"},"name":{"type":"string","description":"The name of the remediator.","readOnly":true,"example":"Role Admin"}},"required":["type","id"]},"query":{"type":"string","description":"Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","example":"Search Query"},"description":{"type":"string","description":"Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available.","example":"Role Composition Description"}},"required":["remediatorRef"]},"alerts":{"type":"array","description":"A list of errors and warnings that have accumulated.","readOnly":true,"items":{"type":"object","properties":{"level":{"type":"string","enum":["ERROR","WARN","INFO"],"description":"Denotes the level of the message","example":"ERROR"},"localizations":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}},"totalCertifications":{"type":"integer","description":"The total number of certifications in this campaign.","readOnly":true,"example":100},"completedCertifications":{"type":"integer","description":"The number of completed certifications in this campaign.","readOnly":true,"example":10},"sourcesWithOrphanEntitlements":{"type":"array","description":"A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented).","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the source","example":"2c90ad2a70ace7d50170acf22ca90010"},"type":{"type":"string","enum":["SOURCE"],"description":"Type","example":"SOURCE"},"name":{"type":"string","description":"Name of the source","example":"Source with orphan entitlements"}}}},"mandatoryCommentRequirement":{"type":"string","description":"Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.","enum":["ALL_DECISIONS","REVOKE_ONLY_DECISIONS","NO_DECISIONS"],"example":"NO_DECISIONS"}}}]},"examples":{"Manager":{"value":{"name":"Manager Review","description":"A review of everyone's access by their manager.","deadline":"2020-12-25T06:00:00.468Z","type":"MANAGER","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"filter":{"type":"CAMPAIGN_FILTER","id":"0c46fb26c6b20967a55517ee90d15b93"},"mandatoryCommentRequirement":"NO_DECISIONS"}},"Search":{"value":{"name":"Search Campaign","description":"Search Campaign","deadline":"2020-12-25T06:00:00.468Z","type":"SEARCH","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"filter":{"type":"CAMPAIGN_FILTER","id":"0c46fb26c6b20967a55517ee90d15b93"},"searchCampaignInfo":{"type":"ACCESS","query":"user"},"mandatoryCommentRequirement":"NO_DECISIONS"}},"Source Owner":{"value":{"name":"Source Owner","description":"Source Owner Info","deadline":"2020-12-25T06:00:00.468Z","type":"SOURCE_OWNER","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"filter":{"type":"CAMPAIGN_FILTER","id":"0c46fb26c6b20967a55517ee90d15b93"},"sourceOwnerCampaignInfo":{"sourceIds":["612b31b1a0f04aaf83123bdb80e70db6"]},"correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"}},"Role Composition":{"value":{"name":"Role Composition Campaign","description":"A review done by a role owner.","deadline":"2020-12-25T06:00:00.468Z","type":"ROLE_COMPOSITION","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"filter":{"type":"CAMPAIGN_FILTER","id":"0c46fb26c6b20967a55517ee90d15b93"},"roleCompositionCampaignInfo":{"remediatorRef":{"type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"roleIds":["b15d609fc5c8434b865fe552315fda8f"],"mandatoryCommentRequirement":"NO_DECISIONS"}}}}}}},"responses":{"200":{"description":"Indicates that the campaign requested was successfully created and returns its representation.","content":{"application/json":{"schema":{"type":"object","title":"Campaign","allOf":[{"type":"object","title":"Slim Campaign","required":["name","description","type"],"properties":{"id":{"type":"string","readOnly":true,"description":"Id of the campaign","example":"2c9079b270a266a60170a2779fcb0007"},"name":{"description":"The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","type":"string","example":"Manager Campaign"},"description":{"type":"string","description":"The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","example":"Everyone needs to be reviewed by their manager"},"deadline":{"type":"string","format":"date-time","description":"The campaign's completion deadline.","example":"2020-03-15T10:00:01.456Z"},"type":{"type":"string","description":"The type of campaign. Could be extended in the future.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"},"emailNotificationEnabled":{"type":"boolean","description":"Enables email notification for this campaign","default":false,"example":false},"autoRevokeAllowed":{"type":"boolean","description":"Allows auto revoke for this campaign","default":false,"example":false},"recommendationsEnabled":{"type":"boolean","description":"Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.","default":false,"example":true},"status":{"type":"string","description":"The campaign's current status.","readOnly":true,"enum":["PENDING","STAGED","CANCELING","ACTIVATING","ACTIVE","COMPLETING","COMPLETED","ERROR","ARCHIVED"],"example":"ACTIVE"},"correlatedStatus":{"type":"string","description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"}}},{"type":"object","properties":{"created":{"type":"string","readOnly":true,"format":"date-time","description":"Created time of the campaign","example":"2020-03-03T22:15:13.611Z"},"modified":{"type":"string","readOnly":true,"format":"date-time","description":"Modified time of the campaign","example":"2020-03-03T22:20:12.674Z"},"correlatedStatus":{"description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"},"filter":{"type":"object","description":"Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank.","properties":{"id":{"type":"string","description":"The ID of whatever type of filter is being used.","example":"0fbe863c063c4c88a35fd7f17e8a3df5"},"type":{"type":"string","description":"Type of the filter","enum":["CAMPAIGN_FILTER","RULE"],"example":"CAMPAIGN_FILTER"},"name":{"type":"string","description":"Name of the filter","example":"Test Filter"}}},"sunsetCommentsRequired":{"type":"boolean","description":"Determines if comments on sunset date changes are required.","default":true,"example":true},"sourceOwnerCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SOURCE_OWNER.","properties":{"sourceIds":{"type":"array","description":"The list of sources to be included in the campaign.","items":{"type":"string"},"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]}}},"searchCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SEARCH.","properties":{"type":{"type":"string","description":"The type of search campaign represented.","enum":["IDENTITY","ACCESS"],"example":"ACCESS"},"description":{"type":"string","description":"Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available.","example":"Search Campaign description"},"reviewer":{"description":"If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"query":{"type":"string","description":"The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set.","example":"Search Campaign query description"},"identityIds":{"type":"array","description":"A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set.","items":{"type":"string"},"maxItems":1000,"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]},"accessConstraints":{"type":"array","description":"Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT","ACCESS_PROFILE","ROLE"],"description":"Type of Access","example":"ENTITLEMENT"},"ids":{"description":"Must be set only if operator is SELECTED.","type":"array","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"operator":{"type":"string","enum":["ALL","SELECTED"],"description":"Used to determine whether the scope of the campaign should be reduced for selected ids or all.","example":"SELECTED"}},"required":["type","operator"]},"maxItems":1000}},"required":["type"]},"roleCompositionCampaignInfo":{"type":"object","description":"Optional configuration options for role composition campaigns.","properties":{"reviewer":{"description":"If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"roleIds":{"type":"array","description":"Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"remediatorRef":{"type":"object","description":"This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin.","properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Legal Remediator Type","example":"IDENTITY"},"id":{"type":"string","description":"The ID of the remediator.","example":"2c90ad2a70ace7d50170acf22ca90010"},"name":{"type":"string","description":"The name of the remediator.","readOnly":true,"example":"Role Admin"}},"required":["type","id"]},"query":{"type":"string","description":"Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","example":"Search Query"},"description":{"type":"string","description":"Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available.","example":"Role Composition Description"}},"required":["remediatorRef"]},"alerts":{"type":"array","description":"A list of errors and warnings that have accumulated.","readOnly":true,"items":{"type":"object","properties":{"level":{"type":"string","enum":["ERROR","WARN","INFO"],"description":"Denotes the level of the message","example":"ERROR"},"localizations":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}},"totalCertifications":{"type":"integer","description":"The total number of certifications in this campaign.","readOnly":true,"example":100},"completedCertifications":{"type":"integer","description":"The number of completed certifications in this campaign.","readOnly":true,"example":10},"sourcesWithOrphanEntitlements":{"type":"array","description":"A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented).","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the source","example":"2c90ad2a70ace7d50170acf22ca90010"},"type":{"type":"string","enum":["SOURCE"],"description":"Type","example":"SOURCE"},"name":{"type":"string","description":"Name of the source","example":"Source with orphan entitlements"}}}},"mandatoryCommentRequirement":{"type":"string","description":"Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.","enum":["ALL_DECISIONS","REVOKE_ONLY_DECISIONS","NO_DECISIONS"],"example":"NO_DECISIONS"}}}]},"examples":{"Manager":{"value":{"id":"5594f43b76804a6980ece5fdccf74be7","name":"Manager Review","description":"A review of everyone's access by their manager.","deadline":"2020-12-25T06:00:00.468Z","type":"MANAGER","status":"PENDING","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"created":"2022-08-02T20:21:18.421Z","modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"0fbe863c063c4c88a35fd7f17e8a3df5","name":"Test Manager Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":null,"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":0,"completedCertifications":0,"sourcesWithOrphanEntitlements":null,"mandatoryCommentRequirement":"NO_DECISIONS"}},"Search":{"value":{"id":"ec041831cb2147778b594feb9d8db44a","name":"Search Campaign","description":"Search Campaign","deadline":"2020-12-25T06:00:00.468Z","type":"SEARCH","status":"PENDING","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"created":"2022-08-03T13:54:34.344Z","modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"0fbe863c063c4c88a35fd7f17e8a3df5","name":"Test Search Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":{"type":"ACCESS","description":"user","reviewer":{"type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":null},"query":"user","identityIds":null,"accessConstraints":[]},"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":0,"completedCertifications":0,"sourcesWithOrphanEntitlements":null,"mandatoryCommentRequirement":"NO_DECISIONS"}},"Source Owner":{"value":{"id":"fd7b76ba4ea042de8a9414aa12fc977a","name":"Source Owner","description":"Source Owner Info","deadline":"2020-12-25T06:00:00.468Z","type":"SOURCE_OWNER","status":"PENDING","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"created":"2022-08-03T13:34:19.541Z","modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"0fbe863c063c4c88a35fd7f17e8a3df5","name":"Test Source Owner Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"sourceIds":["612b31b1a0f04aaf83123bdb80e70db6"],"searchCampaignInfo":null,"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":0,"completedCertifications":0,"sourcesWithOrphanEntitlements":null,"correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"}},"Role Composition":{"value":{"id":"3b2e2e5821e84127b6d693d41c40623b","name":"Role Composition Campaign","description":"A review done by a role owner.","deadline":"2020-12-25T06:00:00.468Z","type":"ROLE_COMPOSITION","status":"PENDING","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"created":"2022-08-02T20:30:46.083Z","modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"0fbe863c063c4c88a35fd7f17e8a3df5","name":"Test Role Composition Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":null,"roleCompositionCampaignInfo":{"remediatorRef":{"type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"reviewerId":null,"reviewer":null,"roleIds":["b15d609fc5c8434b865fe552315fda8f"],"query":null,"description":null},"alerts":null,"totalCertifications":0,"completedCertifications":0,"sourcesWithOrphanEntitlements":null,"mandatoryCommentRequirement":"NO_DECISIONS"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/campaigns","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"Manager Campaign","description":"Everyone needs to be reviewed by their manager","deadline":"2020-03-15T10:00:01.456Z","type":"MANAGER","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":true,"correlatedStatus":"CORRELATED","filter":{"id":"0fbe863c063c4c88a35fd7f17e8a3df5","type":"CAMPAIGN_FILTER","name":"Test Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":{"sourceIds":["0fbe863c063c4c88a35fd7f17e8a3df5"]},"searchCampaignInfo":{"type":"ACCESS","description":"Search Campaign description","reviewer":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"},"query":"Search Campaign query description","identityIds":["0fbe863c063c4c88a35fd7f17e8a3df5"],"accessConstraints":[{"type":"ENTITLEMENT","ids":["2c90ad2a70ace7d50170acf22ca90010"],"operator":"SELECTED"}]},"roleCompositionCampaignInfo":{"reviewer":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"},"roleIds":["2c90ad2a70ace7d50170acf22ca90010"],"remediatorRef":{"type":"IDENTITY","id":"2c90ad2a70ace7d50170acf22ca90010"},"query":"Search Query","description":"Role Composition Description"},"mandatoryCommentRequirement":"NO_DECISIONS"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create a campaign","description":{"content":"Creates a new Certification Campaign with the information provided in the request body.","type":"text/plain"},"url":{"path":["campaigns"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a campaign' (create-campaign)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create a campaign + +:::caution deprecated + +This endpoint has been deprecated and may be removed in future versions of the API. + +::: + +Creates a new Certification Campaign with the information provided in the request body. + +
Request Body required
    filter object
    + +Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank. + +
    sourceOwnerCampaignInfo object
    + +Must be set only if the campaign type is SOURCE_OWNER. + +
    searchCampaignInfo object
    + +Must be set only if the campaign type is SEARCH. + +
    reviewer object
    + +If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP + +
    accessConstraints object[]
    + +**Possible values:** `<= 1000` + +
    + +Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. + +
    roleCompositionCampaignInfo object
    + +Optional configuration options for role composition campaigns. + +
    reviewer object
    + +If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP + +
    remediatorRef object required
    + +This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin. + +
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
    localizations object[]
    sourcesWithOrphanEntitlements object[]
    + +A list of sources in the campaign that contain \"orphan entitlements\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). + +
+ +Indicates that the campaign requested was successfully created and returns its representation. + +
Schema
    filter object
    + +Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank. + +
    sourceOwnerCampaignInfo object
    + +Must be set only if the campaign type is SOURCE_OWNER. + +
    searchCampaignInfo object
    + +Must be set only if the campaign type is SEARCH. + +
    reviewer object
    + +If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP + +
    accessConstraints object[]
    + +**Possible values:** `<= 1000` + +
    + +Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. + +
    roleCompositionCampaignInfo object
    + +Optional configuration options for role composition campaigns. + +
    reviewer object
    + +If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP + +
    remediatorRef object
    + +This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin. + +
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
    localizations object[]
    sourcesWithOrphanEntitlements object[]
    + +A list of sources in the campaign that contain \"orphan entitlements\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-common-access.api.mdx b/products/idn/api/beta/create-common-access.api.mdx new file mode 100644 index 000000000..7667093f8 --- /dev/null +++ b/products/idn/api/beta/create-common-access.api.mdx @@ -0,0 +1,75 @@ +--- +id: create-common-access +sidebar_label: Create common access items +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createCommonAccess","tags":["IAI Common Access"],"description":"This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"access":{"type":"object","properties":{"id":{"type":"string","description":"Common access ID"},"type":{"description":"Common access type (ROLE or ACCESS_PROFILE)","type":"string","enum":["ACCESS_PROFILE","ROLE"]},"name":{"type":"string","description":"Common access name"},"description":{"type":"string","description":"Common access description"},"ownerName":{"type":"string","description":"Common access owner name"},"ownerId":{"type":"string","description":"Common access owner ID"}}},"status":{"type":"string","enum":["CONFIRMED","DENIED"],"description":"State of common access item."}}}}}},"responses":{"202":{"description":"Returns details of the common access classification request.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Common Access Item ID"},"access":{"type":"object","properties":{"id":{"type":"string","description":"Common access ID"},"type":{"description":"Common access type (ROLE or ACCESS_PROFILE)","type":"string","enum":["ACCESS_PROFILE","ROLE"]},"name":{"type":"string","description":"Common access name"},"description":{"type":"string","description":"Common access description"},"ownerName":{"type":"string","description":"Common access owner name"},"ownerId":{"type":"string","description":"Common access owner ID"}}},"status":{"type":"string","enum":["CONFIRMED","DENIED"],"description":"State of common access item."},"lastUpdated":{"type":"string"},"reviewedByUser":{"type":"boolean"},"lastReviewed":{"type":"string"},"createdByUser":{"type":"string"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/common-access","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"access":{"id":"string","type":"ACCESS_PROFILE","name":"string","description":"string","ownerName":"string","ownerId":"string"},"status":"CONFIRMED"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create common access items","description":{"content":"This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create","type":"text/plain"},"url":{"path":["common-access"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create common access items' (create-common-access)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create common access items + + + +This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create + +
Request Body required
    access object
+ +Returns details of the common access classification request. + +
Schema
    access object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-connector-rule.api.mdx b/products/idn/api/beta/create-connector-rule.api.mdx new file mode 100644 index 000000000..4e19e1467 --- /dev/null +++ b/products/idn/api/beta/create-connector-rule.api.mdx @@ -0,0 +1,96 @@ +--- +id: create-connector-rule +sidebar_label: Create Connector Rule +hide_title: true +hide_table_of_contents: true +api: {"tags":["Connector Rule Management"],"operationId":"createConnectorRule","description":"Creates a new connector rule.\nA token with ORG_ADMIN authority is required to call this API.","requestBody":{"required":true,"description":"The connector rule to create","content":{"application/json":{"schema":{"description":"ConnectorRuleCreateRequest","type":"object","required":["name","type","sourceCode"],"properties":{"name":{"type":"string","description":"the name of the rule","example":"WebServiceBeforeOperationRule","minLength":1,"maxLength":128},"description":{"type":"string","description":"a description of the rule's purpose","example":"This rule does that"},"type":{"type":"string","enum":["BuildMap","ConnectorAfterCreate","ConnectorAfterDelete","ConnectorAfterModify","ConnectorBeforeCreate","ConnectorBeforeDelete","ConnectorBeforeModify","JDBCBuildMap","JDBCOperationProvisioning","JDBCProvision","PeopleSoftHRMSBuildMap","PeopleSoftHRMSOperationProvisioning","PeopleSoftHRMSProvision","RACFPermissionCustomization","SAPBuildMap","SapHrManagerRule","SapHrOperationProvisioning","SapHrProvision","SuccessFactorsOperationProvisioning","WebServiceAfterOperationRule","WebServiceBeforeOperationRule"],"description":"the type of rule","example":"BuildMap"},"signature":{"description":"The rule's function signature. Describes the rule's input arguments and output (if any)","type":"object","required":["input"],"properties":{"input":{"type":"array","items":{"type":"object","nullable":true,"properties":{"name":{"type":"string","description":"the name of the argument","example":"firstName"},"description":{"type":"string","description":"the description of the argument","example":"the first name of the identity"},"type":{"type":"string","nullable":true,"description":"the programmatic type of the argument","example":"String"}},"required":["name"]}},"output":{"type":"object","nullable":true,"properties":{"name":{"type":"string","description":"the name of the argument","example":"firstName"},"description":{"type":"string","description":"the description of the argument","example":"the first name of the identity"},"type":{"type":"string","nullable":true,"description":"the programmatic type of the argument","example":"String"}},"required":["name"]}}},"sourceCode":{"description":"SourceCode","type":"object","required":["version","script"],"properties":{"version":{"type":"string","description":"the version of the code","example":"1.0"},"script":{"type":"string","description":"The code","example":"return \"Mr. \" + firstName;"}}},"attributes":{"type":"object","nullable":true,"description":"a map of string to objects","example":{}}}}}}},"responses":{"201":{"description":"The created connector rule","content":{"application/json":{"schema":{"description":"ConnectorRuleResponse","allOf":[{"description":"ConnectorRuleCreateRequest","type":"object","required":["name","type","sourceCode"],"properties":{"name":{"type":"string","description":"the name of the rule","example":"WebServiceBeforeOperationRule","minLength":1,"maxLength":128},"description":{"type":"string","description":"a description of the rule's purpose","example":"This rule does that"},"type":{"type":"string","enum":["BuildMap","ConnectorAfterCreate","ConnectorAfterDelete","ConnectorAfterModify","ConnectorBeforeCreate","ConnectorBeforeDelete","ConnectorBeforeModify","JDBCBuildMap","JDBCOperationProvisioning","JDBCProvision","PeopleSoftHRMSBuildMap","PeopleSoftHRMSOperationProvisioning","PeopleSoftHRMSProvision","RACFPermissionCustomization","SAPBuildMap","SapHrManagerRule","SapHrOperationProvisioning","SapHrProvision","SuccessFactorsOperationProvisioning","WebServiceAfterOperationRule","WebServiceBeforeOperationRule"],"description":"the type of rule","example":"BuildMap"},"signature":{"description":"The rule's function signature. Describes the rule's input arguments and output (if any)","type":"object","required":["input"],"properties":{"input":{"type":"array","items":{"type":"object","nullable":true,"properties":{"name":{"type":"string","description":"the name of the argument","example":"firstName"},"description":{"type":"string","description":"the description of the argument","example":"the first name of the identity"},"type":{"type":"string","nullable":true,"description":"the programmatic type of the argument","example":"String"}},"required":["name"]}},"output":{"type":"object","nullable":true,"properties":{"name":{"type":"string","description":"the name of the argument","example":"firstName"},"description":{"type":"string","description":"the description of the argument","example":"the first name of the identity"},"type":{"type":"string","nullable":true,"description":"the programmatic type of the argument","example":"String"}},"required":["name"]}}},"sourceCode":{"description":"SourceCode","type":"object","required":["version","script"],"properties":{"version":{"type":"string","description":"the version of the code","example":"1.0"},"script":{"type":"string","description":"The code","example":"return \"Mr. \" + firstName;"}}},"attributes":{"type":"object","nullable":true,"description":"a map of string to objects","example":{}}}},{"type":"object","nullable":true,"required":["id","created"],"properties":{"id":{"type":"string","description":"the ID of the rule","example":"8113d48c0b914f17b4c6072d4dcb9dfe"},"created":{"type":"string","description":"an ISO 8601 UTC timestamp when this rule was created","example":"021-07-22T15:59:23Z"},"modified":{"type":"string","nullable":true,"description":"an ISO 8601 UTC timestamp when this rule was last modified","example":"021-07-22T15:59:23Z"}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:rule-management-connector:manage"]}],"method":"post","path":"/connector-rules","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"WebServiceBeforeOperationRule","description":"This rule does that","type":"BuildMap","signature":{"input":[{"name":"firstName","description":"the first name of the identity","type":"String"}],"output":{"name":"firstName","description":"the first name of the identity","type":"String"}},"sourceCode":{"version":"1.0","script":"return \"Mr. \" + firstName;"},"attributes":{}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create Connector Rule","description":{"content":"Creates a new connector rule.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["connector-rules"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Connector Rule' (create-connector-rule)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Connector Rule + + + +Creates a new connector rule. +A token with ORG_ADMIN authority is required to call this API. + +
Request Body required
+ +The connector rule to create + +
    signature object
    + +The rule's function signature. Describes the rule's input arguments and output (if any) + +
    input object[] required
    output object
    sourceCode object required
    + +SourceCode + +
+ +The created connector rule + +
Schema
    signature object
    + +The rule's function signature. Describes the rule's input arguments and output (if any) + +
    input object[]
    output object
    sourceCode object
    + +SourceCode + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-custom-password-instructions.api.mdx b/products/idn/api/beta/create-custom-password-instructions.api.mdx new file mode 100644 index 000000000..874f55a8c --- /dev/null +++ b/products/idn/api/beta/create-custom-password-instructions.api.mdx @@ -0,0 +1,67 @@ +--- +id: create-custom-password-instructions +sidebar_label: Create Custom Password Instructions +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createCustomPasswordInstructions","tags":["Custom Password Instructions"],"description":"This API creates the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pageId":{"type":"string","description":"The page ID that represents the page for forget user name, reset password and unlock account flow.","enum":["change-password:enter-password","change-password:finish","flow-selection:select","forget-username:user-email","mfa:enter-code","mfa:enter-kba","mfa:select","reset-password:enter-password","reset-password:enter-username","reset-password:finish","unlock-account:enter-username","unlock-account:finish"]},"pageContent":{"type":"string","description":"The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like ... clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to \"_blank\" like this: link. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target."},"locale":{"type":"string","example":"en","description":"The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\"."}}},"example":{"pageId":"reset-password:enter-password","pageContent":"See company password policies for details by clicking here"}}}},"responses":{"200":{"description":"Reference to the custom password instructions.","content":{"application/json":{"schema":{"type":"object","properties":{"pageId":{"type":"string","description":"The page ID that represents the page for forget user name, reset password and unlock account flow.","enum":["change-password:enter-password","change-password:finish","flow-selection:select","forget-username:user-email","mfa:enter-code","mfa:enter-kba","mfa:select","reset-password:enter-password","reset-password:enter-username","reset-password:finish","unlock-account:enter-username","unlock-account:finish"]},"pageContent":{"type":"string","description":"The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like ... clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to \"_blank\" like this: link. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target."},"locale":{"type":"string","example":"en","description":"The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\"."}}},"example":{"pageId":"reset-password:enter-password","locale":"default","pageContent":"See company password policies for details by clicking here"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/custom-password-instructions","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"pageId":"change-password:enter-password","pageContent":"string","locale":"en"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create Custom Password Instructions","description":{"content":"This API creates the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["custom-password-instructions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Custom Password Instructions' (create-custom-password-instructions)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Custom Password Instructions + + + +This API creates the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. + +
Request Body required
    ... clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to \"_blank\" like this: link. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}>
+ +Reference to the custom password instructions. + +
Schema
    ... clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to \"_blank\" like this: link. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}>
here\"\n}"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-domain-dkim.api.mdx b/products/idn/api/beta/create-domain-dkim.api.mdx new file mode 100644 index 000000000..2cc8b6050 --- /dev/null +++ b/products/idn/api/beta/create-domain-dkim.api.mdx @@ -0,0 +1,79 @@ +--- +id: create-domain-dkim +sidebar_label: Verify domain address via DKIM +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["sp:notification-verify-domain-dkim:write"]}],"operationId":"createDomainDkim","tags":["Notifications"],"description":"Create a domain to be verified via DKIM (DomainKeys Identified Mail)","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","example":"sailpoint.com","description":"A domain address"}}}}}},"responses":{"200":{"description":"List of DKIM tokens required for the verification process.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"123b45b0-aaaa-bbbb-a7db-123456a56abc","description":"New UUID associated with domain to be verified"},"domain":{"type":"string","example":"sailpoint.com","description":"A domain address"},"dkimEnabled":{"default":false,"example":true,"description":"DKIM is enabled for this domain"},"dkimTokens":{"type":"array","items":{"type":"string"},"example":["token1","token2","token3"],"description":"DKIM tokens required for authentication"},"dkimVerificationStatus":{"type":"string","example":"PENDING","description":"Status of DKIM authentication"}},"description":"Domain status DTO containing everything required to verify via DKIM"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"405":{"description":"Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method.","content":{"application/json":{"schema":{"type":"object","properties":{"errorName":{"description":"A message describing the error","example":"NotSupportedException"},"errorMessage":{"description":"Description of the error","example":"Cannot consume content type"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/verified-domains","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"domain":"sailpoint.com"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Verify domain address via DKIM","description":{"content":"Create a domain to be verified via DKIM (DomainKeys Identified Mail)","type":"text/plain"},"url":{"path":["verified-domains"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Verify domain address via DKIM' (create-domain-dkim)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Verify domain address via DKIM + + + +Create a domain to be verified via DKIM (DomainKeys Identified Mail) + +
Request Body required
+ +List of DKIM tokens required for the verification process. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method. + +
Schema
+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-form-definition-dynamic-schema.api.mdx b/products/idn/api/beta/create-form-definition-dynamic-schema.api.mdx new file mode 100644 index 000000000..cbd818157 --- /dev/null +++ b/products/idn/api/beta/create-form-definition-dynamic-schema.api.mdx @@ -0,0 +1,63 @@ +--- +id: create-form-definition-dynamic-schema +sidebar_label: Generate JSON Schema dynamically. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Custom Forms"],"operationId":"createFormDefinitionDynamicSchema","requestBody":{"description":"Body is the request payload to create a form definition dynamic schema","content":{"application/json":{"schema":{"properties":{"attributes":{"properties":{"formDefinitionId":{"description":"FormDefinitionID is a unique guid identifying this form definition","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"FormDefinitionID"}},"type":"object","x-go-name":"Attributes"},"description":{"description":"Description is the form definition dynamic schema description text","example":"A description","type":"string","x-go-name":"Description"},"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is the form definition dynamic schema type","example":"action","type":"string","x-go-name":"Type"},"versionNumber":{"description":"VersionNumber is the form definition dynamic schema version number","example":1,"format":"int64","type":"integer","x-go-name":"VersionNumber"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"example":{"id":"sp:forms","attributes":{"formDefinitionId":"00000000-0000-0000-0000-000000000000"},"description":"AnotherDescription","type":"action","versionNumber":1}}},"required":false},"responses":{"200":{"description":"Returns a form elements dynamic schema","content":{"application/json":{"schema":{"properties":{"outputSchema":{"additionalProperties":{},"description":"OutputSchema holds a JSON schema generated dynamically","example":{"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"}},"type":"object","x-go-name":"OutputSchema"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}}}},"400":{"description":"An error with the request occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"401":{"description":"An error with the authorization occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"403":{"description":"An error with the user permissions occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"404":{"description":"An error with the item not found","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"title":"Error is the standard API error response type.","type":"object","properties":{"detailCode":{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"trackingId":{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"}}}},"500":{"description":"An internal server error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}}},"security":[{"oauth2":["sp:forms:manage"]}],"x-codegen-request-body-name":"Body","description":"Generate JSON Schema dynamically.","method":"post","path":"/form-definitions/forms-action-dynamic-schema","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"attributes":{"formDefinitionId":"00000000-0000-0000-0000-000000000000"},"description":"A description","id":"00000000-0000-0000-0000-000000000000","type":"action","versionNumber":1},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Generate JSON Schema dynamically.","description":{"type":"text/plain"},"url":{"path":["form-definitions","forms-action-dynamic-schema"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Generate JSON Schema dynamically.' (create-form-definition-dynamic-schema)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Generate JSON Schema dynamically. + + + +Generate JSON Schema dynamically. + +
Request Body
+ +Body is the request payload to create a form definition dynamic schema + +
    attributes object
+ +Returns a form elements dynamic schema + +
Schema
    outputSchema object
    + +OutputSchema holds a JSON schema generated dynamically + +
+ +An error with the request occurred + +
Schema
    messages object[]
+ +An error with the authorization occurred + +
Schema
    messages object[]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
+ +An error with the item not found + +
Schema
    messages object[]
+ +Too many requests + +
Schema
    messages object[]
+ +An internal server error occurred + +
Schema
    messages object[]
\ No newline at end of file diff --git a/products/idn/api/beta/create-form-definition.api.mdx b/products/idn/api/beta/create-form-definition.api.mdx new file mode 100644 index 000000000..9e0ba9e4f --- /dev/null +++ b/products/idn/api/beta/create-form-definition.api.mdx @@ -0,0 +1,119 @@ +--- +id: create-form-definition +sidebar_label: Creates a form definition. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Custom Forms"],"operationId":"createFormDefinition","requestBody":{"description":"Body is the request payload to create form definition request","content":{"application/json":{"schema":{"properties":{"description":{"description":"Description is the form definition description","example":"My form description","maxLength":2000,"minLength":0,"type":"string","x-go-name":"Description"},"formConditions":{"description":"FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form","items":{"description":"FormCondition represent a form conditional","properties":{"effects":{"description":"Effects is a list of effects","items":{"description":"ConditionEffect is the effect produced by a condition","properties":{"config":{"additionalProperties":{},"description":"Config is a arbitrary map that holds a configuration based on EffectType","example":{},"type":"object","x-go-name":"Config"},"effectType":{"description":"EffectType is the type of effect to perform when the conditions are evaluated for this logic block\nHIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","enum":["HIDE","SHOW","DISABLE","ENABLE","REQUIRE","OPTIONAL","SUBMIT_MESSAGE","SUBMIT_NOTIFICATION","SET_DEFAULT_VALUE"],"example":"HIDE","type":"string","x-go-enum-desc":"HIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","x-go-name":"EffectType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Effects"},"ruleOperator":{"description":"RuleOperator is a ConditionRuleLogicalOperatorType value\nAND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","enum":["AND","OR"],"example":"AND","type":"string","x-go-enum-desc":"AND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","x-go-name":"RuleOperator"},"rules":{"description":"Rules is a list of rules","items":{"properties":{"operator":{"description":"Operator is a ConditionRuleComparisonOperatorType value\nEQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","enum":["EQ","NE","CO","NOT_CO","IN","NOT_IN","EM","NOT_EM","SW","NOT_SW","EW","NOT_EW"],"example":"EQ","type":"string","x-go-enum-desc":"EQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","x-go-name":"Operator"},"source":{"description":"Source, if the sourceType is ConditionRuleSourceTypeInput then the source type is the name of the form input to accept. While if the sourceType is ConditionRuleSourceTypeElement\nthen source is the name of a technical key of an element to retrieve its value","example":"department","type":"string","x-go-name":"Source"},"sourceType":{"description":"SourceType defines what type of object is being selected. Either a reference to a form input (by input name), or a form element (by technical key)\nINPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","enum":["INPUT","ELEMENT"],"example":"ELEMENT","type":"string","x-go-enum-desc":"INPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","x-go-name":"SourceType"},"value":{"description":"Value is the value based on the ValueType","example":"Engineering","x-go-name":"Value"},"valueType":{"description":"ValueType is a ConditionRuleValueType type\nSTRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","enum":["STRING","STRING_LIST","INPUT","ELEMENT","LIST","BOOLEAN"],"example":"STRING","type":"string","x-go-enum-desc":"STRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","x-go-name":"ValueType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Rules"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormConditions"},"formElements":{"description":"FormElements is a list of nested form elements","items":{"properties":{"config":{"additionalProperties":{},"description":"Config is a config object","example":{"label":"Department"},"type":"object","x-go-name":"Config"},"elementType":{"description":"ElementType is a FormElementType value\nTEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","enum":["TEXT","TOGGLE","TEXTAREA","HIDDEN","PHONE","EMAIL","SELECT","DATE","SECTION","COLUMNS"],"example":"TEXT","type":"string","x-go-enum-desc":"TEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","x-go-name":"ElementType"},"id":{"description":"ID is a form element identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"key":{"description":"Key is the technical key","example":"department","type":"string","x-go-name":"Key"},"validations":{"description":"FormElementValidationsSet is a set of FormElementValidation items","example":[{"validationType":"REQUIRED"}],"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormElements"},"formInput":{"description":"FormInput is a list of form inputs that are required when creating a form-instance object","items":{"properties":{"description":{"description":"Description is the description for this form input value","example":"A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic","type":"string","x-go-name":"Description"},"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"label":{"description":"Label is the name for this form input value","example":"input1","type":"string","x-go-name":"Label"},"type":{"description":"Type is a FormDefinitionInputType value\nSTRING FormDefinitionInputTypeString","enum":["STRING"],"example":"STRING","type":"string","x-go-enum-desc":"STRING FormDefinitionInputTypeString","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormInput"},"name":{"description":"Name is the form definition name","example":"My form","maxLength":255,"type":"string","x-go-name":"Name"},"owner":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a FormOwnerType value\nIDENTITY FormOwnerTypeIdentity","enum":["IDENTITY"],"example":"IDENTITY","type":"string","x-go-enum-desc":"IDENTITY FormOwnerTypeIdentity","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"usedBy":{"description":"UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used","items":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a FormUsedByType value\nWORKFLOW FormUsedByTypeWorkflow\nSOURCE FormUsedByTypeSource","enum":["WORKFLOW","SOURCE"],"example":"WORKFLOW","type":"string","x-go-enum-desc":"WORKFLOW FormUsedByTypeWorkflow\nSOURCE FormUsedByTypeSource","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"UsedBy"}},"required":["name","owner"],"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"example":{"name":"my form","description":"my form description","owner":{"type":"IDENTITY","id":"00000000-0000-0000-0000-000000000000"}}}},"required":false},"responses":{"201":{"description":"Returns a new form definition","content":{"application/json":{"schema":{"properties":{"created":{"description":"Created is the date the form definition was created","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Created"},"description":{"description":"Description is the form definition description","example":"My form description","type":"string","x-go-name":"Description"},"formConditions":{"description":"FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form","items":{"description":"FormCondition represent a form conditional","properties":{"effects":{"description":"Effects is a list of effects","items":{"description":"ConditionEffect is the effect produced by a condition","properties":{"config":{"additionalProperties":{},"description":"Config is a arbitrary map that holds a configuration based on EffectType","example":{},"type":"object","x-go-name":"Config"},"effectType":{"description":"EffectType is the type of effect to perform when the conditions are evaluated for this logic block\nHIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","enum":["HIDE","SHOW","DISABLE","ENABLE","REQUIRE","OPTIONAL","SUBMIT_MESSAGE","SUBMIT_NOTIFICATION","SET_DEFAULT_VALUE"],"example":"HIDE","type":"string","x-go-enum-desc":"HIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","x-go-name":"EffectType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Effects"},"ruleOperator":{"description":"RuleOperator is a ConditionRuleLogicalOperatorType value\nAND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","enum":["AND","OR"],"example":"AND","type":"string","x-go-enum-desc":"AND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","x-go-name":"RuleOperator"},"rules":{"description":"Rules is a list of rules","items":{"properties":{"operator":{"description":"Operator is a ConditionRuleComparisonOperatorType value\nEQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","enum":["EQ","NE","CO","NOT_CO","IN","NOT_IN","EM","NOT_EM","SW","NOT_SW","EW","NOT_EW"],"example":"EQ","type":"string","x-go-enum-desc":"EQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","x-go-name":"Operator"},"source":{"description":"Source, if the sourceType is ConditionRuleSourceTypeInput then the source type is the name of the form input to accept. While if the sourceType is ConditionRuleSourceTypeElement\nthen source is the name of a technical key of an element to retrieve its value","example":"department","type":"string","x-go-name":"Source"},"sourceType":{"description":"SourceType defines what type of object is being selected. Either a reference to a form input (by input name), or a form element (by technical key)\nINPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","enum":["INPUT","ELEMENT"],"example":"ELEMENT","type":"string","x-go-enum-desc":"INPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","x-go-name":"SourceType"},"value":{"description":"Value is the value based on the ValueType","example":"Engineering","x-go-name":"Value"},"valueType":{"description":"ValueType is a ConditionRuleValueType type\nSTRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","enum":["STRING","STRING_LIST","INPUT","ELEMENT","LIST","BOOLEAN"],"example":"STRING","type":"string","x-go-enum-desc":"STRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","x-go-name":"ValueType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Rules"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormConditions"},"formElements":{"description":"FormElements is a list of nested form elements","items":{"properties":{"config":{"additionalProperties":{},"description":"Config is a config object","example":{"label":"Department"},"type":"object","x-go-name":"Config"},"elementType":{"description":"ElementType is a FormElementType value\nTEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","enum":["TEXT","TOGGLE","TEXTAREA","HIDDEN","PHONE","EMAIL","SELECT","DATE","SECTION","COLUMNS"],"example":"TEXT","type":"string","x-go-enum-desc":"TEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","x-go-name":"ElementType"},"id":{"description":"ID is a form element identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"key":{"description":"Key is the technical key","example":"department","type":"string","x-go-name":"Key"},"validations":{"description":"FormElementValidationsSet is a set of FormElementValidation items","example":[{"validationType":"REQUIRED"}],"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormElements"},"formInput":{"description":"FormInput is a list of form inputs that are required when creating a form-instance object","items":{"properties":{"description":{"description":"Description is the description for this form input value","example":"A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic","type":"string","x-go-name":"Description"},"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"label":{"description":"Label is the name for this form input value","example":"input1","type":"string","x-go-name":"Label"},"type":{"description":"Type is a FormDefinitionInputType value\nSTRING FormDefinitionInputTypeString","enum":["STRING"],"example":"STRING","type":"string","x-go-enum-desc":"STRING FormDefinitionInputTypeString","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormInput"},"id":{"description":"FormDefinitionID is a unique guid identifying this form definition","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"FormDefinitionID"},"modified":{"description":"Modified is the last date the form definition was modified","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Modified"},"name":{"description":"Name is the form definition name","example":"My form","type":"string","x-go-name":"Name"},"owner":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a FormOwnerType value\nIDENTITY FormOwnerTypeIdentity","enum":["IDENTITY"],"example":"IDENTITY","type":"string","x-go-enum-desc":"IDENTITY FormOwnerTypeIdentity","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"usedBy":{"description":"UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used","items":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a FormUsedByType value\nWORKFLOW FormUsedByTypeWorkflow\nSOURCE FormUsedByTypeSource","enum":["WORKFLOW","SOURCE"],"example":"WORKFLOW","type":"string","x-go-enum-desc":"WORKFLOW FormUsedByTypeWorkflow\nSOURCE FormUsedByTypeSource","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"UsedBy"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}}}},"400":{"description":"An error with the request occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"401":{"description":"An error with the authorization occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"403":{"description":"An error with the user permissions occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"title":"Error is the standard API error response type.","type":"object","properties":{"detailCode":{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"trackingId":{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"}}}},"500":{"description":"An internal server error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}}},"security":[{"oauth2":["sp:forms:manage"]}],"x-codegen-request-body-name":"Body","description":"Creates a form definition.","method":"post","path":"/form-definitions","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"description":"My form description","formConditions":[{"effects":[{"config":{},"effectType":"HIDE"}],"ruleOperator":"AND","rules":[{"operator":"EQ","source":"department","sourceType":"ELEMENT","value":"Engineering","valueType":"STRING"}]}],"formElements":[{"config":{"label":"Department"},"elementType":"TEXT","id":"00000000-0000-0000-0000-000000000000","key":"department","validations":[{"validationType":"REQUIRED"}]}],"formInput":[{"description":"A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic","id":"00000000-0000-0000-0000-000000000000","label":"input1","type":"STRING"}],"name":"My form","owner":{"id":"00000000-0000-0000-0000-000000000000","type":"IDENTITY"},"usedBy":[{"id":"00000000-0000-0000-0000-000000000000","type":"WORKFLOW"}]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Creates a form definition.","description":{"type":"text/plain"},"url":{"path":["form-definitions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Creates a form definition.' (create-form-definition)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Creates a form definition. + + + +Creates a form definition. + +
Request Body
+ +Body is the request payload to create form definition request + +
    formConditions object[]
    + +FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form + +
    effects object[]
    + +Effects is a list of effects + +
    config object
    + +Config is a arbitrary map that holds a configuration based on EffectType + +
    rules object[]
    + +Rules is a list of rules + +
    formElements object[]
    + +FormElements is a list of nested form elements + +
    config object
    + +Config is a config object + +
    formInput object[]
    + +FormInput is a list of form inputs that are required when creating a form-instance object + +
    owner object required
    usedBy object[]
    + +UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used + +
+ +Returns a new form definition + +
Schema
    formConditions object[]
    + +FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form + +
    effects object[]
    + +Effects is a list of effects + +
    config object
    + +Config is a arbitrary map that holds a configuration based on EffectType + +
    rules object[]
    + +Rules is a list of rules + +
    formElements object[]
    + +FormElements is a list of nested form elements + +
    config object
    + +Config is a config object + +
    formInput object[]
    + +FormInput is a list of form inputs that are required when creating a form-instance object + +
    owner object
    usedBy object[]
    + +UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used + +
+ +An error with the request occurred + +
Schema
    messages object[]
+ +An error with the authorization occurred + +
Schema
    messages object[]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
+ +Too many requests + +
Schema
    messages object[]
+ +An internal server error occurred + +
Schema
    messages object[]
\ No newline at end of file diff --git a/products/idn/api/beta/create-form-instance.api.mdx b/products/idn/api/beta/create-form-instance.api.mdx new file mode 100644 index 000000000..5dffc8085 --- /dev/null +++ b/products/idn/api/beta/create-form-instance.api.mdx @@ -0,0 +1,107 @@ +--- +id: create-form-instance +sidebar_label: Creates a form instance. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Custom Forms"],"operationId":"createFormInstance","requestBody":{"description":"Body is the request payload to create a form instance","content":{"application/json":{"schema":{"properties":{"createdBy":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a form instance created by type enum value\nWORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution\nSOURCE FormInstanceCreatedByTypeSource","enum":["WORKFLOW_EXECUTION","SOURCE"],"example":"WORKFLOW_EXECUTION","type":"string","x-go-enum-desc":"WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution\nSOURCE FormInstanceCreatedByTypeSource","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"expire":{"description":"Expire is required","example":"2023-08-12T20:14:57.74486Z","type":"string","x-go-name":"Expire"},"formDefinitionId":{"description":"FormDefinitionID is the id of the form definition that created this form","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"FormDefinitionID"},"formInput":{"additionalProperties":{},"description":"FormInput is an object of form input labels to value","example":{"input1":"Sales"},"type":"object","x-go-name":"FormInput"},"recipients":{"description":"Recipients is required","items":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a FormInstanceRecipientType value\nIDENTITY FormInstanceRecipientIdentity","enum":["IDENTITY"],"example":"IDENTITY","type":"string","x-go-enum-desc":"IDENTITY FormInstanceRecipientIdentity","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Recipients"},"standAloneForm":{"default":false,"description":"StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form","example":false,"type":"boolean","x-go-name":"StandAloneForm"},"state":{"description":"State is required, if not present initial state is FormInstanceStateAssigned\nASSIGNED FormInstanceStateAssigned\nIN_PROGRESS FormInstanceStateInProgress\nSUBMITTED FormInstanceStateSubmitted\nCOMPLETED FormInstanceStateCompleted\nCANCELLED FormInstanceStateCancelled","enum":["ASSIGNED","IN_PROGRESS","SUBMITTED","COMPLETED","CANCELLED"],"example":"ASSIGNED","type":"string","x-go-enum-desc":"ASSIGNED FormInstanceStateAssigned\nIN_PROGRESS FormInstanceStateInProgress\nSUBMITTED FormInstanceStateSubmitted\nCOMPLETED FormInstanceStateCompleted\nCANCELLED FormInstanceStateCancelled","x-go-name":"State"},"ttl":{"description":"TTL an epoch timestamp in seconds, it most be in seconds or dynamodb will ignore it\nSEE: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-before-you-start.html","example":1571827560,"format":"int64","type":"integer","x-go-name":"TTL"}},"required":["expire","recipients","createdBy","formDefinitionId"],"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"example":{"expire":"2023-06-20T15:57:55.332882Z","formDefinitionId":"00000000-0000-0000-0000-000000000000","recipients":[{"type":"IDENTITY","id":"an-identity-id"}],"createdBy":{"type":"WORKFLOW_EXECUTION","id":"a-workflow-execution-id"}}}},"required":false},"responses":{"201":{"description":"Returns a new form instance","content":{"application/json":{"schema":{"properties":{"created":{"description":"Created is the date the form instance was assigned","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Created"},"createdBy":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a form instance created by type enum value\nWORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution\nSOURCE FormInstanceCreatedByTypeSource","enum":["WORKFLOW_EXECUTION","SOURCE"],"example":"WORKFLOW_EXECUTION","type":"string","x-go-enum-desc":"WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution\nSOURCE FormInstanceCreatedByTypeSource","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"expire":{"description":"Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record","example":"2023-08-12T20:14:57.74486Z","type":"string","x-go-name":"Expire"},"formConditions":{"description":"FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form","items":{"description":"FormCondition represent a form conditional","properties":{"effects":{"description":"Effects is a list of effects","items":{"description":"ConditionEffect is the effect produced by a condition","properties":{"config":{"additionalProperties":{},"description":"Config is a arbitrary map that holds a configuration based on EffectType","example":{},"type":"object","x-go-name":"Config"},"effectType":{"description":"EffectType is the type of effect to perform when the conditions are evaluated for this logic block\nHIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","enum":["HIDE","SHOW","DISABLE","ENABLE","REQUIRE","OPTIONAL","SUBMIT_MESSAGE","SUBMIT_NOTIFICATION","SET_DEFAULT_VALUE"],"example":"HIDE","type":"string","x-go-enum-desc":"HIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","x-go-name":"EffectType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Effects"},"ruleOperator":{"description":"RuleOperator is a ConditionRuleLogicalOperatorType value\nAND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","enum":["AND","OR"],"example":"AND","type":"string","x-go-enum-desc":"AND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","x-go-name":"RuleOperator"},"rules":{"description":"Rules is a list of rules","items":{"properties":{"operator":{"description":"Operator is a ConditionRuleComparisonOperatorType value\nEQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","enum":["EQ","NE","CO","NOT_CO","IN","NOT_IN","EM","NOT_EM","SW","NOT_SW","EW","NOT_EW"],"example":"EQ","type":"string","x-go-enum-desc":"EQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","x-go-name":"Operator"},"source":{"description":"Source, if the sourceType is ConditionRuleSourceTypeInput then the source type is the name of the form input to accept. While if the sourceType is ConditionRuleSourceTypeElement\nthen source is the name of a technical key of an element to retrieve its value","example":"department","type":"string","x-go-name":"Source"},"sourceType":{"description":"SourceType defines what type of object is being selected. Either a reference to a form input (by input name), or a form element (by technical key)\nINPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","enum":["INPUT","ELEMENT"],"example":"ELEMENT","type":"string","x-go-enum-desc":"INPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","x-go-name":"SourceType"},"value":{"description":"Value is the value based on the ValueType","example":"Engineering","x-go-name":"Value"},"valueType":{"description":"ValueType is a ConditionRuleValueType type\nSTRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","enum":["STRING","STRING_LIST","INPUT","ELEMENT","LIST","BOOLEAN"],"example":"STRING","type":"string","x-go-enum-desc":"STRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","x-go-name":"ValueType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Rules"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormConditions"},"formData":{"additionalProperties":{},"description":"FormData is the data provided by the form on submit. The data is in a key -> value map","example":{"department":"Engineering"},"type":"object","x-go-name":"FormData"},"formDefinitionId":{"description":"FormDefinitionID is the id of the form definition that created this form","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"FormDefinitionID"},"formElements":{"description":"FormElements is the configuration of the form, this would be a repeat of the fields from the form-config","items":{"properties":{"config":{"additionalProperties":{},"description":"Config is a config object","example":{"label":"Department"},"type":"object","x-go-name":"Config"},"elementType":{"description":"ElementType is a FormElementType value\nTEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","enum":["TEXT","TOGGLE","TEXTAREA","HIDDEN","PHONE","EMAIL","SELECT","DATE","SECTION","COLUMNS"],"example":"TEXT","type":"string","x-go-enum-desc":"TEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","x-go-name":"ElementType"},"id":{"description":"ID is a form element identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"key":{"description":"Key is the technical key","example":"department","type":"string","x-go-name":"Key"},"validations":{"description":"FormElementValidationsSet is a set of FormElementValidation items","example":[{"validationType":"REQUIRED"}],"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormElements"},"formErrors":{"description":"FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors","items":{"properties":{"key":{"description":"Key is the technical key","example":"department","type":"string","x-go-name":"Key"},"messages":{"description":"Messages is a list of web.ErrorMessage items","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"type":"array","x-go-name":"Messages"},"value":{"description":"Value is the value associated with a Key","example":"Engineering","x-go-name":"Value"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormErrors"},"formInput":{"additionalProperties":{},"description":"FormInput is an object of form input labels to value","example":{"input1":"Sales"},"type":"object","x-go-name":"FormInput"},"id":{"description":"FormInstanceID is a unique guid identifying this form instance","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"FormInstanceID"},"modified":{"description":"Modified is the last date the form instance was modified","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Modified"},"recipients":{"description":"Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it","items":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a FormInstanceRecipientType value\nIDENTITY FormInstanceRecipientIdentity","enum":["IDENTITY"],"example":"IDENTITY","type":"string","x-go-enum-desc":"IDENTITY FormInstanceRecipientIdentity","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Recipients"},"standAloneForm":{"default":false,"description":"StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form","example":false,"type":"boolean","x-go-name":"StandAloneForm"},"standAloneFormUrl":{"description":"StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI","example":"https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"StandAloneFormURL"},"state":{"description":"State the state of the form instance\nASSIGNED FormInstanceStateAssigned\nIN_PROGRESS FormInstanceStateInProgress\nSUBMITTED FormInstanceStateSubmitted\nCOMPLETED FormInstanceStateCompleted\nCANCELLED FormInstanceStateCancelled","enum":["ASSIGNED","IN_PROGRESS","SUBMITTED","COMPLETED","CANCELLED"],"example":"ASSIGNED","type":"string","x-go-enum-desc":"ASSIGNED FormInstanceStateAssigned\nIN_PROGRESS FormInstanceStateInProgress\nSUBMITTED FormInstanceStateSubmitted\nCOMPLETED FormInstanceStateCompleted\nCANCELLED FormInstanceStateCancelled","x-go-name":"State"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}}}},"400":{"description":"An error with the request occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"401":{"description":"An error with the authorization occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"403":{"description":"An error with the user permissions occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"title":"Error is the standard API error response type.","type":"object","properties":{"detailCode":{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"trackingId":{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"}}}},"500":{"description":"An internal server error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}}},"security":[{"oauth2":["sp:forms:manage"]}],"x-codegen-request-body-name":"Body","description":"Creates a form instance.","method":"post","path":"/form-instances","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"createdBy":{"id":"00000000-0000-0000-0000-000000000000","type":"WORKFLOW_EXECUTION"},"expire":"2023-08-12T20:14:57.74486Z","formDefinitionId":"00000000-0000-0000-0000-000000000000","formInput":{"input1":"Sales"},"recipients":[{"id":"00000000-0000-0000-0000-000000000000","type":"IDENTITY"}],"standAloneForm":false,"state":"ASSIGNED","ttl":1571827560},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Creates a form instance.","description":{"type":"text/plain"},"url":{"path":["form-instances"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Creates a form instance.' (create-form-instance)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Creates a form instance. + + + +Creates a form instance. + +
Request Body
+ +Body is the request payload to create a form instance + +
    createdBy object required
    formInput object
    + +FormInput is an object of form input labels to value + +
    recipients object[] required
    + +Recipients is required + +
+ +Returns a new form instance + +
Schema
    createdBy object
    formConditions object[]
    + +FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form + +
    effects object[]
    + +Effects is a list of effects + +
    config object
    + +Config is a arbitrary map that holds a configuration based on EffectType + +
    rules object[]
    + +Rules is a list of rules + +
    formData object
    + +FormData is the data provided by the form on submit. The data is in a key -\> value map + +
    formElements object[]
    + +FormElements is the configuration of the form, this would be a repeat of the fields from the form-config + +
    config object
    + +Config is a config object + +
    formErrors object[]
    + +FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors + +
    messages object[]
    + +Messages is a list of web.ErrorMessage items + +
    formInput object
    + +FormInput is an object of form input labels to value + +
    recipients object[]
    + +Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it + +
+ +An error with the request occurred + +
Schema
    messages object[]
+ +An error with the authorization occurred + +
Schema
    messages object[]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
+ +Too many requests + +
Schema
    messages object[]
+ +An internal server error occurred + +
Schema
    messages object[]
\ No newline at end of file diff --git a/products/idn/api/beta/create-identity-profile.api.mdx b/products/idn/api/beta/create-identity-profile.api.mdx new file mode 100644 index 000000000..ac0954e6e --- /dev/null +++ b/products/idn/api/beta/create-identity-profile.api.mdx @@ -0,0 +1,108 @@ +--- +id: create-identity-profile +sidebar_label: Create an Identity Profile +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createIdentityProfile","description":"This creates an Identity Profile\nA token with ORG_ADMIN authority is required to call this API to create an Identity Profile.","tags":["Identity Profiles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"},"modified":{"description":"Last modification date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}},{"type":"object","required":["authoritativeSource"],"properties":{"description":{"type":"string","nullable":true,"description":"The description of the Identity Profile.","example":"My custom flat file profile"},"owner":{"type":"object","description":"The owner of the Identity Profile.","nullable":true,"properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Type of the object to which this reference applies","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"priority":{"type":"integer","format":"int64","description":"The priority for an Identity Profile.","example":10},"authoritativeSource":{"type":"object","properties":{"type":{"type":"string","enum":["SOURCE"],"description":"Type of the object to which this reference applies","example":"SOURCE"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"HR Active Directory"}},"description":"The authoritative source for this Identity Profile."},"identityRefreshRequired":{"type":"boolean","default":false,"description":"True if a identity refresh is needed. Typically triggered when a change on the source has been made","example":true},"identityCount":{"type":"integer","description":"The number of identities that belong to the Identity Profile.","format":"int32","example":8},"identityAttributeConfig":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If the profile or mapping is enabled","example":true,"default":true},"attributeTransforms":{"type":"array","items":{"type":"object","properties":{"identityAttributeName":{"type":"string","description":"Name of the identity attribute","example":"email"},"transformDefinition":{"description":"The seaspray transformation definition","type":"object","properties":{"type":{"type":"string","description":"The type of the transform definition.","example":"accountAttribute"},"attributes":{"type":"object","nullable":true,"additionalProperties":true,"description":"Arbitrary key-value pairs to store any metadata for the object","example":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}}}}}}}}},"identityExceptionReportReference":{"type":"object","nullable":true,"properties":{"taskResultId":{"type":"string","format":"uuid","description":"The id of the task result","example":"2c918086795cd09201795d5f7d7533df"},"reportName":{"type":"string","example":"My annual report","description":"The name of the report"}}},"hasTimeBasedAttr":{"description":"Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile.","type":"boolean","default":true,"example":true}}}]}}}},"responses":{"201":{"description":"The created Identity Profile","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"},"modified":{"description":"Last modification date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}},{"type":"object","required":["authoritativeSource"],"properties":{"description":{"type":"string","nullable":true,"description":"The description of the Identity Profile.","example":"My custom flat file profile"},"owner":{"type":"object","description":"The owner of the Identity Profile.","nullable":true,"properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Type of the object to which this reference applies","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"priority":{"type":"integer","format":"int64","description":"The priority for an Identity Profile.","example":10},"authoritativeSource":{"type":"object","properties":{"type":{"type":"string","enum":["SOURCE"],"description":"Type of the object to which this reference applies","example":"SOURCE"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"HR Active Directory"}},"description":"The authoritative source for this Identity Profile."},"identityRefreshRequired":{"type":"boolean","default":false,"description":"True if a identity refresh is needed. Typically triggered when a change on the source has been made","example":true},"identityCount":{"type":"integer","description":"The number of identities that belong to the Identity Profile.","format":"int32","example":8},"identityAttributeConfig":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If the profile or mapping is enabled","example":true,"default":true},"attributeTransforms":{"type":"array","items":{"type":"object","properties":{"identityAttributeName":{"type":"string","description":"Name of the identity attribute","example":"email"},"transformDefinition":{"description":"The seaspray transformation definition","type":"object","properties":{"type":{"type":"string","description":"The type of the transform definition.","example":"accountAttribute"},"attributes":{"type":"object","nullable":true,"additionalProperties":true,"description":"Arbitrary key-value pairs to store any metadata for the object","example":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}}}}}}}}},"identityExceptionReportReference":{"type":"object","nullable":true,"properties":{"taskResultId":{"type":"string","format":"uuid","description":"The id of the task result","example":"2c918086795cd09201795d5f7d7533df"},"reportName":{"type":"string","example":"My annual report","description":"The name of the report"}}},"hasTimeBasedAttr":{"description":"Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile.","type":"boolean","default":true,"example":true}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:identity-profile:manage"]}],"method":"post","path":"/identity-profiles","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"aName","description":"My custom flat file profile","owner":{"type":"IDENTITY","id":"2c9180835d191a86015d28455b4b232a","name":"William Wilson"},"priority":10,"authoritativeSource":{"type":"SOURCE","id":"2c9180835d191a86015d28455b4b232a","name":"HR Active Directory"},"identityRefreshRequired":true,"identityCount":8,"identityAttributeConfig":{"enabled":true,"attributeTransforms":[{"identityAttributeName":"email","transformDefinition":{"type":"accountAttribute","attributes":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}}}]},"identityExceptionReportReference":{"taskResultId":"2c918086795cd09201795d5f7d7533df","reportName":"My annual report"},"hasTimeBasedAttr":true},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create an Identity Profile","description":{"content":"This creates an Identity Profile\nA token with ORG_ADMIN authority is required to call this API to create an Identity Profile.","type":"text/plain"},"url":{"path":["identity-profiles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create an Identity Profile' (create-identity-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## 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. + +
Request Body required
    owner object
    + +The owner of the Identity Profile. + +
    authoritativeSource object required
    + +The authoritative source for this Identity Profile. + +
    identityAttributeConfig object
    attributeTransforms object[]
    transformDefinition object
    + +The seaspray transformation definition + +
    attributes object
    + +Arbitrary key-value pairs to store any metadata for the object + +
    identityExceptionReportReference object
+ +The created Identity Profile + +
Schema
    owner object
    + +The owner of the Identity Profile. + +
    authoritativeSource object
    + +The authoritative source for this Identity Profile. + +
    identityAttributeConfig object
    attributeTransforms object[]
    transformDefinition object
    + +The seaspray transformation definition + +
    attributes object
    + +Arbitrary key-value pairs to store any metadata for the object + +
    identityExceptionReportReference object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-non-employee-record.api.mdx b/products/idn/api/beta/create-non-employee-record.api.mdx new file mode 100644 index 000000000..b6b929fb8 --- /dev/null +++ b/products/idn/api/beta/create-non-employee-record.api.mdx @@ -0,0 +1,89 @@ +--- +id: create-non-employee-record +sidebar_label: Create Non-Employee Record +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createNonEmployeeRecord","security":[{"oauth2":["idn:nelm:manage"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This request will create a non-employee record.\nRequest will require the following security scope:\n'idn:nesr:create'","requestBody":{"description":"Non-Employee record creation request body.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accountName":{"type":"string","description":"Requested identity account name.","example":"william.smith"},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"sourceId":{"type":"string","description":"Non-Employee's source id.","example":"2c91808568c529c60168cca6f90c1313"},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported."},"startDate":{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2020-03-24T00:00:00-05:00"},"endDate":{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2021-03-25T00:00:00-05:00"}},"required":["accountName","firstName","lastName","email","phone","manager","sourceId","startDate","endDate"]}}}},"responses":{"200":{"description":"Created non-employee record.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee record id."},"accountName":{"type":"string","description":"Requested identity account name."},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"sourceId":{"type":"string","description":"Non-Employee's source id.","example":"2c91808568c529c60168cca6f90c1313"},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee."},"startDate":{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2019-08-23T18:52:59.162Z"},"endDate":{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2020-08-23T18:52:59.162Z"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/non-employee-records","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"accountName":"william.smith","firstName":"William","lastName":"Smith","email":"william.smith@example.com","phone":"5555555555","manager":"jane.doe","sourceId":"2c91808568c529c60168cca6f90c1313","data":{},"startDate":"2020-03-24T00:00:00-05:00","endDate":"2021-03-25T00:00:00-05:00"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create Non-Employee Record","description":{"content":"This request will create a non-employee record.\nRequest will require the following security scope:\n'idn:nesr:create'","type":"text/plain"},"url":{"path":["non-employee-records"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Non-Employee Record' (create-non-employee-record)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Non-Employee Record + + + +This request will create a non-employee record. +Request will require the following security scope: +'idn:nesr:create' + +
Request Body required
+ +Non-Employee record creation request body. + +
    data object
    + +Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported. + +
  • property name* string
+ +Created non-employee record. + +
Schema
    data object
    + +Attribute blob/bag for a non-employee. + +
  • property name* string
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-non-employee-request.api.mdx b/products/idn/api/beta/create-non-employee-request.api.mdx new file mode 100644 index 000000000..5c4697193 --- /dev/null +++ b/products/idn/api/beta/create-non-employee-request.api.mdx @@ -0,0 +1,95 @@ +--- +id: create-non-employee-request +sidebar_label: Create Non-Employee Request +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createNonEmployeeRequest","security":[{"oauth2":["idn:nelm:manage"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This request will create a non-employee request and notify the approver","requestBody":{"description":"Non-Employee creation request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accountName":{"type":"string","description":"Requested identity account name.","example":"william.smith"},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"sourceId":{"type":"string","description":"Non-Employee's source id.","example":"2c91808568c529c60168cca6f90c1313"},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported."},"startDate":{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2020-03-24T00:00:00-05:00"},"endDate":{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2021-03-25T00:00:00-05:00"}},"required":["accountName","firstName","lastName","email","phone","manager","sourceId","startDate","endDate"]}}}},"responses":{"200":{"description":"Non-Employee request creation object","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"},"sourceId":{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"},"description":{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}},{"type":"object","properties":{"accountName":{"type":"string","description":"Requested identity account name.","example":"william.smith"},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"nonEmployeeSource":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"},"sourceId":{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"},"description":{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee."},"approvalItems":{"description":"List of approval item for the request","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee approval item id","example":"2c1e388b-1e55-4b0a-ab5c-897f1204159c"},"approver":{"description":"Reference to the associated Identity","type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}},"accountName":{"type":"string","description":"Requested identity account name","example":"test.account"},"approvalStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status"},"approvalOrder":{"type":"number","description":"Approval order","example":1},"comment":{"type":"string","description":"comment of approver"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}}},"approvalStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status"},"comment":{"type":"string","description":"comment of requester"},"completionDate":{"type":"string","format":"date-time","description":"When the request was completely approved.","example":"2020-03-24T11:11:41.139-05:00"},"startDate":{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2020-03-24T00:00:00-05:00"},"endDate":{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2021-03-25T00:00:00-05:00"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2020-03-24T11:11:41.139-05:00"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2020-03-24T11:11:41.139-05:00"}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"400.1 Bad Request Content":{"description":"Response for bad request content","value":{"detailCode":"400.1 Bad Request Content","trackingId":"e7eab60924f64aa284175b9fa3309599","messages":[{"locale":"en","localeOrigin":"REQUEST","text":"firstName is required; accountName is required;"}]}},"400.1.409 Reference conflict":{"description":"Response for reference conflict","value":{"detailCode":"400.1.409 Reference conflict","trackingId":"e7eab60924f64aa284175b9fa3309599","messages":[{"locale":"en","localeOrigin":"REQUEST","text":"Unable to create Non-Employee because the accountName \"existed\" is already being used."}]}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/non-employee-requests","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"accountName":"william.smith","firstName":"William","lastName":"Smith","email":"william.smith@example.com","phone":"5555555555","manager":"jane.doe","sourceId":"2c91808568c529c60168cca6f90c1313","data":{},"startDate":"2020-03-24T00:00:00-05:00","endDate":"2021-03-25T00:00:00-05:00"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create Non-Employee Request","description":{"content":"This request will create a non-employee request and notify the approver","type":"text/plain"},"url":{"path":["non-employee-requests"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Non-Employee Request' (create-non-employee-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Non-Employee Request + + + +This request will create a non-employee request and notify the approver + +
Request Body required
+ +Non-Employee creation request body + +
    data object
    + +Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported. + +
  • property name* string
+ +Non-Employee request creation object + +
Schema
    nonEmployeeSource object
    data object
    + +Attribute blob/bag for a non-employee. + +
  • property name* string
    • approvalItems object[]
    + +List of approval item for the request + +
    approver object
    + +Reference to the associated Identity + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-non-employee-source-schema-attributes.api.mdx b/products/idn/api/beta/create-non-employee-source-schema-attributes.api.mdx new file mode 100644 index 000000000..9eda19628 --- /dev/null +++ b/products/idn/api/beta/create-non-employee-source-schema-attributes.api.mdx @@ -0,0 +1,75 @@ +--- +id: create-non-employee-source-schema-attributes +sidebar_label: Create Non-Employee Source Schema Attribute +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createNonEmployeeSourceSchemaAttributes","security":[{"oauth2":["idn:nelm:manage"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response.","parameters":[{"in":"path","name":"sourceId","schema":{"type":"string"},"required":true,"example":"2c91808b6ef1d43e016efba0ce470904","description":"The Source id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Type of the attribute. Only type 'TEXT' is supported for custom attributes.","example":"TEXT"},"label":{"type":"string","description":"Label displayed on the UI for this schema attribute.","example":"Account Name"},"technicalName":{"type":"string","description":"The technical name of the attribute. Must be unique per source.","example":"account.name"},"helpText":{"type":"string","description":"help text displayed by UI.","example":"The unique identifier for the account"},"placeholder":{"type":"string","description":"Hint text that fills UI box.","example":"Enter a unique user name for this account."},"required":{"type":"boolean","description":"If true, the schema attribute is required for all non-employees in the source","example":true}},"required":["type","technicalName","label"]}}}},"responses":{"200":{"description":"Schema Attribute created.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"UUID","example":"ac110005-7156-1150-8171-5b292e3e0084","description":"Schema Attribute Id"},"system":{"type":"boolean","description":"True if this schema attribute is mandatory on all non-employees sources.","example":true},"modified":{"type":"string","format":"date-time","description":"When the schema attribute was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the schema attribute was created.","example":"2019-08-23T18:40:35.772Z"},"type":{"type":"string","enum":["TEXT","DATE","IDENTITY"],"description":"Enum representing the type of data a schema attribute accepts."},"label":{"type":"string","description":"Label displayed on the UI for this schema attribute.","example":"Account Name"},"technicalName":{"type":"string","description":"The technical name of the attribute. Must be unique per source.","example":"account.name"},"helpText":{"type":"string","description":"help text displayed by UI.","example":"The unique identifier for the account"},"placeholder":{"type":"string","description":"Hint text that fills UI box.","example":"Enter a unique user name for this account."},"required":{"type":"boolean","description":"If true, the schema attribute is required for all non-employees in the source","example":true}},"required":["type","technicalName","label"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/non-employee-sources/{sourceId}/schema-attributes","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"type":"TEXT","label":"Account Name","technicalName":"account.name","helpText":"The unique identifier for the account","placeholder":"Enter a unique user name for this account.","required":true},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create Non-Employee Source Schema Attribute","description":{"content":"This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response.","type":"text/plain"},"url":{"path":["non-employee-sources",":sourceId","schema-attributes"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Non-Employee Source Schema Attribute' (create-non-employee-source-schema-attributes)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Non-Employee Source Schema Attribute + + + +This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. + +
Path Parameters
Request Body required
+ +Schema Attribute created. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-non-employee-source.api.mdx b/products/idn/api/beta/create-non-employee-source.api.mdx new file mode 100644 index 000000000..cea515de2 --- /dev/null +++ b/products/idn/api/beta/create-non-employee-source.api.mdx @@ -0,0 +1,109 @@ +--- +id: create-non-employee-source +sidebar_label: Create Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createNonEmployeeSource","security":[{"oauth2":["idn:nelm:manage"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This request will create a non-employee source.\nRequest will require the following security scope:\n'idn:nesr:create'","requestBody":{"description":"Non-Employee source creation request body.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of non-employee source.","example":"Retail"},"description":{"type":"string","description":"Description of non-employee source.","example":"Source description"},"owner":{"description":"Owner of non-employee source.","type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Identity id.","example":"2c91808570313110017040b06f344ec9"}},"required":["id"]},"managementWorkgroup":{"type":"string","description":"The ID for the management workgroup that contains source sub-admins","example":"123299"},"approvers":{"description":"List of approvers.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Identity id.","example":"2c91808570313110017040b06f344ec9"}},"required":["id"]},"maxItems":3},"accountManagers":{"description":"List of account managers.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Identity id.","example":"2c91808570313110017040b06f344ec9"}},"required":["id"]},"maxItems":10}},"required":["owner","name","description"]}}}},"responses":{"200":{"description":"Created non-employee source.","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"},"sourceId":{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"},"description":{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}},{"type":"object","properties":{"approvers":{"description":"List of approvers","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}}},"accountManagers":{"description":"List of account managers","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}}},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"},"nonEmployeeCount":{"nullable":true,"type":"integer","description":"The number of non-employee records on all sources that *requested-for* user manages.","example":2,"format":"int32"}}}]},{"type":"object","properties":{"cloudExternalId":{"type":"string","description":"Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present.","example":"99999"}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/non-employee-sources","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"Retail","description":"Source description","owner":{"id":"2c91808570313110017040b06f344ec9"},"managementWorkgroup":"123299","approvers":[{"id":"2c91808570313110017040b06f344ec9"}],"accountManagers":[{"id":"2c91808570313110017040b06f344ec9"}]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create Non-Employee Source","description":{"content":"This request will create a non-employee source.\nRequest will require the following security scope:\n'idn:nesr:create'","type":"text/plain"},"url":{"path":["non-employee-sources"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Non-Employee Source' (create-non-employee-source)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Non-Employee Source + + + +This request will create a non-employee source. +Request will require the following security scope: +'idn:nesr:create' + +
Request Body required
+ +Non-Employee source creation request body. + +
    owner object required
    + +Owner of non-employee source. + +
    approvers object[]
    + +**Possible values:** `<= 3` + +
    + +List of approvers. + +
    accountManagers object[]
    + +**Possible values:** `<= 10` + +
    + +List of account managers. + +
+ +Created non-employee source. + +
Schema
    approvers object[]
    + +List of approvers + +
    accountManagers object[]
    + +List of account managers + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-notification-template.api.mdx b/products/idn/api/beta/create-notification-template.api.mdx new file mode 100644 index 000000000..cf1c983c0 --- /dev/null +++ b/products/idn/api/beta/create-notification-template.api.mdx @@ -0,0 +1,77 @@ +--- +id: create-notification-template +sidebar_label: Create Notification Template +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createNotificationTemplate","tags":["Notifications"],"description":"This creates a template for your site. \n\nYou can also use this endpoint to update a template. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","example":"cloud_manual_work_item_summary"},"name":{"type":"string","example":"Task Manager Subscription"},"medium":{"type":"string","description":"The message medium. More mediums may be added in the future.","enum":["EMAIL","PHONE","SMS","SLACK","TEAMS"],"example":"EMAIL"},"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en"},"subject":{"type":"string","example":"You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}."},"header":{"type":"string","example":"Dear $__recipient.name,"},"body":{"type":"string","example":"Please go to the task manager"},"footer":{"type":"string","example":"Thanks, The $__global.productName Team"},"from":{"type":"string","example":"$__global.emailFromAddress"},"replyTo":{"type":"string","example":"$__global.emailFromAddress"},"description":{"type":"string","example":"Daily digest - sent if number of outstanding tasks for task owner > 0"},"id":{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b","description":"This is auto-generated."},"created":{"type":"string","format":"date-time","description":"The time when this template is created. This is auto-generated.","example":"2020-01-01T00:00:00.000000Z"},"modified":{"type":"string","format":"date-time","description":"The time when this template was last modified. This is auto-generated.","example":"2020-01-01T00:00:00.000000Z"}},"required":["key","medium","locale"]}}}},"responses":{"200":{"description":"A template object for your site","content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","example":"cloud_manual_work_item_summary"},"name":{"type":"string","example":"Task Manager Subscription"},"medium":{"type":"string","description":"The message medium. More mediums may be added in the future.","enum":["EMAIL","PHONE","SMS","SLACK","TEAMS"],"example":"EMAIL"},"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en"},"subject":{"type":"string","example":"You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}."},"header":{"type":"string","example":"Dear $__recipient.name,"},"body":{"type":"string","example":"Please go to the task manager"},"footer":{"type":"string","example":"Thanks, The $__global.productName Team"},"from":{"type":"string","example":"$__global.emailFromAddress"},"replyTo":{"type":"string","example":"$__global.emailFromAddress"},"description":{"type":"string","example":"Daily digest - sent if number of outstanding tasks for task owner > 0"},"id":{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b","description":"This is auto-generated."},"created":{"type":"string","format":"date-time","description":"The time when this template is created. This is auto-generated.","example":"2020-01-01T00:00:00.000000Z"},"modified":{"type":"string","format":"date-time","description":"The time when this template was last modified. This is auto-generated.","example":"2020-01-01T00:00:00.000000Z"}},"required":["key","medium","locale"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/notification-templates","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"key":"cloud_manual_work_item_summary","name":"Task Manager Subscription","medium":"EMAIL","locale":"en","subject":"You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.","header":"Dear $__recipient.name,","body":"Please go to the task manager","footer":"Thanks, The $__global.productName Team","from":"$__global.emailFromAddress","replyTo":"$__global.emailFromAddress","description":"Daily digest - sent if number of outstanding tasks for task owner > 0","id":"c17bea3a-574d-453c-9e04-4365fbf5af0b","created":"2020-01-01T00:00:00.000000Z","modified":"2020-01-01T00:00:00.000000Z"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create Notification Template","description":{"content":"This creates a template for your site. \n\nYou can also use this endpoint to update a template. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready.","type":"text/plain"},"url":{"path":["notification-templates"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Notification Template' (create-notification-template)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Notification Template + + + +This creates a template for your site. + +You can also use this endpoint to update a template. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. + +
Request Body required
+ +A template object for your site + +
Schema
 0\",\n \"id\": \"c17bea3a-574d-453c-9e04-4365fbf5af0b\",\n \"created\": \"2020-01-01T00:00:00.000000Z\",\n \"modified\": \"2020-01-01T00:00:00.000000Z\"\n}"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-oauth-client.api.mdx b/products/idn/api/beta/create-oauth-client.api.mdx new file mode 100644 index 000000000..0a6728685 --- /dev/null +++ b/products/idn/api/beta/create-oauth-client.api.mdx @@ -0,0 +1,75 @@ +--- +id: create-oauth-client +sidebar_label: Create OAuth Client +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createOauthClient","security":[{"oauth2":["sp:oauth-client:manage"]}],"tags":["OAuth Clients"],"description":"This creates an OAuth client.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"businessName":{"type":"string","nullable":true,"description":"The name of the business the API Client should belong to","example":"Acme-Solar"},"homepageUrl":{"type":"string","nullable":true,"description":"The homepage URL associated with the owner of the API Client","example":"http://localhost:12345"},"name":{"type":"string","nullable":true,"description":"A human-readable name for the API Client","example":"Demo API Client"},"description":{"type":"string","nullable":true,"description":"A description of the API Client","example":"An API client used for the authorization_code, refresh_token, and client_credentials flows"},"accessTokenValiditySeconds":{"type":"integer","format":"int32","description":"The number of seconds an access token generated for this API Client is valid for","example":750},"refreshTokenValiditySeconds":{"type":"integer","format":"int32","description":"The number of seconds a refresh token generated for this API Client is valid for","example":86400},"redirectUris":{"type":"array","nullable":true,"items":{"type":"string"},"description":"A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client.","example":["http://localhost:12345","http://localhost:67890"]},"grantTypes":{"type":"array","nullable":true,"items":{"description":"OAuth2 Grant Type","type":"string","example":"CLIENT_CREDENTIALS","enum":["CLIENT_CREDENTIALS","AUTHORIZATION_CODE","REFRESH_TOKEN"]},"description":"A list of OAuth 2.0 grant types this API Client can be used with","example":["AUTHORIZATION_CODE","CLIENT_CREDENTIALS","REFRESH_TOKEN"]},"accessType":{"description":"The access type (online or offline) of this API Client","example":"OFFLINE","type":"string","enum":["ONLINE","OFFLINE"]},"type":{"description":"The type of the API Client (public or confidential)","example":"CONFIDENTIAL","type":"string","enum":["CONFIDENTIAL","PUBLIC"]},"internal":{"type":"boolean","description":"An indicator of whether the API Client can be used for requests internal within the product.","example":false},"enabled":{"type":"boolean","description":"An indicator of whether the API Client is enabled for use","example":true},"strongAuthSupported":{"type":"boolean","description":"An indicator of whether the API Client supports strong authentication","example":false},"claimsSupported":{"type":"boolean","description":"An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow","example":false},"scope":{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the API Client. If no scope is specified, the client will be created with the default scope \"sp:scopes:all\". This means the API Client will have all the rights of the owner who created it.","example":["demo:api-client-scope:first","demo:api-client-scope:second"]}},"required":["name","description","accessTokenValiditySeconds","grantTypes","accessType","enabled"]}}}},"responses":{"200":{"description":"Request succeeded.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the OAuth client","example":"2c9180835d2e5168015d32f890ca1581"},"secret":{"type":"string","description":"Secret of the OAuth client (This field is only returned on the intial create call.)","example":"5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3"},"businessName":{"type":"string","description":"The name of the business the API Client should belong to","example":"Acme-Solar"},"homepageUrl":{"type":"string","description":"The homepage URL associated with the owner of the API Client","example":"http://localhost:12345"},"name":{"type":"string","description":"A human-readable name for the API Client","example":"Demo API Client"},"description":{"type":"string","description":"A description of the API Client","example":"An API client used for the authorization_code, refresh_token, and client_credentials flows"},"accessTokenValiditySeconds":{"type":"integer","format":"int32","description":"The number of seconds an access token generated for this API Client is valid for","example":750},"refreshTokenValiditySeconds":{"type":"integer","format":"int32","description":"The number of seconds a refresh token generated for this API Client is valid for","example":86400},"redirectUris":{"type":"array","items":{"type":"string"},"description":"A list of the approved redirect URIs used with the authorization_code flow","example":["http://localhost:12345"]},"grantTypes":{"type":"array","items":{"description":"OAuth2 Grant Type","type":"string","example":"CLIENT_CREDENTIALS","enum":["CLIENT_CREDENTIALS","AUTHORIZATION_CODE","REFRESH_TOKEN"]},"description":"A list of OAuth 2.0 grant types this API Client can be used with","example":["AUTHORIZATION_CODE","CLIENT_CREDENTIALS","REFRESH_TOKEN"]},"accessType":{"description":"The access type (online or offline) of this API Client","example":"OFFLINE","type":"string","enum":["ONLINE","OFFLINE"]},"type":{"description":"The type of the API Client (public or confidential)","example":"CONFIDENTIAL","type":"string","enum":["CONFIDENTIAL","PUBLIC"]},"internal":{"type":"boolean","description":"An indicator of whether the API Client can be used for requests internal to IDN","example":false},"enabled":{"type":"boolean","description":"An indicator of whether the API Client is enabled for use","example":true},"strongAuthSupported":{"type":"boolean","description":"An indicator of whether the API Client supports strong authentication","example":false},"claimsSupported":{"type":"boolean","description":"An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow","example":false},"created":{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when the API Client was created","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when the API Client was last updated","example":"2018-06-25T20:22:28.104Z"},"scope":{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the API Client.","example":["demo:api-client-scope:first","demo:api-client-scope:second"]}},"required":["id","secret","businessName","homepageUrl","name","description","accessTokenValiditySeconds","refreshTokenValiditySeconds","redirectUris","grantTypes","accessType","type","internal","enabled","strongAuthSupported","claimsSupported","created","modified","scope"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/oauth-clients","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"businessName":"Acme-Solar","homepageUrl":"http://localhost:12345","name":"Demo API Client","description":"An API client used for the authorization_code, refresh_token, and client_credentials flows","accessTokenValiditySeconds":750,"refreshTokenValiditySeconds":86400,"redirectUris":["http://localhost:12345","http://localhost:67890"],"grantTypes":["AUTHORIZATION_CODE","CLIENT_CREDENTIALS","REFRESH_TOKEN"],"accessType":"OFFLINE","type":"CONFIDENTIAL","internal":false,"enabled":true,"strongAuthSupported":false,"claimsSupported":false,"scope":["demo:api-client-scope:first","demo:api-client-scope:second"]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create OAuth Client","description":{"content":"This creates an OAuth client.","type":"text/plain"},"url":{"path":["oauth-clients"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create OAuth Client' (create-oauth-client)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create OAuth Client + + + +This creates an OAuth client. + +
Request Body required
+ +Request succeeded. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-password-org-config.api.mdx b/products/idn/api/beta/create-password-org-config.api.mdx new file mode 100644 index 000000000..ce4e35c32 --- /dev/null +++ b/products/idn/api/beta/create-password-org-config.api.mdx @@ -0,0 +1,75 @@ +--- +id: create-password-org-config +sidebar_label: Create Password Org Config +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createPasswordOrgConfig","tags":["Password Configuration"],"description":"This API creates the password org config. Unspecified fields will use default value. Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'","security":[{"oauth2":["idn:password-org-config:write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customInstructionsEnabled":{"type":"boolean","description":"Indicator whether custom password instructions feature is enabled. The default value is false.","default":false,"example":true},"digitTokenEnabled":{"type":"boolean","description":"Indicator whether \"digit token\" feature is enabled. The default value is false.","default":false,"example":true},"digitTokenDurationMinutes":{"type":"integer","format":"int32","description":"The duration of \"digit token\" in minutes. The default value is 5.","minimum":1,"maximum":60,"default":5,"example":10},"digitTokenLength":{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}},"example":{"customInstructionsEnabled":true,"digitTokenEnabled":true,"digitTokenDurationMinutes":12,"digitTokenLength":9}}}},"responses":{"200":{"description":"Reference to the password org config.","content":{"application/json":{"schema":{"type":"object","properties":{"customInstructionsEnabled":{"type":"boolean","description":"Indicator whether custom password instructions feature is enabled. The default value is false.","default":false,"example":true},"digitTokenEnabled":{"type":"boolean","description":"Indicator whether \"digit token\" feature is enabled. The default value is false.","default":false,"example":true},"digitTokenDurationMinutes":{"type":"integer","format":"int32","description":"The duration of \"digit token\" in minutes. The default value is 5.","minimum":1,"maximum":60,"default":5,"example":10},"digitTokenLength":{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}},"example":{"customInstructionsEnabled":true,"digitTokenDurationMinutes":9,"digitTokenEnabled":true,"digitTokenLength":12}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/password-org-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"customInstructionsEnabled":true,"digitTokenEnabled":true,"digitTokenDurationMinutes":10,"digitTokenLength":9},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create Password Org Config","description":{"content":"This API creates the password org config. Unspecified fields will use default value. Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'","type":"text/plain"},"url":{"path":["password-org-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Password Org Config' (create-password-org-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Password Org Config + + + +This API creates the password org config. Unspecified fields will use default value. Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +
Request Body required
    = 1` and `<= 60`"} defaultValue={5}>= 6` and `<= 18`"} defaultValue={6}>
+ +Reference to the password org config. + +
Schema
    = 1` and `<= 60`"} defaultValue={5}>= 6` and `<= 18`"} defaultValue={6}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-password-sync-group.api.mdx b/products/idn/api/beta/create-password-sync-group.api.mdx new file mode 100644 index 000000000..95ec3df88 --- /dev/null +++ b/products/idn/api/beta/create-password-sync-group.api.mdx @@ -0,0 +1,75 @@ +--- +id: create-password-sync-group +sidebar_label: Create Password Sync Group +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createPasswordSyncGroup","tags":["Password Sync Groups"],"description":"This API creates a password sync group based on the specifications provided. A token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:password-sync-group-management:write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the sync group","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"},"name":{"description":"Name of the sync group","type":"string","example":"Password Sync Group 1"},"passwordPolicyId":{"type":"string","description":"ID of the password policy","example":"2c91808d744ba0ce01746f93b6204501"},"sourceIds":{"type":"array","description":"List of password managed sources IDs","items":{"type":"string"},"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}},"example":{"name":"Password Sync Group 2","passwordPolicyId":"2c91808d744ba0ce01746f93b6204501","sourceIds":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}}},"responses":{"200":{"description":"Reference to the password sync group.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the sync group","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"},"name":{"description":"Name of the sync group","type":"string","example":"Password Sync Group 1"},"passwordPolicyId":{"type":"string","description":"ID of the password policy","example":"2c91808d744ba0ce01746f93b6204501"},"sourceIds":{"type":"array","description":"List of password managed sources IDs","items":{"type":"string"},"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}},"example":{"id":"6881f631-3bd5-4213-9c75-8e05cc3e35dd","name":"Password Sync Group 2","passwordPolicyId":"2c91808d744ba0ce01746f93b6204501","sourceIds":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/password-sync-groups","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"id":"6881f631-3bd5-4213-9c75-8e05cc3e35dd","name":"Password Sync Group 1","passwordPolicyId":"2c91808d744ba0ce01746f93b6204501","sourceIds":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create Password Sync Group","description":{"content":"This API creates a password sync group based on the specifications provided. A token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["password-sync-groups"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Password Sync Group' (create-password-sync-group)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Password Sync Group + + + +This API creates a password sync group based on the specifications provided. A token with ORG_ADMIN authority is required to call this API. + +
Request Body required
+ +Reference to the password sync group. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-personal-access-token.api.mdx b/products/idn/api/beta/create-personal-access-token.api.mdx new file mode 100644 index 000000000..9c537ca2f --- /dev/null +++ b/products/idn/api/beta/create-personal-access-token.api.mdx @@ -0,0 +1,83 @@ +--- +id: create-personal-access-token +sidebar_label: Create Personal Access Token +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createPersonalAccessToken","security":[{"oauth2":["sp:my-personal-access-tokens:manage","sp:all-personal-access-tokens:manage"]}],"tags":["Personal Access Tokens"],"description":"This creates a personal access token.","requestBody":{"description":"Name and scope of personal access token.","required":true,"content":{"application/json":{"schema":{"type":"object","description":"Object for specifying the name of a personal access token to create","properties":{"name":{"type":"string","description":"The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created.","example":"NodeJS Integration"},"scope":{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the personal access token. If no scope is specified, the token will be created with the default scope \"sp:scopes:all\". This means the personal access token will have all the rights of the owner who created it.","example":["demo:personal-access-token-scope:first","demo:personal-access-token-scope:second"]}},"required":["name"]}}}},"responses":{"200":{"description":"Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the personal access token (to be used as the username for Basic Auth).","example":"86f1dc6fe8f54414950454cbb11278fa"},"secret":{"type":"string","description":"The secret of the personal access token (to be used as the password for Basic Auth).","example":"1d1bef2b9f426383447f64f69349fc7cac176042578d205c256ba3f37c59adb9"},"scope":{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the personal access token.","example":["demo:personal-access-token-scope:first","demo:personal-access-token-scope:second"]},"name":{"type":"string","description":"The name of the personal access token. Cannot be the same as other personal access tokens owned by a user.","example":"NodeJS Integration"},"owner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Details about the owner of the personal access token."},"created":{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when this personal access token was created.","example":"2017-07-11T18:45:37.098Z"}},"required":["id","secret","scope","name","owner","created"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/personal-access-tokens","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"NodeJS Integration","scope":["demo:personal-access-token-scope:first","demo:personal-access-token-scope:second"]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create Personal Access Token","description":{"content":"This creates a personal access token.","type":"text/plain"},"url":{"path":["personal-access-tokens"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Personal Access Token' (create-personal-access-token)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Personal Access Token + + + +This creates a personal access token. + +
Request Body required
+ +Name and scope of personal access token. + +
+ +Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed. + +
Schema
    owner object
    + +Details about the owner of the personal access token. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-potential-role-provision-request.api.mdx b/products/idn/api/beta/create-potential-role-provision-request.api.mdx new file mode 100644 index 000000000..2ec17bdcf --- /dev/null +++ b/products/idn/api/beta/create-potential-role-provision-request.api.mdx @@ -0,0 +1,91 @@ +--- +id: create-potential-role-provision-request +sidebar_label: Create request to provision a potential role into an actual role. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createPotentialRoleProvisionRequest","tags":["IAI Role Mining"],"description":"This method starts a job to provision a potential role","parameters":[{"in":"path","name":"sessionId","schema":{"type":"string"},"required":true,"description":"The role mining session id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"path","name":"potentialRoleId","schema":{"type":"string"},"required":true,"description":"A potential role id in a role mining session","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"query","name":"min-entitlement-popularity","description":"Minimum popularity required for an entitlement to be included in the provisioned role.","required":false,"style":"form","explode":true,"schema":{"type":"integer","default":0,"minimum":0,"maximum":100}},{"in":"query","name":"include-common-access","description":"Boolean determining whether common access entitlements will be included in the provisioned role.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":true}}],"requestBody":{"description":"Required information to create a new role","content":{"application/json":{"schema":{"type":"object","properties":{"roleName":{"type":"string","description":"Name of the new role being created","example":"Finance - Accounting"},"roleDescription":{"type":"string","description":"Short description of the new role being created","example":"General access for accounting department"},"ownerId":{"type":"string","description":"ID of the identity that will own this role","example":"2b568c65bc3c4c57a43bd97e3a8e41"}},"example":{"roleName":"Finance - Accounting","roleDescription":"General access for accounting department","ownerId":"2b568c65bc3c4c57a43bd97e3a8e41"}}}}},"responses":{"202":{"description":"Accepted. Returns a potential role summary including the status of the provison request","content":{"application/json":{"schema":{"type":"object","properties":{"potentialRoleRef":{"description":"Details about the potential role","type":"object","properties":{"id":{"type":"string","description":"Id of the potential role"},"name":{"type":"string","description":"Name of the potential role"}}},"identityCount":{"type":"integer","description":"The number of identities in a potential role.","example":25},"entitlementCount":{"type":"integer","description":"The number of entitlements in a potential role.","example":15},"identityGroupStatus":{"type":"string","description":"The status for this identity group which can be \"REQUESTED\" or \"OBTAINED\"","example":"OBTAINED"},"provisionState":{"description":"The status of provisioning for this potential role. Can be \"POTENTIAL\", \"PENDING\", \"FAILED\", or \"COMPLETE\".","example":"PENDING","type":"string","enum":["POTENTIAL","PENDING","COMPLETE","FAILED"]},"roleId":{"type":"string","description":"ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned.","example":"2a4be6fbcf3c4e66b95a0c15ffd591"},"density":{"type":"integer","description":"The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities.","example":90},"freshness":{"type":"integer","description":"The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles.","example":70},"quality":{"type":"integer","description":"The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness.","example":80}},"example":{"potentialRoleRef":{"id":"dd4c13c6-8237-4753-bfb7-f627e489f9ec","name":"Potential Role - dd4c13"},"identityCount":"25","entitlementCount":"15","identityGroupStatus":"OBTAINED","provisionState":"PENDING","roleId":"2a4be6fbcf3c4e66b95a0c15ffd591"}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"roleName":"Finance - Accounting","roleDescription":"General access for accounting department","ownerId":"2b568c65bc3c4c57a43bd97e3a8e41"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create request to provision a potential role into an actual role.","description":{"content":"This method starts a job to provision a potential role","type":"text/plain"},"url":{"path":["role-mining-sessions",":sessionId","potential-roles",":potentialRoleId","provision"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Minimum popularity required for an entitlement to be included in the provisioned role.","type":"text/plain"},"key":"min-entitlement-popularity","value":""},{"disabled":false,"description":{"content":"Boolean determining whether common access entitlements will be included in the provisioned role.","type":"text/plain"},"key":"include-common-access","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The role mining session id","type":"text/plain"},"type":"any","value":"","key":"sessionId"},{"disabled":false,"description":{"content":"(Required) A potential role id in a role mining session","type":"text/plain"},"type":"any","value":"","key":"potentialRoleId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create request to provision a potential role into an actual role.' (create-potential-role-provision-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create request to provision a potential role into an actual role. + + + +This method starts a job to provision a potential role + +
Path Parameters
Query Parameters
Request Body
+ +Required information to create a new role + +
+ +Accepted. Returns a potential role summary including the status of the provison request + +
Schema
    potentialRoleRef object
    + +Details about the potential role + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-provisioning-policy.api.mdx b/products/idn/api/beta/create-provisioning-policy.api.mdx new file mode 100644 index 000000000..731904092 --- /dev/null +++ b/products/idn/api/beta/create-provisioning-policy.api.mdx @@ -0,0 +1,90 @@ +--- +id: create-provisioning-policy +sidebar_label: Create Provisioning Policy +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createProvisioningPolicy","tags":["Sources"],"description":"This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types.\nTransforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.\nRefer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.\nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:provisioning-policy:manage"]}],"parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source id","example":"2c9180835d191a86015d28455b4a2329"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"the provisioning policy name","example":"example provisioning policy for inactive identities"},"description":{"type":"string","description":"the description of the provisioning policy","example":"this provisioning policy creates access based on an identity going inactive"},"usageType":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"userName"},"transform":{"type":"object","description":"The transform to apply to the field","example":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"default":{}},"attributes":{"type":"object","description":"Attributes required for the transform","example":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"}},"type":{"type":"string","description":"The type of the attribute.","example":"string"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","default":false,"example":false}}}}}},"examples":{"Create Account Provisioning Policy":{"value":{"name":"Account","description":"Account Provisioning Policy","usageType":"CREATE","fields":[{"name":"displayName","transform":{"type":"identityAttribute","attributes":{"name":"displayName"}},"attributes":{},"isRequired":false,"type":"string","isMultiValued":false},{"name":"distinguishedName","transform":{"type":"usernameGenerator","attributes":{"sourceCheck":true,"patterns":["CN=$fi $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com","CN=$fti $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com","CN=$fn $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com","CN=$fn$ln${uniqueCounter},OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"],"fn":{"type":"identityAttribute","attributes":{"name":"firstname"}},"ln":{"type":"identityAttribute","attributes":{"name":"lastname"}},"fi":{"type":"substring","attributes":{"input":{"type":"identityAttribute","attributes":{"name":"firstname"}},"begin":0,"end":1}},"fti":{"type":"substring","attributes":{"input":{"type":"identityAttribute","attributes":{"name":"firstname"}},"begin":0,"end":2}}}},"attributes":{"cloudMaxUniqueChecks":"5","cloudMaxSize":"100","cloudRequired":"true"},"isRequired":false,"type":"","isMultiValued":false},{"name":"description","transform":{"type":"static","attributes":{"value":""}},"attributes":{},"isRequired":false,"type":"string","isMultiValued":false}]}}}}}},"responses":{"201":{"description":"Created ProvisioningPolicyDto object","content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"the provisioning policy name","example":"example provisioning policy for inactive identities"},"description":{"type":"string","description":"the description of the provisioning policy","example":"this provisioning policy creates access based on an identity going inactive"},"usageType":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"userName"},"transform":{"type":"object","description":"The transform to apply to the field","example":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"default":{}},"attributes":{"type":"object","description":"Attributes required for the transform","example":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"}},"isRequired":{"type":"boolean","readOnly":true,"description":"Flag indicating whether or not the attribute is required.","default":false,"example":false},"type":{"type":"string","description":"The type of the attribute.","example":"string"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","default":false,"example":false}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sources/{sourceId}/provisioning-policies","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"example provisioning policy for inactive identities","description":"this provisioning policy creates access based on an identity going inactive","usageType":"CREATE","fields":[{"name":"userName","transform":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"attributes":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"},"type":"string","isMultiValued":false}]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create Provisioning Policy","description":{"content":"This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types.\nTransforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.\nRefer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":sourceId","provisioning-policies"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Provisioning Policy' (create-provisioning-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Provisioning Policy + + + +This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. +A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
Request Body required
    fields object[]
+ +Created ProvisioningPolicyDto object + +
Schema
    fields object[]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-reassignment-configuration.api.mdx b/products/idn/api/beta/create-reassignment-configuration.api.mdx new file mode 100644 index 000000000..0fcb1801e --- /dev/null +++ b/products/idn/api/beta/create-reassignment-configuration.api.mdx @@ -0,0 +1,99 @@ +--- +id: create-reassignment-configuration +sidebar_label: Create a Reassignment Configuration +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createReassignmentConfiguration","tags":["Work Reassignment"],"description":"Creates a new Reassignment Configuration for the specified identity.","security":[{"oauth2":["idn:reassignment-configuration:create"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"The request body for creation or update of a Reassignment Configuration for a single identity and work type","properties":{"reassignedFromId":{"type":"string","description":"The identity id to reassign an item from","example":"2c91808781a71ddb0181b9090b5c504e"},"reassignedToId":{"type":"string","description":"The identity id to reassign an item to","example":"2c91808781a71ddb0181b9090b53504a"},"configType":{"type":"string","description":"Enum list of valid work types that can be selected for a Reassignment Configuration","enum":["ACCESS_REQUESTS","CERTIFICATIONS","MANUAL_TASKS"],"example":"ACCESS_REQUESTS"},"startDate":{"type":"string","description":"The date from which to start reassigning work items","format":"date-time","example":"2022-07-21T11:13:12.345Z"},"endDate":{"type":"string","description":"The date from which to stop reassigning work items. If this is an null string it indicates a permanent reassignment.","format":"date-time","nullable":true,"example":"2022-07-30T17:00:00.000Z"}}}}}},"responses":{"201":{"description":"The newly created Reassignment Configuration object","content":{"application/json":{"schema":{"type":"object","description":"The response body of a Reassignment Configuration for a single identity","properties":{"identity":{"type":"object","description":"The definition of an Identity according to the Reassignment Configuration service","properties":{"id":{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"},"name":{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}},"configDetails":{"type":"array","description":"Details of how work should be reassigned for an Identity","items":{"type":"object","description":"The request body of Reassignment Configuration Details for a specific identity and config type","properties":{"configType":{"type":"string","description":"Enum list of valid work types that can be selected for a Reassignment Configuration","enum":["ACCESS_REQUESTS","CERTIFICATIONS","MANUAL_TASKS"],"example":"ACCESS_REQUESTS"},"targetIdentity":{"type":"object","description":"The definition of an Identity according to the Reassignment Configuration service","properties":{"id":{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"},"name":{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}},"startDate":{"type":"string","description":"The date from which to start reassigning work items","format":"date-time","example":"2022-07-21T11:13:12.345Z"},"endDate":{"type":"string","description":"The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment.","format":"date-time","example":"0001-01-01T00:00:00Z"},"auditDetails":{"type":"object","description":"Audit details for the reassignment configuration of an identity","properties":{"created":{"type":"string","description":"Initial date and time when the record was created","format":"date-time","example":"2022-07-21T11:13:12.345Z"},"createdBy":{"type":"object","description":"The definition of an Identity according to the Reassignment Configuration service","properties":{"id":{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"},"name":{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}},"modified":{"type":"string","description":"Last modified date and time for the record","format":"date-time","example":"2022-07-21T11:13:12.345Z"},"modifiedBy":{"type":"object","description":"The definition of an Identity according to the Reassignment Configuration service","properties":{"id":{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"},"name":{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}}}}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/reassignment-configurations","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"reassignedFromId":"2c91808781a71ddb0181b9090b5c504e","reassignedToId":"2c91808781a71ddb0181b9090b53504a","configType":"ACCESS_REQUESTS","startDate":"2022-07-21T11:13:12.345Z","endDate":"2022-07-30T17:00:00.000Z"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create a Reassignment Configuration","description":{"content":"Creates a new Reassignment Configuration for the specified identity.","type":"text/plain"},"url":{"path":["reassignment-configurations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a Reassignment Configuration' (create-reassignment-configuration)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create a Reassignment Configuration + + + +Creates a new Reassignment Configuration for the specified identity. + +
Request Body required
+ +The newly created Reassignment Configuration object + +
Schema
    identity object
    + +The definition of an Identity according to the Reassignment Configuration service + +
    configDetails object[]
    + +Details of how work should be reassigned for an Identity + +
    targetIdentity object
    + +The definition of an Identity according to the Reassignment Configuration service + +
    auditDetails object
    + +Audit details for the reassignment configuration of an identity + +
    createdBy object
    + +The definition of an Identity according to the Reassignment Configuration service + +
    modifiedBy object
    + +The definition of an Identity according to the Reassignment Configuration service + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-role-insight-requests.api.mdx b/products/idn/api/beta/create-role-insight-requests.api.mdx new file mode 100644 index 000000000..baab4132b --- /dev/null +++ b/products/idn/api/beta/create-role-insight-requests.api.mdx @@ -0,0 +1,71 @@ +--- +id: create-role-insight-requests +sidebar_label: A request to generate insights for roles +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createRoleInsightRequests","tags":["Role Insights"],"description":"This submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer.","responses":{"201":{"description":"Submitted a role insights generation request","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Request Id for a role insight generation request","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},"createdDate":{"type":"string","format":"date-time","description":"The date-time role insights request was created.","example":"2020-09-16T18:49:32.150Z"},"lastGenerated":{"type":"string","format":"date-time","description":"The date-time role insights request was completed.","example":"2020-09-16T18:50:12.150Z"},"numberOfUpdates":{"type":"integer","description":"Total number of updates for this request. Starts with 0 and will have correct number when request is COMPLETED.","example":0},"roleIds":{"description":"The role IDs that are in this request.","type":"array","items":{"type":"string"}},"status":{"type":"string","description":"Request status","enum":["CREATED","IN PROGRESS","COMPLETED","FAILED"]}},"example":{"id":"c9aa02f7-86b0-4bc4-84bd-3116a6131e77","createdDate":"2020-09-16T18:49:32.150Z","lastGenerated":"2020-09-16T18:49:32.150Z","numberOfUpdates":0,"roleIds":["2c91808e720e94f8017253287c0a44f4","2c918087723ac2800172532191540e03","2c9180986e4c8592016e6b15eaef447c"],"status":"CREATED"}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/role-insights/requests","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"A request to generate insights for roles","description":{"content":"This submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer.","type":"text/plain"},"url":{"path":["role-insights","requests"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'A request to generate insights for roles' (create-role-insight-requests)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## A request to generate insights for roles + + + +This submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. + +
+ +Submitted a role insights generation request + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-role-mining-sessions.api.mdx b/products/idn/api/beta/create-role-mining-sessions.api.mdx new file mode 100644 index 000000000..5cb06b76f --- /dev/null +++ b/products/idn/api/beta/create-role-mining-sessions.api.mdx @@ -0,0 +1,99 @@ +--- +id: create-role-mining-sessions +sidebar_label: Create a role mining session +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createRoleMiningSessions","tags":["IAI Role Mining"],"description":"This submits a create role mining session request to the role mining application.","requestBody":{"description":"Role mining session parameters","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"scope":{"description":"The scope of identities for this role mining session","example":{"identityIds":[],"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"]}}},"type":"object","properties":{"identityIds":{"type":"array","items":{"type":"string"},"description":"The list of identities for this role mining session.","example":["2c918090761a5aac0176215c46a62d58","2c918090761a5aac01722015c46a62d42"]},"criteria":{"type":"string","description":"The \"search\" criteria that produces the list of identities for this role mining session.","example":"source.name:DataScienceDataset"},"attributeFilterCriteria":{"type":"array","items":{"type":"object"},"description":"The filter criteria for this role mining session.","example":{"displayName":{"untranslated":"Location: Miami"},"ariaLabel":{"untranslated":"Location: Miami"},"data":{"displayName":{"translateKey":"IDN.IDENTITY_ATTRIBUTES.LOCATION"},"name":"location","operator":"EQUALS","values":["Miami"]}}}}},"pruneThreshold":{"type":"integer","description":"The prune threshold to be used or null to calculate prescribedPruneThreshold","example":5,"format":"int32"},"prescribedPruneThreshold":{"type":"integer","description":"The calculated prescribedPruneThreshold","example":10,"format":"int32"},"minNumIdentitiesInPotentialRole":{"type":"integer","description":"Minimum number of identities in a potential role","example":20,"format":"int32"},"potentialRoleCount":{"type":"integer","description":"Number of potential roles","example":0,"format":"int32"},"potentialRolesReadyCount":{"type":"integer","description":"Number of potential roles ready","example":0,"format":"int32"},"status":{"description":"The status of the role mining session","example":"CREATED","type":"object","properties":{"state":{"description":"The role mining session status. Can be one of these states - CREATED|UPDATED|IDENTITIES_OBTAINED|PRUNE_THRESHOLD_OBTAINED|POTENTIAL_ROLES_PROCESSING|POTENTIAL_ROLES_CREATED","type":"string","example":"CREATED"}}},"type":{"description":"Role mining session type","example":"SPECIALIZED","type":"string","enum":["SPECIALIZED","COMMON"]},"emailRecipientId":{"type":"string","description":"The id of the user who will receive an email about the role mining session","example":"2c918090761a5aac0176215c46a62d58"},"createdBy":{"description":"The session created by details","type":"object","properties":{"id":{"type":"string","description":"ID of the creator","example":"2c918090761a5aac0176215c46a62d58"},"displayName":{"type":"string","description":"The display name of the creator","example":"Ashley.Pierce"}}},"identityCount":{"type":"integer","description":"Number of identities in the population which meet the search criteria or identity list provided","example":0,"format":"int32"},"saved":{"type":"boolean","description":"The session's saved status","example":true},"name":{"type":"string","description":"The session's saved name","example":"Saved RM Session - 07/10"}}}}}},"responses":{"201":{"description":"Submitted a role mining session request","content":{"application/json":{"schema":{"type":"object","properties":{"scope":{"description":"The scope of identities for this role mining session","type":"object","properties":{"identityIds":{"type":"array","items":{"type":"string"},"description":"The list of identities for this role mining session.","example":["2c918090761a5aac0176215c46a62d58","2c918090761a5aac01722015c46a62d42"]},"criteria":{"type":"string","description":"The \"search\" criteria that produces the list of identities for this role mining session.","example":"source.name:DataScienceDataset"},"attributeFilterCriteria":{"type":"array","items":{"type":"object"},"description":"The filter criteria for this role mining session.","example":{"displayName":{"untranslated":"Location: Miami"},"ariaLabel":{"untranslated":"Location: Miami"},"data":{"displayName":{"translateKey":"IDN.IDENTITY_ATTRIBUTES.LOCATION"},"name":"location","operator":"EQUALS","values":["Miami"]}}}}},"minNumIdentitiesInPotentialRole":{"type":"integer","description":"Minimum number of identities in a potential role","example":20},"prescribedPruneThreshold":{"type":"integer","description":"The computed (or prescribed) prune threshold for this session","example":83},"pruneThreshold":{"type":"integer","description":"The prune threshold to be used for this role mining session","example":70},"potentialRoleCount":{"type":"integer","description":"The number of potential roles","example":8},"potentialRolesReadyCount":{"type":"integer","description":"The number of potential roles which have completed processing","example":4},"status":{"description":"The role mining session status","type":"object","properties":{"state":{"description":"The role mining session status. Can be one of these states - CREATED|UPDATED|IDENTITIES_OBTAINED|PRUNE_THRESHOLD_OBTAINED|POTENTIAL_ROLES_PROCESSING|POTENTIAL_ROLES_CREATED","type":"string","example":"CREATED"}}},"id":{"type":"string","description":"Session Id for this role mining session","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},"createdDate":{"type":"string","format":"date-time","description":"The date-time when this role mining session was created."},"modifiedDate":{"type":"string","format":"date-time","description":"The date-time when this role mining session was completed."},"type":{"description":"Role mining session type","type":"string","enum":["SPECIALIZED","COMMON"],"example":"SPECIALIZED"}},"example":{"scope":{"identityIds":[],"criteria":"source.name:DataScienceDataset"},"minNumIdentitiesInPotentialRole":20,"pruneThreshold":70,"prescribedPruneThreshold":83,"potentialRoleCount":8,"potentialRolesReadyCount":4,"status":{"state":"POTENTIAL_ROLES_PROCESSING"},"id":"602ba738-cf48-499b-a780-7b67b3fc1ecf","createdDate":"2021-09-08T16:11:05.348Z","modifiedDate":"2021-09-08T16:11:05.348Z","type":"SPECIALIZED"}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/role-mining-sessions","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"scope":{"identityIds":[],"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"]}}},"pruneThreshold":5,"prescribedPruneThreshold":10,"minNumIdentitiesInPotentialRole":20,"potentialRoleCount":0,"potentialRolesReadyCount":0,"status":"CREATED","type":"SPECIALIZED","emailRecipientId":"2c918090761a5aac0176215c46a62d58","createdBy":{"id":"2c918090761a5aac0176215c46a62d58","displayName":"Ashley.Pierce"},"identityCount":0,"saved":true,"name":"Saved RM Session - 07/10"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create a role mining session","description":{"content":"This submits a create role mining session request to the role mining application.","type":"text/plain"},"url":{"path":["role-mining-sessions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a role mining session' (create-role-mining-sessions)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create a role mining session + + + +This submits a create role mining session request to the role mining application. + +
Request Body required
+ +Role mining session parameters + +
    scope object
    + +The scope of identities for this role mining session + +
    status object
    + +The status of the role mining session + +
    createdBy object
    + +The session created by details + +
+ +Submitted a role mining session request + +
Schema
    scope object
    + +The scope of identities for this role mining session + +
    status object
    + +The role mining session status + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-role.api.mdx b/products/idn/api/beta/create-role.api.mdx new file mode 100644 index 000000000..d20c54644 --- /dev/null +++ b/products/idn/api/beta/create-role.api.mdx @@ -0,0 +1,190 @@ +--- +id: create-role +sidebar_label: Create a Role +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createRole","tags":["Roles"],"description":"This API creates a Role.\nThere is a soft limit of 800 roles per org in IdentityNow. You will receive an error if you attempt to add more than 800 roles via the API or the UI. If you need to add roles above this limit, please create a support ticket.\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a ROLE_SUBADMIN may not create a Role including an Access Profile if that Access Profile is associated with a Source with which the ROLE_SUBADMIN is not themselves associated.\nThe maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"A Role","properties":{"id":{"type":"string","description":"The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.","example":"2c918086749d78830174a1a40e121518"},"name":{"type":"string","description":"The human-readable display name of the Role","maxLength":128,"example":"Role 2567"},"created":{"type":"string","description":"Date the Role was created","format":"date-time","example":"2021-03-01T22:32:58.104Z","readOnly":true},"modified":{"type":"string","description":"Date the Role was last modified.","format":"date-time","example":"2021-03-02T20:22:28.104Z","readOnly":true},"description":{"type":"string","nullable":true,"description":"A human-readable description of the Role","example":"Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor."},"owner":{"type":"object","nullable":true,"description":"The owner of this object.","properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"accessProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the Access Profile","example":"ff808081751e6e129f1518161919ecca"},"type":{"type":"string","description":"Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result.","enum":["ACCESS_PROFILE"],"example":"ACCESS_PROFILE"},"name":{"type":"string","description":"Human-readable display name of the Access Profile. This field is ignored on input.","example":"Access Profile 2567"}}},"nullable":true},"membership":{"nullable":true,"type":"object","description":"When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.","properties":{"type":{"type":"string","enum":["STANDARD","IDENTITY_LIST"],"description":"This enum characterizes the type of a Role's membership selector. Only the following two are fully supported:\n\nSTANDARD: Indicates that Role membership is defined in terms of a criteria expression\n\nIDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed","example":"IDENTITY_LIST"},"criteria":{"nullable":true,"type":"object","description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","nullable":true,"description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","nullable":true,"description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","nullable":true,"description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa."}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa."}}},"identities":{"type":"array","items":{"type":"object","description":"A reference to an Identity in an IDENTITY_LIST role membership criteria.","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY","nullable":true},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","nullable":true,"description":"Human-readable display name of the Identity.","example":"Thomas Edison"},"aliasName":{"type":"string","nullable":true,"description":"User name of the Identity","example":"t.edison"}}},"nullable":true,"description":"Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST."}}},"legacyMembershipInfo":{"type":"object","nullable":true,"description":"This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.","example":{"type":"IDENTITY_LIST"},"additionalProperties":true},"enabled":{"type":"boolean","description":"Whether the Role is enabled or not.","example":true,"default":false},"requestable":{"type":"boolean","description":"Whether the Role can be the target of access requests.","example":true,"default":false},"accessRequestConfig":{"nullable":true,"description":"Access request configuration for this object","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":true,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":true,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n\n**OWNER**: Owner of the associated Role\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"revocationRequestConfig":{"nullable":true,"default":null,"description":"Revocation request configuration for this object.","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":false,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":false,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the revocation request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"segments":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of IDs of segments, if any, to which this Role is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]}},"required":["name","owner"]}}}},"responses":{"201":{"description":"Role created","content":{"application/json":{"schema":{"type":"object","description":"A Role","properties":{"id":{"type":"string","description":"The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.","example":"2c918086749d78830174a1a40e121518"},"name":{"type":"string","description":"The human-readable display name of the Role","maxLength":128,"example":"Role 2567"},"created":{"type":"string","description":"Date the Role was created","format":"date-time","example":"2021-03-01T22:32:58.104Z","readOnly":true},"modified":{"type":"string","description":"Date the Role was last modified.","format":"date-time","example":"2021-03-02T20:22:28.104Z","readOnly":true},"description":{"type":"string","nullable":true,"description":"A human-readable description of the Role","example":"Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor."},"owner":{"type":"object","nullable":true,"description":"The owner of this object.","properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"accessProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the Access Profile","example":"ff808081751e6e129f1518161919ecca"},"type":{"type":"string","description":"Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result.","enum":["ACCESS_PROFILE"],"example":"ACCESS_PROFILE"},"name":{"type":"string","description":"Human-readable display name of the Access Profile. This field is ignored on input.","example":"Access Profile 2567"}}},"nullable":true},"membership":{"nullable":true,"type":"object","description":"When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.","properties":{"type":{"type":"string","enum":["STANDARD","IDENTITY_LIST"],"description":"This enum characterizes the type of a Role's membership selector. Only the following two are fully supported:\n\nSTANDARD: Indicates that Role membership is defined in terms of a criteria expression\n\nIDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed","example":"IDENTITY_LIST"},"criteria":{"nullable":true,"type":"object","description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","nullable":true,"description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","nullable":true,"description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","nullable":true,"description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa."}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa."}}},"identities":{"type":"array","items":{"type":"object","description":"A reference to an Identity in an IDENTITY_LIST role membership criteria.","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY","nullable":true},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","nullable":true,"description":"Human-readable display name of the Identity.","example":"Thomas Edison"},"aliasName":{"type":"string","nullable":true,"description":"User name of the Identity","example":"t.edison"}}},"nullable":true,"description":"Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST."}}},"legacyMembershipInfo":{"type":"object","nullable":true,"description":"This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.","example":{"type":"IDENTITY_LIST"},"additionalProperties":true},"enabled":{"type":"boolean","description":"Whether the Role is enabled or not.","example":true,"default":false},"requestable":{"type":"boolean","description":"Whether the Role can be the target of access requests.","example":true,"default":false},"accessRequestConfig":{"nullable":true,"description":"Access request configuration for this object","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":true,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":true,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n\n**OWNER**: Owner of the associated Role\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"revocationRequestConfig":{"nullable":true,"default":null,"description":"Revocation request configuration for this object.","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":false,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":false,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the revocation request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"segments":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of IDs of segments, if any, to which this Role is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]}},"required":["name","owner"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:role-unchecked:manage","idn:role-checked:manage"]}],"method":"post","path":"/roles","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"id":"2c918086749d78830174a1a40e121518","name":"Role 2567","description":"Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.","owner":{"type":"IDENTITY","id":"2c9180a46faadee4016fb4e018c20639","name":"support"},"accessProfiles":[{"id":"ff808081751e6e129f1518161919ecca","type":"ACCESS_PROFILE","name":"Access Profile 2567"}],"membership":{"type":"IDENTITY_LIST","criteria":{"operation":"EQUALS","key":{"type":"ACCOUNT","property":"attribute.email","sourceId":"2c9180867427f3a301745aec18211519"},"stringValue":"carlee.cert1c9f9b6fd@mailinator.com","children":[{"operation":"EQUALS","key":{"type":"ACCOUNT","property":"attribute.email","sourceId":"2c9180867427f3a301745aec18211519"},"stringValue":"carlee.cert1c9f9b6fd@mailinator.com","children":[{"operation":"EQUALS","key":{"type":"ACCOUNT","property":"attribute.email","sourceId":"2c9180867427f3a301745aec18211519"},"stringValue":"carlee.cert1c9f9b6fd@mailinator.com"}]}]},"identities":[{"type":"IDENTITY","id":"2c9180a46faadee4016fb4e018c20639","name":"Thomas Edison","aliasName":"t.edison"}]},"legacyMembershipInfo":{"type":"IDENTITY_LIST"},"enabled":true,"requestable":true,"accessRequestConfig":{"commentsRequired":true,"denialCommentsRequired":true,"approvalSchemes":[{"approverType":"GOVERNANCE_GROUP","approverId":"46c79819-a69f-49a2-becb-12c971ae66c6"}]},"revocationRequestConfig":{"commentsRequired":false,"denialCommentsRequired":false,"approvalSchemes":[{"approverType":"GOVERNANCE_GROUP","approverId":"46c79819-a69f-49a2-becb-12c971ae66c6"}]},"segments":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create a Role","description":{"content":"This API creates a Role.\nThere is a soft limit of 800 roles per org in IdentityNow. You will receive an error if you attempt to add more than 800 roles via the API or the UI. If you need to add roles above this limit, please create a support ticket.\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a ROLE_SUBADMIN may not create a Role including an Access Profile if that Access Profile is associated with a Source with which the ROLE_SUBADMIN is not themselves associated.\nThe maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.","type":"text/plain"},"url":{"path":["roles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a Role' (create-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create a Role + + + +This API creates a Role. +There is a soft limit of 800 roles per org in IdentityNow. You will receive an error if you attempt to add more than 800 roles via the API or the UI. If you need to add roles above this limit, please create a support ticket. +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a ROLE_SUBADMIN may not create a Role including an Access Profile if that Access Profile is associated with a Source with which the ROLE_SUBADMIN is not themselves associated. +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +
Request Body required
    owner object required
    + +The owner of this object. + +
    accessProfiles object[]
    membership object
    + +When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities. + +
    criteria object
    + +Defines STANDARD type Role membership + +
    key object
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]
    + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + +
    key object
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]
    + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + +
    key object
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    identities object[]
    + +Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. + +
    legacyMembershipInfo object
    + +This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. + +
    accessRequestConfig object
    + +Access request configuration for this object + +
    approvalSchemes object[]
    + +List describing the steps in approving the request + +
    revocationRequestConfig object
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]
    + +List describing the steps in approving the revocation request + +
+ +Role created + +
Schema
    owner object
    + +The owner of this object. + +
    accessProfiles object[]
    membership object
    + +When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities. + +
    criteria object
    + +Defines STANDARD type Role membership + +
    key object
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]
    + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + +
    key object
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]
    + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + +
    key object
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    identities object[]
    + +Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. + +
    legacyMembershipInfo object
    + +This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. + +
    accessRequestConfig object
    + +Access request configuration for this object + +
    approvalSchemes object[]
    + +List describing the steps in approving the request + +
    revocationRequestConfig object
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]
    + +List describing the steps in approving the revocation request + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-search-attribute-config.api.mdx b/products/idn/api/beta/create-search-attribute-config.api.mdx new file mode 100644 index 000000000..b8f0ad864 --- /dev/null +++ b/products/idn/api/beta/create-search-attribute-config.api.mdx @@ -0,0 +1,88 @@ +--- +id: create-search-attribute-config +sidebar_label: Configure/create extended search attributes in IdentityNow. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createSearchAttributeConfig","tags":["Search Attribute Configuration"],"description":"This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig.\nA token with ORG_ADMIN authority is required to call this API.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the new attribute","example":"newMailAttribute"},"displayName":{"type":"string","description":"The display name of the new attribute","example":"New Mail Attribute"},"applicationAttributes":{"type":"object","description":"Map of application id and their associated attribute.","example":{"2c91808b79fd2422017a0b35d30f3968":"employeeNumber","2c91808b79fd2422017a0b36008f396b":"employeeNumber"}}}},"example":{"name":"newMailAttribute","displayName":"New Mail Attribute","applicationAttributes":{"2c9180866166b5b0016167c32ef31a66":"mail","2c9180866166b5b0016167c32ef31a67":"mail"}}}}},"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/accounts/search-attribute-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"newMailAttribute","displayName":"New Mail Attribute","applicationAttributes":{"2c91808b79fd2422017a0b35d30f3968":"employeeNumber","2c91808b79fd2422017a0b36008f396b":"employeeNumber"}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Configure/create extended search attributes in IdentityNow.","description":{"content":"This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts","search-attribute-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Configure/create extended search attributes in IdentityNow.' (create-search-attribute-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Configure/create extended search attributes in IdentityNow. + + + +This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig. +A token with ORG_ADMIN authority is required to call this API. + +
Request Body required
+ +Accepted - Returned if the request was successfully accepted into the system. + +
Schema
  • object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-segment.api.mdx b/products/idn/api/beta/create-segment.api.mdx new file mode 100644 index 000000000..9e7240715 --- /dev/null +++ b/products/idn/api/beta/create-segment.api.mdx @@ -0,0 +1,95 @@ +--- +id: create-segment +sidebar_label: Create Segment +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createSegment","tags":["Segments"],"description":"This API creates a segment.\n\nNote that segment definitions may take time to propagate to all identities.\n\nA token with ORG_ADMIN or API authority is required to call this API.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"name":{"type":"string","description":"Segment Business Name","example":"segment-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this Segment is created","example":"2020-01-01T00:00:00.000000Z"},"modified":{"type":"string","format":"date-time","description":"The time when this Segment is modified","example":"2020-01-01T00:00:00.000000Z"},"description":{"type":"string","description":"Optional description of the Segment","example":"This segment represents xyz"},"owner":{"type":"object","nullable":true,"description":"The owner of this object.","properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"visibilityCriteria":{"type":"object","properties":{"expression":{"type":"object","properties":{"operator":{"type":"string","description":"Operator for the expression","enum":["AND","EQUALS"],"example":"EQUALS"},"attribute":{"type":"string","description":"Name for the attribute","example":"location"},"value":{"type":"object","properties":{"type":{"type":"string","description":"The type of attribute value","example":"STRING"},"value":{"type":"string","description":"The attribute value","example":"Austin"}}},"children":{"type":"array","description":"List of expressions","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of attribute value","example":"STRING"},"value":{"type":"string","description":"The attribute value","example":"Austin"}}},"example":[]}}}}},"active":{"type":"boolean","description":"Whether the Segment is currently active. Inactive segments have no effect."}}}}}},"responses":{"201":{"description":"Segment created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"name":{"type":"string","description":"Segment Business Name","example":"segment-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this Segment is created","example":"2020-01-01T00:00:00.000000Z"},"modified":{"type":"string","format":"date-time","description":"The time when this Segment is modified","example":"2020-01-01T00:00:00.000000Z"},"description":{"type":"string","description":"Optional description of the Segment","example":"This segment represents xyz"},"owner":{"type":"object","nullable":true,"description":"The owner of this object.","properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"visibilityCriteria":{"type":"object","properties":{"expression":{"type":"object","properties":{"operator":{"type":"string","description":"Operator for the expression","enum":["AND","EQUALS"],"example":"EQUALS"},"attribute":{"type":"string","description":"Name for the attribute","example":"location"},"value":{"type":"object","properties":{"type":{"type":"string","description":"The type of attribute value","example":"STRING"},"value":{"type":"string","description":"The attribute value","example":"Austin"}}},"children":{"type":"array","description":"List of expressions","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of attribute value","example":"STRING"},"value":{"type":"string","description":"The attribute value","example":"Austin"}}},"example":[]}}}}},"active":{"type":"boolean","description":"Whether the Segment is currently active. Inactive segments have no effect."}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/segments","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"segment-xyz","created":"2020-01-01T00:00:00.000000Z","modified":"2020-01-01T00:00:00.000000Z","description":"This segment represents xyz","owner":{"type":"IDENTITY","id":"2c9180a46faadee4016fb4e018c20639","name":"support"},"visibilityCriteria":{"expression":{"operator":"EQUALS","attribute":"location","value":{"type":"STRING","value":"Austin"},"children":[]}},"active":true},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create Segment","description":{"content":"This API creates a segment.\n\nNote that segment definitions may take time to propagate to all identities.\n\nA token with ORG_ADMIN or API authority is required to call this API.","type":"text/plain"},"url":{"path":["segments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Segment' (create-segment)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Segment + + + +This API creates a segment. + +Note that segment definitions may take time to propagate to all identities. + +A token with ORG_ADMIN or API authority is required to call this API. + +
Request Body required
    owner object
    + +The owner of this object. + +
    visibilityCriteria object
    expression object
    value object
    children object[]
    + +List of expressions + +
+ +Segment created + +
Schema
    owner object
    + +The owner of this object. + +
    visibilityCriteria object
    expression object
    value object
    children object[]
    + +List of expressions + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-service-desk-integration.api.mdx b/products/idn/api/beta/create-service-desk-integration.api.mdx new file mode 100644 index 000000000..932fc38f9 --- /dev/null +++ b/products/idn/api/beta/create-service-desk-integration.api.mdx @@ -0,0 +1,147 @@ +--- +id: create-service-desk-integration +sidebar_label: Create new Service Desk integration +hide_title: true +hide_table_of_contents: true +api: {"tags":["Service Desk Integration"],"description":"Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","operationId":"createServiceDeskIntegration","requestBody":{"description":"The specifics of a new integration to create","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"},"modified":{"description":"Last modification date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}},{"type":"object","description":"Specification of a Service Desk integration","required":["description","type","attributes"],"properties":{"description":{"description":"Description of the Service Desk integration","type":"string","example":"A very nice Service Desk integration"},"type":{"description":"Service Desk integration types\n\n- ServiceNowSDIM\n- ServiceNow\n","type":"string","default":"ServiceNowSDIM","example":"ServiceNowSDIM"},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the identity that is the owner of this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the identity","example":"MyName"}}},"clusterRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the source cluster for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"cluster":{"description":"ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)","type":"string","example":"xyzzy999","deprecated":true},"managedSources":{"description":"Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)","type":"array","items":{"type":"string"},"deprecated":true,"example":["2c9180835d191a86015d28455b4a2329","2c5680835d191a85765d28455b4a9823"]},"provisioningConfig":{"description":"The 'provisioningConfig' property specifies the configuration used to provision integrations.","type":"object","properties":{"universalManager":{"description":"Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.","type":"boolean","readOnly":true,"example":true},"managedResourceRefs":{"description":"References to sources for the Service Desk integration template. May only be specified if universalManager is false.","type":"array","items":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"properties":{"type":{"description":"The type of object being referenced","enum":["SOURCE"],"example":"SOURCE"},"id":{"description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the source","example":"My Source"}}},"example":[{"type":"SOURCE","id":"2c9180855d191c59015d291ceb051111","name":"My Source 1"},{"type":"SOURCE","id":"2c9180855d191c59015d291ceb052222","name":"My Source 2"}]},"planInitializerScript":{"description":"This is a reference to a plan initializer script.","type":"object","properties":{"source":{"description":"This is a Rule that allows provisioning instruction changes.","type":"string","example":"\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n"}}},"noProvisioningRequests":{"description":"Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.","type":"boolean","example":true},"provisioningRequestExpiration":{"description":"When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.","type":"integer","format":"int32","example":7}}},"attributes":{"description":"Attributes of the Service Desk integration. Validation constraints enforced by the implementation.","type":"object","additionalProperties":true,"example":{"property":"value","key":"value"}},"beforeProvisioningRule":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to beforeProvisioningRule for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["RULE"],"example":"RULE"},"id":{"description":"ID of the rule","example":"2c91808568c529c60168cca6f90c1333"},"name":{"description":"Human-readable display name of the rule","example":"Example Rule"}}}}}]}}},"required":true},"responses":{"200":{"description":"details of the created integration","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"},"modified":{"description":"Last modification date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}},{"type":"object","description":"Specification of a Service Desk integration","required":["description","type","attributes"],"properties":{"description":{"description":"Description of the Service Desk integration","type":"string","example":"A very nice Service Desk integration"},"type":{"description":"Service Desk integration types\n\n- ServiceNowSDIM\n- ServiceNow\n","type":"string","default":"ServiceNowSDIM","example":"ServiceNowSDIM"},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the identity that is the owner of this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the identity","example":"MyName"}}},"clusterRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the source cluster for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"cluster":{"description":"ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)","type":"string","example":"xyzzy999","deprecated":true},"managedSources":{"description":"Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)","type":"array","items":{"type":"string"},"deprecated":true,"example":["2c9180835d191a86015d28455b4a2329","2c5680835d191a85765d28455b4a9823"]},"provisioningConfig":{"description":"The 'provisioningConfig' property specifies the configuration used to provision integrations.","type":"object","properties":{"universalManager":{"description":"Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.","type":"boolean","readOnly":true,"example":true},"managedResourceRefs":{"description":"References to sources for the Service Desk integration template. May only be specified if universalManager is false.","type":"array","items":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"properties":{"type":{"description":"The type of object being referenced","enum":["SOURCE"],"example":"SOURCE"},"id":{"description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the source","example":"My Source"}}},"example":[{"type":"SOURCE","id":"2c9180855d191c59015d291ceb051111","name":"My Source 1"},{"type":"SOURCE","id":"2c9180855d191c59015d291ceb052222","name":"My Source 2"}]},"planInitializerScript":{"description":"This is a reference to a plan initializer script.","type":"object","properties":{"source":{"description":"This is a Rule that allows provisioning instruction changes.","type":"string","example":"\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n"}}},"noProvisioningRequests":{"description":"Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.","type":"boolean","example":true},"provisioningRequestExpiration":{"description":"When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.","type":"integer","format":"int32","example":7}}},"attributes":{"description":"Attributes of the Service Desk integration. Validation constraints enforced by the implementation.","type":"object","additionalProperties":true,"example":{"property":"value","key":"value"}},"beforeProvisioningRule":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to beforeProvisioningRule for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["RULE"],"example":"RULE"},"id":{"description":"ID of the rule","example":"2c91808568c529c60168cca6f90c1333"},"name":{"description":"Human-readable display name of the rule","example":"Example Rule"}}}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:service-desk-admin:manage","idn:service-desk-integration:manage"]}],"method":"post","path":"/service-desk-integrations","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"aName","description":"A very nice Service Desk integration","type":"ServiceNowSDIM","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":true},"clusterRef":{"type":true,"id":true,"name":true},"provisioningConfig":{"managedResourceRefs":[{"type":"SOURCE","id":"2c9180855d191c59015d291ceb051111","name":"My Source 1"},{"type":"SOURCE","id":"2c9180855d191c59015d291ceb052222","name":"My Source 2"}],"planInitializerScript":{"source":"\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n"},"noProvisioningRequests":true,"provisioningRequestExpiration":7},"attributes":{"property":"value","key":"value"},"beforeProvisioningRule":{"type":true,"id":true,"name":true}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create new Service Desk integration","description":{"content":"Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","type":"text/plain"},"url":{"path":["service-desk-integrations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create new Service Desk integration' (create-service-desk-integration)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create new Service Desk integration + + + +Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +
Request Body required
+ +The specifics of a new integration to create + +
    ownerRef object
    + +Reference to the identity that is the owner of this Service Desk integration + +
    clusterRef object
    + +Reference to the source cluster for this Service Desk integration + +
    provisioningConfig object
    + +The 'provisioningConfig' property specifies the configuration used to provision integrations. + +
    managedResourceRefs object[]
    + +References to sources for the Service Desk integration template. May only be specified if universalManager is false. + +
    planInitializerScript object
    + +This is a reference to a plan initializer script. + +
    attributes object required
    + +Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + +
    beforeProvisioningRule object
    + +Reference to beforeProvisioningRule for this Service Desk integration + +
+ +details of the created integration + +
Schema
    ownerRef object
    + +Reference to the identity that is the owner of this Service Desk integration + +
    clusterRef object
    + +Reference to the source cluster for this Service Desk integration + +
    provisioningConfig object
    + +The 'provisioningConfig' property specifies the configuration used to provision integrations. + +
    managedResourceRefs object[]
    + +References to sources for the Service Desk integration template. May only be specified if universalManager is false. + +
    planInitializerScript object
    + +This is a reference to a plan initializer script. + +
    attributes object
    + +Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + +
    beforeProvisioningRule object
    + +Reference to beforeProvisioningRule for this Service Desk integration + +
\\\\r\\\\n\\\\r\\\\n\\\\r\\\\n Before Provisioning Rule which changes disables and enables to a modify.\\\\r\\\\n \\n\"\n },\n \"noProvisioningRequests\": true,\n \"provisioningRequestExpiration\": 7\n },\n \"attributes\": {\n \"property\": \"value\",\n \"key\": \"value\"\n },\n \"beforeProvisioningRule\": {\n \"type\": true,\n \"id\": true,\n \"name\": true\n }\n}"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-sod-policy.api.mdx b/products/idn/api/beta/create-sod-policy.api.mdx new file mode 100644 index 000000000..e9a5663a1 --- /dev/null +++ b/products/idn/api/beta/create-sod-policy.api.mdx @@ -0,0 +1,92 @@ +--- +id: create-sod-policy +sidebar_label: Create SOD policy +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createSodPolicy","tags":["SOD Policy"],"description":"This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy.\nRequires role of ORG_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Policy id","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"name":{"type":"string","description":"Policy Business Name","example":"policy-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this SOD policy is created.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"modified":{"type":"string","format":"date-time","description":"The time when this SOD policy is modified.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"description":{"type":"string","description":"Optional description of the SOD policy","example":"This policy ensures compliance of xyz","nullable":true},"ownerRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"externalPolicyReference":{"type":"string","description":"Optional External Policy Reference","example":"XYZ policy","nullable":true},"policyQuery":{"type":"string","description":"Search query of the SOD policy","example":"@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)"},"compensatingControls":{"type":"string","description":"Optional compensating controls(Mitigating Controls)","example":"Have a manager review the transaction decisions for their \"out of compliance\" employee","nullable":true},"correctionAdvice":{"type":"string","description":"Optional correction advice","example":"Based on the role of the employee, managers should remove access that is not required for their job function.","nullable":true},"state":{"type":"string","description":"whether the policy is enforced or not","enum":["ENFORCED","NOT_ENFORCED"],"example":"ENFORCED"},"tags":{"type":"array","description":"tags for this policy object","example":["TAG1","TAG2"],"items":{"type":"string"}},"creatorId":{"type":"string","description":"Policy's creator ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"modifierId":{"type":"string","description":"Policy's modifier ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","nullable":true,"readOnly":true},"violationOwnerAssignmentConfig":{"nullable":true,"type":"object","properties":{"assignmentRule":{"type":"string","enum":["MANAGER","STATIC",null],"description":"Details about the violations owner.\nMANAGER - identity's manager\nSTATIC - Governance Group or Identity","example":"MANAGER","nullable":true},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"nullable":true}]}}},"scheduled":{"type":"boolean","description":"defines whether a policy has been scheduled or not","example":true,"default":false},"type":{"type":"string","description":"whether a policy is query based or conflicting access based","default":"GENERAL","enum":["GENERAL","CONFLICTING_ACCESS_BASED"],"example":"GENERAL"},"conflictingAccessCriteria":{"allOf":[{"type":"object","properties":{"leftCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"DTO type","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}},"rightCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"DTO type","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}}}},{"nullable":true}]}}},"examples":{"Conflicting Access Based Policy":{"value":{"name":"Conflicting-Policy-Name","description":"This policy ensures compliance of xyz","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Owner Name"},"externalPolicyReference":"XYZ policy","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":["string"],"creatorId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","modifierId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","violationOwnerAssignmentConfig":{"assignmentRule":"MANAGER","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Violation Owner Name"}},"scheduled":true,"type":"CONFLICTING_ACCESS_BASED","conflictingAccessCriteria":{"leftCriteria":{"name":"money-in","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67"}]},"rightCriteria":{"name":"money-out","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a68"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a69"}]}}}},"General Policy":{"value":{"description":"Description","ownerRef":{"type":"IDENTITY","id":"2c918087682f9a86016839c05e8f1aff","name":"Owner Name"},"externalPolicyReference":"New policy","policyQuery":"policy query implementation","compensatingControls":"Compensating controls","correctionAdvice":"Correction advice","tags":[],"state":"ENFORCED","scheduled":false,"creatorId":"2c918087682f9a86016839c05e8f1aff","modifierId":null,"violationOwnerAssignmentConfig":null,"name":"General-Policy-Name"}}}}}},"responses":{"201":{"description":"SOD policy created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Policy id","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"name":{"type":"string","description":"Policy Business Name","example":"policy-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this SOD policy is created.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"modified":{"type":"string","format":"date-time","description":"The time when this SOD policy is modified.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"description":{"type":"string","description":"Optional description of the SOD policy","example":"This policy ensures compliance of xyz","nullable":true},"ownerRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"externalPolicyReference":{"type":"string","description":"Optional External Policy Reference","example":"XYZ policy","nullable":true},"policyQuery":{"type":"string","description":"Search query of the SOD policy","example":"@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)"},"compensatingControls":{"type":"string","description":"Optional compensating controls(Mitigating Controls)","example":"Have a manager review the transaction decisions for their \"out of compliance\" employee","nullable":true},"correctionAdvice":{"type":"string","description":"Optional correction advice","example":"Based on the role of the employee, managers should remove access that is not required for their job function.","nullable":true},"state":{"type":"string","description":"whether the policy is enforced or not","enum":["ENFORCED","NOT_ENFORCED"],"example":"ENFORCED"},"tags":{"type":"array","description":"tags for this policy object","example":["TAG1","TAG2"],"items":{"type":"string"}},"creatorId":{"type":"string","description":"Policy's creator ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"modifierId":{"type":"string","description":"Policy's modifier ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","nullable":true,"readOnly":true},"violationOwnerAssignmentConfig":{"nullable":true,"type":"object","properties":{"assignmentRule":{"type":"string","enum":["MANAGER","STATIC",null],"description":"Details about the violations owner.\nMANAGER - identity's manager\nSTATIC - Governance Group or Identity","example":"MANAGER","nullable":true},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"nullable":true}]}}},"scheduled":{"type":"boolean","description":"defines whether a policy has been scheduled or not","example":true,"default":false},"type":{"type":"string","description":"whether a policy is query based or conflicting access based","default":"GENERAL","enum":["GENERAL","CONFLICTING_ACCESS_BASED"],"example":"GENERAL"},"conflictingAccessCriteria":{"allOf":[{"type":"object","properties":{"leftCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"DTO type","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}},"rightCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"DTO type","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}}}},{"nullable":true}]}}},"examples":{"Conflicting Access Based Policy":{"value":{"id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"Conflicting-Policy-Name","created":"2020-01-01T00:00:00.000000Z","modified":"2020-01-01T00:00:00.000000Z","description":"This policy ensures compliance of xyz","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Owner Name"},"externalPolicyReference":"XYZ policy","policyQuery":"@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)","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":["string"],"creatorId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","modifierId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","violationOwnerAssignmentConfig":{"assignmentRule":"MANAGER","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Violation Owner Name"}},"scheduled":true,"type":"CONFLICTING_ACCESS_BASED","conflictingAccessCriteria":{"leftCriteria":{"name":"money-in","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67"}]},"rightCriteria":{"name":"money-out","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a68"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a69"}]}}}},"General Policy":{"value":{"description":"Description","ownerRef":{"type":"IDENTITY","id":"2c918087682f9a86016839c05e8f1aff","name":"Owner Name"},"externalPolicyReference":"New policy","policyQuery":"policy query implementation","compensatingControls":"Compensating controls","correctionAdvice":"Correction advice","tags":[],"state":"ENFORCED","scheduled":false,"creatorId":"2c918087682f9a86016839c05e8f1aff","modifierId":null,"violationOwnerAssignmentConfig":null,"type":"GENERAL","conflictingAccessCriteria":null,"id":"52c11db4-733e-4c31-949a-766c95ec95f1","name":"General-Policy-Name","created":"2020-05-12T19:47:38Z","modified":"2020-05-12T19:47:38Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sod-policies","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"policy-xyz","description":"This policy ensures compliance of xyz","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"},"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","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"],"violationOwnerAssignmentConfig":{"assignmentRule":"MANAGER","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"}},"scheduled":true,"type":"GENERAL","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"}]}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create SOD policy","description":{"content":"This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy.\nRequires role of ORG_ADMIN.","type":"text/plain"},"url":{"path":["sod-policies"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create SOD policy' (create-sod-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create SOD policy + + + +This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. +Requires role of ORG_ADMIN. + +
Request Body required
    ownerRef object
    violationOwnerAssignmentConfig object
    ownerRef object
    conflictingAccessCriteria object
    leftCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
    rightCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
+ +SOD policy created + +
Schema
    ownerRef object
    violationOwnerAssignmentConfig object
    ownerRef object
    conflictingAccessCriteria object
    leftCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
    rightCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-source-schema.api.mdx b/products/idn/api/beta/create-source-schema.api.mdx new file mode 100644 index 000000000..add32d560 --- /dev/null +++ b/products/idn/api/beta/create-source-schema.api.mdx @@ -0,0 +1,91 @@ +--- +id: create-source-schema +sidebar_label: Creates a new Schema on the specified Source in IdentityNow. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createSourceSchema","tags":["Sources"],"parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source id.","example":"2c9180835d191a86015d28455b4a2329"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Schema.","example":"2c9180835d191a86015d28455b4a2329"},"name":{"type":"string","description":"The name of the Schema.","example":"account"},"nativeObjectType":{"type":"string","description":"The name of the object type on the native system that the schema represents.","example":"User"},"identityAttribute":{"type":"string","description":"The name of the attribute used to calculate the unique identifier for an object in the schema.","example":"sAMAccountName"},"displayAttribute":{"type":"string","description":"The name of the attribute used to calculate the display value for an object in the schema.","example":"distinguishedName"},"hierarchyAttribute":{"type":"string","description":"The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.","example":"memberOf"},"includePermissions":{"type":"boolean","description":"Flag indicating whether or not the include permissions with the object data when aggregating the schema.","example":false},"features":{"type":"array","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING."},"description":"The features that the schema supports.","example":["PROVISIONING","NO_PERMISSIONS_PROVISIONING","GROUPS_HAVE_MEMBERS"]},"configuration":{"type":"object","description":"Holds any extra configuration data that the schema may require.","example":{"groupMemberAttribute":"member"}},"attributes":{"type":"array","description":"The attribute definitions which form the schema.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"sAMAccountName"},"type":{"type":"string","enum":["STRING","LONG","INT","BOOLEAN"],"description":"The underlying type of the value which an AttributeDefinition represents.","example":"STRING"},"schema":{"description":"A reference to the schema on the source to the attribute values map to.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"The object ID this reference applies to.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The human-readable display name of the object.","example":"group"}}},"description":{"type":"string","description":"A human-readable description of the attribute.","example":"The sAMAccountName attribute"},"isMulti":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","example":false},"isEntitlement":{"type":"boolean","description":"Flag indicating whether or not the attribute is an entitlement.","example":false},"isGroup":{"type":"boolean","description":"Flag indicating whether or not the attribute represents a group.\nThis can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute..\n","example":false}}},"example":[{"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":{"type":"string","description":"The date the Schema was created.","format":"date-time","example":"2019-12-24T22:32:58.104Z"},"modified":{"type":"string","description":"The date the Schema was last modified.","format":"date-time","example":"2019-12-31T20:22:28.104Z"}}}}}},"responses":{"201":{"description":"The Schema was successfully created on the specified Source.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Schema.","example":"2c9180835d191a86015d28455b4a2329"},"name":{"type":"string","description":"The name of the Schema.","example":"account"},"nativeObjectType":{"type":"string","description":"The name of the object type on the native system that the schema represents.","example":"User"},"identityAttribute":{"type":"string","description":"The name of the attribute used to calculate the unique identifier for an object in the schema.","example":"sAMAccountName"},"displayAttribute":{"type":"string","description":"The name of the attribute used to calculate the display value for an object in the schema.","example":"distinguishedName"},"hierarchyAttribute":{"type":"string","description":"The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.","example":"memberOf"},"includePermissions":{"type":"boolean","description":"Flag indicating whether or not the include permissions with the object data when aggregating the schema.","example":false},"features":{"type":"array","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING."},"description":"The features that the schema supports.","example":["PROVISIONING","NO_PERMISSIONS_PROVISIONING","GROUPS_HAVE_MEMBERS"]},"configuration":{"type":"object","description":"Holds any extra configuration data that the schema may require.","example":{"groupMemberAttribute":"member"}},"attributes":{"type":"array","description":"The attribute definitions which form the schema.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"sAMAccountName"},"type":{"type":"string","enum":["STRING","LONG","INT","BOOLEAN"],"description":"The underlying type of the value which an AttributeDefinition represents.","example":"STRING"},"schema":{"description":"A reference to the schema on the source to the attribute values map to.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"The object ID this reference applies to.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The human-readable display name of the object.","example":"group"}}},"description":{"type":"string","description":"A human-readable description of the attribute.","example":"The sAMAccountName attribute"},"isMulti":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","example":false},"isEntitlement":{"type":"boolean","description":"Flag indicating whether or not the attribute is an entitlement.","example":false},"isGroup":{"type":"boolean","description":"Flag indicating whether or not the attribute represents a group.\nThis can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute..\n","example":false}}},"example":[{"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":{"type":"string","description":"The date the Schema was created.","format":"date-time","example":"2019-12-24T22:32:58.104Z"},"modified":{"type":"string","description":"The date the Schema was last modified.","format":"date-time","example":"2019-12-31T20:22:28.104Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"description":"Creates a new Schema on the specified Source in IdentityNow.","method":"post","path":"/sources/{sourceId}/schemas","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"id":"2c9180835d191a86015d28455b4a2329","name":"account","nativeObjectType":"User","identityAttribute":"sAMAccountName","displayAttribute":"distinguishedName","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}],"created":"2019-12-24T22:32:58.104Z","modified":"2019-12-31T20:22:28.104Z"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Creates a new Schema on the specified Source in IdentityNow.","description":{"type":"text/plain"},"url":{"path":["sources",":sourceId","schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id.","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Creates a new Schema on the specified Source in IdentityNow.' (create-source-schema)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Creates a new Schema on the specified Source in IdentityNow. + + + +Creates a new Schema on the specified Source in IdentityNow. + +
Path Parameters
Request Body required
    attributes object[]
    + +The attribute definitions which form the schema. + +
    schema object
    + +A reference to the schema on the source to the attribute values map to. + +
+ +The Schema was successfully created on the specified Source. + +
Schema
    attributes object[]
    + +The attribute definitions which form the schema. + +
    schema object
    + +A reference to the schema on the source to the attribute values map to. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-source.api.mdx b/products/idn/api/beta/create-source.api.mdx new file mode 100644 index 000000000..dcd3a2433 --- /dev/null +++ b/products/idn/api/beta/create-source.api.mdx @@ -0,0 +1,156 @@ +--- +id: create-source +sidebar_label: Creates a source in IdentityNow. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createSource","security":[{"oauth2":["idn:sources:manage"]}],"tags":["Sources"],"description":"This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow.\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","parameters":[{"in":"query","name":"provisionAsCsv","description":"If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. ","schema":{"type":"boolean"},"required":false,"example":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"the id of the Source","example":"2c91808568c529c60168cca6f90c1324"},"name":{"type":"string","description":"Human-readable name of the source","example":"My Source"},"description":{"type":"string","description":"Human-readable description of the source","example":"This is the corporate directory."},"owner":{"description":"Reference to an owning Identity Object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity","example":"MyName"}}},"cluster":{"description":"Reference to the associated Cluster","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"type":"string","description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"accountCorrelationConfig":{"description":"Reference to an Account Correlation Config object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG"],"example":"ACCOUNT_CORRELATION_CONFIG"},"id":{"type":"string","description":"ID of the account correlation config","example":"2c9180855d191c59015d28583727245a"},"name":{"type":"string","description":"Human-readable display name of the account correlation config","example":"Directory [source-62867] Account Correlation"}}},"accountCorrelationRule":{"description":"Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"managerCorrelationMapping":{"description":"Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity","type":"object","properties":{"accountAttribute":{"type":"string","description":"Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.","example":"manager"},"identityAttribute":{"type":"string","description":"Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.","example":"manager"}}},"managerCorrelationRule":{"description":"Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"beforeProvisioningRule":{"description":"Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"schemas":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"ID of the schema","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the schema","example":"MySchema"}}},"description":"List of references to Schema objects","example":[{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232a","name":"account"},{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232b","name":"group"}]},"passwordPolicies":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["PASSWORD_POLICY"],"example":"PASSWORD_POLICY"},"id":{"type":"string","description":"ID of the policy","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the policy","example":"My Password Policy"}}},"description":"List of references to the associated PasswordPolicy objects.","example":[{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb053980","name":"Corporate Password Policy"},{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb057777","name":"Vendor Password Policy"}]},"features":{"type":"array","description":"Optional features that can be supported by a source.","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING."},"example":["SYNC_PROVISIONING","MANAGER_LOOKUP","SEARCH","PROVISIONING","AUTHENTICATE","GROUP_PROVISIONING","PASSWORD"]},"type":{"type":"string","description":"Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ","example":"OpenLDAP - Direct"},"connector":{"type":"string","description":"Connector script name.","example":"active-directory"},"connectorClass":{"type":"string","description":"The fully qualified name of the Java class that implements the connector interface.","example":"sailpoint.connector.LDAPConnector"},"connectorAttributes":{"type":"object","description":"Connector specific configuration; will differ from type to type.","example":{"healthCheckTimeout":30,"authSearchAttributes":["cn","uid","mail"]}},"deleteThreshold":{"type":"integer","format":"int32","description":"Number from 0 to 100 that specifies when to skip the delete phase.","example":10},"authoritative":{"type":"boolean","description":"When true indicates the source is referenced by an IdentityProfile.","example":false},"managementWorkgroup":{"description":"Reference to Management Workgroup for this Source","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["GOVERNANCE_GROUP"],"example":"GOVERNANCE_GROUP"},"id":{"type":"string","description":"ID of the management workgroup","example":"2c91808568c529c60168cca6f90c2222"},"name":{"type":"string","description":"Human-readable display name of the management workgroup","example":"My Management Workgroup"}}},"healthy":{"type":"boolean","description":"When true indicates a healthy source","example":true},"status":{"type":"string","description":"A status identifier, giving specific information on why a source is healthy or not","example":"SOURCE_STATE_HEALTHY"},"since":{"type":"string","description":"Timestamp showing when a source health check was last performed","example":"2021-09-28T15:48:29.3801666300Z"},"connectorId":{"type":"string","description":"The id of connector","example":"active-directory"},"connectorName":{"type":"string","description":"The name of the connector that was chosen on source creation","example":"Active Directory"},"connectionType":{"type":"string","description":"The type of connection (direct or file)","example":"file"},"connectorImplementstionId":{"type":"string","description":"The connector implementstion id","example":"delimited-file"}},"required":["name","owner","connector"]}}}},"responses":{"201":{"description":"Created Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"the id of the Source","example":"2c91808568c529c60168cca6f90c1324"},"name":{"type":"string","description":"Human-readable name of the source","example":"My Source"},"description":{"type":"string","description":"Human-readable description of the source","example":"This is the corporate directory."},"owner":{"description":"Reference to an owning Identity Object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity","example":"MyName"}}},"cluster":{"description":"Reference to the associated Cluster","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"type":"string","description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"accountCorrelationConfig":{"description":"Reference to an Account Correlation Config object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG"],"example":"ACCOUNT_CORRELATION_CONFIG"},"id":{"type":"string","description":"ID of the account correlation config","example":"2c9180855d191c59015d28583727245a"},"name":{"type":"string","description":"Human-readable display name of the account correlation config","example":"Directory [source-62867] Account Correlation"}}},"accountCorrelationRule":{"description":"Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"managerCorrelationMapping":{"description":"Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity","type":"object","properties":{"accountAttribute":{"type":"string","description":"Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.","example":"manager"},"identityAttribute":{"type":"string","description":"Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.","example":"manager"}}},"managerCorrelationRule":{"description":"Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"beforeProvisioningRule":{"description":"Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"schemas":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"ID of the schema","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the schema","example":"MySchema"}}},"description":"List of references to Schema objects","example":[{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232a","name":"account"},{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232b","name":"group"}]},"passwordPolicies":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["PASSWORD_POLICY"],"example":"PASSWORD_POLICY"},"id":{"type":"string","description":"ID of the policy","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the policy","example":"My Password Policy"}}},"description":"List of references to the associated PasswordPolicy objects.","example":[{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb053980","name":"Corporate Password Policy"},{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb057777","name":"Vendor Password Policy"}]},"features":{"type":"array","description":"Optional features that can be supported by a source.","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING."},"example":["SYNC_PROVISIONING","MANAGER_LOOKUP","SEARCH","PROVISIONING","AUTHENTICATE","GROUP_PROVISIONING","PASSWORD"]},"type":{"type":"string","description":"Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ","example":"OpenLDAP - Direct"},"connector":{"type":"string","description":"Connector script name.","example":"active-directory"},"connectorClass":{"type":"string","description":"The fully qualified name of the Java class that implements the connector interface.","example":"sailpoint.connector.LDAPConnector"},"connectorAttributes":{"type":"object","description":"Connector specific configuration; will differ from type to type.","example":{"healthCheckTimeout":30,"authSearchAttributes":["cn","uid","mail"]}},"deleteThreshold":{"type":"integer","format":"int32","description":"Number from 0 to 100 that specifies when to skip the delete phase.","example":10},"authoritative":{"type":"boolean","description":"When true indicates the source is referenced by an IdentityProfile.","example":false},"managementWorkgroup":{"description":"Reference to Management Workgroup for this Source","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["GOVERNANCE_GROUP"],"example":"GOVERNANCE_GROUP"},"id":{"type":"string","description":"ID of the management workgroup","example":"2c91808568c529c60168cca6f90c2222"},"name":{"type":"string","description":"Human-readable display name of the management workgroup","example":"My Management Workgroup"}}},"healthy":{"type":"boolean","description":"When true indicates a healthy source","example":true},"status":{"type":"string","description":"A status identifier, giving specific information on why a source is healthy or not","example":"SOURCE_STATE_HEALTHY"},"since":{"type":"string","description":"Timestamp showing when a source health check was last performed","example":"2021-09-28T15:48:29.3801666300Z"},"connectorId":{"type":"string","description":"The id of connector","example":"active-directory"},"connectorName":{"type":"string","description":"The name of the connector that was chosen on source creation","example":"Active Directory"},"connectionType":{"type":"string","description":"The type of connection (direct or file)","example":"file"},"connectorImplementstionId":{"type":"string","description":"The connector implementstion id","example":"delimited-file"}},"required":["name","owner","connector"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sources","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"My Source","description":"This is the corporate directory.","owner":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"MyName"},"cluster":{"type":"CLUSTER","id":"2c9180866166b5b0016167c32ef31a66","name":"Corporate Cluster"},"accountCorrelationConfig":{"type":"ACCOUNT_CORRELATION_CONFIG","id":"2c9180855d191c59015d28583727245a","name":"Directory [source-62867] Account Correlation"},"accountCorrelationRule":{"type":"RULE","id":"2c918085708c274401708c2a8a760001","name":"Example Rule"},"managerCorrelationMapping":{"accountAttribute":"manager","identityAttribute":"manager"},"managerCorrelationRule":{"type":"RULE","id":"2c918085708c274401708c2a8a760001","name":"Example Rule"},"beforeProvisioningRule":{"type":"RULE","id":"2c918085708c274401708c2a8a760001","name":"Example Rule"},"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":["SYNC_PROVISIONING","MANAGER_LOOKUP","SEARCH","PROVISIONING","AUTHENTICATE","GROUP_PROVISIONING","PASSWORD"],"type":"OpenLDAP - Direct","connector":"active-directory","connectorClass":"sailpoint.connector.LDAPConnector","connectorAttributes":{"healthCheckTimeout":30,"authSearchAttributes":["cn","uid","mail"]},"deleteThreshold":10,"authoritative":false,"managementWorkgroup":{"type":"GOVERNANCE_GROUP","id":"2c91808568c529c60168cca6f90c2222","name":"My Management Workgroup"},"healthy":true,"status":"SOURCE_STATE_HEALTHY","since":"2021-09-28T15:48:29.3801666300Z","connectorId":"active-directory","connectorName":"Active Directory","connectionType":"file","connectorImplementstionId":"delimited-file"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Creates a source in IdentityNow.","description":{"content":"This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow.\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. ","type":"text/plain"},"key":"provisionAsCsv","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Creates a source in IdentityNow.' (create-source)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Creates a source in IdentityNow. + + + +This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +
Query Parameters
Request Body required
    owner object required
    + +Reference to an owning Identity Object + +
    cluster object
    + +Reference to the associated Cluster + +
    accountCorrelationConfig object
    + +Reference to an Account Correlation Config object + +
    accountCorrelationRule object
    + +Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used. + +
    managerCorrelationMapping object
    + +Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + +
    managerCorrelationRule object
    + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
    beforeProvisioningRule object
    + +Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + +
    schemas object[]
    + +List of references to Schema objects + +
    passwordPolicies object[]
    + +List of references to the associated PasswordPolicy objects. + +
    managementWorkgroup object
    + +Reference to Management Workgroup for this Source + +
+ +Created Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design. + +
Schema
    owner object
    + +Reference to an owning Identity Object + +
    cluster object
    + +Reference to the associated Cluster + +
    accountCorrelationConfig object
    + +Reference to an Account Correlation Config object + +
    accountCorrelationRule object
    + +Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used. + +
    managerCorrelationMapping object
    + +Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + +
    managerCorrelationRule object
    + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
    beforeProvisioningRule object
    + +Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + +
    schemas object[]
    + +List of references to Schema objects + +
    passwordPolicies object[]
    + +List of references to the associated PasswordPolicy objects. + +
    managementWorkgroup object
    + +Reference to Management Workgroup for this Source + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-subscription.api.mdx b/products/idn/api/beta/create-subscription.api.mdx new file mode 100644 index 000000000..77f6fa57a --- /dev/null +++ b/products/idn/api/beta/create-subscription.api.mdx @@ -0,0 +1,109 @@ +--- +id: create-subscription +sidebar_label: Create a Subscription +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createSubscription","tags":["Triggers"],"description":"This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required:\n* HTTP subscriptions require httpConfig\n* EventBridge subscriptions require eventBridgeConfig","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["triggerId","type","name"],"properties":{"name":{"type":"string","description":"Subscription name.","example":"Access request subscription"},"description":{"type":"string","description":"Subscription description.","example":"Access requested to site xyz"},"triggerId":{"type":"string","description":"ID of trigger subscribed to.","example":"idn:access-requested"},"type":{"type":"string","enum":["HTTP","EVENTBRIDGE","INLINE","SCRIPT","WORKFLOW"],"description":"Subscription type. **NOTE** If type is EVENTBRIDGE, then eventBridgeConfig is required. If type is HTTP, then httpConfig is required.","example":"HTTP"},"responseDeadline":{"type":"string","description":"Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format.","example":"PT1H","default":"PT1H"},"httpConfig":{"description":"Config required if HTTP subscription type is used.","type":"object","properties":{"url":{"type":"string","description":"URL of the external/custom integration.","example":"https://www.example.com"},"httpDispatchMode":{"type":"string","description":"HTTP response modes, i.e. SYNC, ASYNC, or DYNAMIC.","enum":["SYNC","ASYNC","DYNAMIC"],"example":"SYNC"},"httpAuthenticationType":{"type":"string","description":"Defines the HTTP Authentication type. Additional values may be added in the future.\n\nIf *NO_AUTH* is selected, no extra information will be in HttpConfig.\n\nIf *BASIC_AUTH* is selected, HttpConfig will include BasicAuthConfig with Username and Password as strings.\n\nIf *BEARER_TOKEN* is selected, HttpConfig will include BearerTokenAuthConfig with Token as string.","enum":["NO_AUTH","BASIC_AUTH","BEARER_TOKEN"],"default":"NO_AUTH","example":"BASIC_AUTH"},"basicAuthConfig":{"type":"object","properties":{"userName":{"type":"string","description":"The username to authenticate.","example":"user@example.com"},"password":{"type":"string","nullable":true,"description":"The password to authenticate. On response, this field is set to null as to not return secrets.","example":null}},"nullable":true,"description":"Config required if BASIC_AUTH is used."},"bearerTokenAuthConfig":{"type":"object","properties":{"bearerToken":{"type":"string","nullable":true,"description":"Bearer token","example":null}},"nullable":true,"description":"Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets."}},"required":["url","httpDispatchMode"]},"eventBridgeConfig":{"description":"Config required if EVENTBRIDGE subscription type is used.","type":"object","properties":{"awsAccount":{"type":"string","description":"AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource.","example":"123456789012"},"awsRegion":{"type":"string","description":"AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values.","example":"us-west-1"}},"required":["awsAccount","awsRegion"]},"enabled":{"type":"boolean","description":"Whether subscription should receive real-time trigger invocations or not.\n\nTest trigger invocations are always enabled regardless of this option.","default":true,"example":true},"filter":{"type":"string","description":"JSONPath filter to conditionally invoke trigger when expression evaluates to true.","example":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]","externalDocs":{"description":"JSONPath filter documentation","url":"https://developer.sailpoint.com/idn/docs/event-triggers/filtering-events"}}}},"examples":{"HTTP Subscription":{"value":{"name":"Access request subscription","description":"Access requested to site xyz","triggerId":"idn:access-requested","type":"HTTP","httpConfig":{"url":"https://www.example.com","httpDispatchMode":"SYNC","httpAuthenticationType":"BASIC_AUTH","basicAuthConfig":{"userName":"user@example.com","password":"eRtg4%6yuI!"}},"enabled":true,"filter":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]"}},"HTTP Async Subscription":{"value":{"name":"Access request subscription","description":"Access requested to site xyz","triggerId":"idn:access-requested","type":"HTTP","responseDeadline":"PT1H","httpConfig":{"url":"https://www.example.com","httpDispatchMode":"ASYNC","httpAuthenticationType":"BASIC_AUTH","basicAuthConfig":{"userName":"user@example.com","password":"eRtg4%6yuI!"}},"enabled":true,"filter":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]"}},"EventBridge Subscription":{"value":{"name":"Access request subscription","description":"Access requested to site xyz","triggerId":"idn:access-requested","type":"EVENTBRIDGE","eventBridgeConfig":{"awsAccount":"123456789012","awsRegion":"us-west-1"},"enabled":true,"filter":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]"}}}}}},"responses":{"201":{"description":"New subscription to a trigger. The trigger can now be invoked by the method defined in the subscription.","content":{"application/json":{"schema":{"type":"object","required":["id","triggerId","type","name","triggerName","enabled","responseDeadline"],"properties":{"id":{"type":"string","description":"Subscription ID.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"name":{"type":"string","description":"Subscription name.","example":"Access request subscription"},"description":{"type":"string","description":"Subscription description.","example":"Access requested to site xyz"},"triggerId":{"type":"string","description":"ID of trigger subscribed to.","example":"idn:access-requested"},"triggerName":{"type":"string","description":"Trigger name of trigger subscribed to.","example":"Access Requested"},"type":{"type":"string","enum":["HTTP","EVENTBRIDGE","INLINE","SCRIPT","WORKFLOW"],"description":"Subscription type. **NOTE** If type is EVENTBRIDGE, then eventBridgeConfig is required. If type is HTTP, then httpConfig is required.","example":"HTTP"},"responseDeadline":{"type":"string","description":"Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format.","example":"PT1H","default":"PT1H"},"httpConfig":{"description":"Config required if HTTP subscription type is used.","type":"object","properties":{"url":{"type":"string","description":"URL of the external/custom integration.","example":"https://www.example.com"},"httpDispatchMode":{"type":"string","description":"HTTP response modes, i.e. SYNC, ASYNC, or DYNAMIC.","enum":["SYNC","ASYNC","DYNAMIC"],"example":"SYNC"},"httpAuthenticationType":{"type":"string","description":"Defines the HTTP Authentication type. Additional values may be added in the future.\n\nIf *NO_AUTH* is selected, no extra information will be in HttpConfig.\n\nIf *BASIC_AUTH* is selected, HttpConfig will include BasicAuthConfig with Username and Password as strings.\n\nIf *BEARER_TOKEN* is selected, HttpConfig will include BearerTokenAuthConfig with Token as string.","enum":["NO_AUTH","BASIC_AUTH","BEARER_TOKEN"],"default":"NO_AUTH","example":"BASIC_AUTH"},"basicAuthConfig":{"type":"object","properties":{"userName":{"type":"string","description":"The username to authenticate.","example":"user@example.com"},"password":{"type":"string","nullable":true,"description":"The password to authenticate. On response, this field is set to null as to not return secrets.","example":null}},"nullable":true,"description":"Config required if BASIC_AUTH is used."},"bearerTokenAuthConfig":{"type":"object","properties":{"bearerToken":{"type":"string","nullable":true,"description":"Bearer token","example":null}},"nullable":true,"description":"Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets."}},"required":["url","httpDispatchMode"]},"eventBridgeConfig":{"description":"Config required if EVENTBRIDGE subscription type is used.","type":"object","properties":{"awsAccount":{"type":"string","description":"AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource.","example":"123456789012"},"awsRegion":{"type":"string","description":"AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values.","example":"us-west-1"}},"required":["awsAccount","awsRegion"]},"enabled":{"type":"boolean","description":"Whether subscription should receive real-time trigger invocations or not.\nTest trigger invocations are always enabled regardless of this option.","default":true,"example":true},"filter":{"type":"string","description":"JSONPath filter to conditionally invoke trigger when expression evaluates to true.","example":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]","externalDocs":{"description":"JSONPath filter documentation","url":"https://developer.sailpoint.com/idn/docs/event-triggers/filtering-events"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["sp:trigger-service-subscriptions:manage"]}],"method":"post","path":"/trigger-subscriptions","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"Access request subscription","description":"Access requested to site xyz","triggerId":"idn:access-requested","type":"HTTP","responseDeadline":"PT1H","httpConfig":{"url":"https://www.example.com","httpDispatchMode":"SYNC","httpAuthenticationType":"BASIC_AUTH","basicAuthConfig":{"userName":"user@example.com","password":null},"bearerTokenAuthConfig":{"bearerToken":null}},"eventBridgeConfig":{"awsAccount":"123456789012","awsRegion":"us-west-1"},"enabled":true,"filter":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create a Subscription","description":{"content":"This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required:\n* HTTP subscriptions require httpConfig\n* EventBridge subscriptions require eventBridgeConfig","type":"text/plain"},"url":{"path":["trigger-subscriptions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a Subscription' (create-subscription)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create a Subscription + + + +This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: +* HTTP subscriptions require httpConfig +* EventBridge subscriptions require eventBridgeConfig + +
Request Body required
    httpConfig object
    + +Config required if HTTP subscription type is used. + +
    basicAuthConfig object
    + +Config required if BASIC_AUTH is used. + +
    bearerTokenAuthConfig object
    + +Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets. + +
    eventBridgeConfig object
    + +Config required if EVENTBRIDGE subscription type is used. + +
+ +New subscription to a trigger. The trigger can now be invoked by the method defined in the subscription. + +
Schema
    httpConfig object
    + +Config required if HTTP subscription type is used. + +
    basicAuthConfig object
    + +Config required if BASIC_AUTH is used. + +
    bearerTokenAuthConfig object
    + +Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets. + +
    eventBridgeConfig object
    + +Config required if EVENTBRIDGE subscription type is used. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-transform.api.mdx b/products/idn/api/beta/create-transform.api.mdx new file mode 100644 index 000000000..a81e77dfd --- /dev/null +++ b/products/idn/api/beta/create-transform.api.mdx @@ -0,0 +1,80 @@ +--- +id: create-transform +sidebar_label: Create transform +hide_title: true +hide_table_of_contents: true +api: {"tags":["Transforms"],"description":"Creates a new transform object. Request body must include name, type, and attributes.\nA token with transform write authority is required to call this API.","operationId":"createTransform","requestBody":{"required":true,"description":"The transform to be created.","content":{"application/json":{"schema":{"type":"object","description":"DTO for representing an internally- or customer-defined transform.","required":["name","type","attributes"],"properties":{"id":{"type":"string","description":"Unique ID of this transform","example":"2cd78adghjkja34jh2b1hkjhasuecd"},"name":{"type":"string","description":"Unique name of this transform","example":"Timestamp To Date"},"type":{"type":"string","description":"The transform type (see [Transformations in IdentityNow Using Seaspray](https://community.sailpoint.com/docs/DOC-4629)).","example":"concat"},"attributes":{"type":"object","nullable":true,"description":"Meta-data about the transform. Values in this list are specific to the type of transform to be executed.","example":{"inputFormat":"MMM dd yyyy, HH:mm:ss.SSS","outputFormat":"yyyy/dd/MM"}},"internal":{"type":"boolean","default":false,"readOnly":true,"description":"Indicates whether this is an internal SailPoint-created transform or a customer-created transform","example":false}}},"example":{"name":"Timestamp To Date","type":"dateFormat","attributes":{"inputFormat":"MMM dd yyyy, HH:mm:ss.SSS","outputFormat":"yyyy/dd/MM"}}}}},"responses":{"201":{"description":"Indicates the transform was successfully created and returns its representation.","content":{"application/json":{"schema":{"type":"object","description":"DTO for representing an internally- or customer-defined transform.","required":["name","type","attributes"],"properties":{"id":{"type":"string","description":"Unique ID of this transform","example":"2cd78adghjkja34jh2b1hkjhasuecd"},"name":{"type":"string","description":"Unique name of this transform","example":"Timestamp To Date"},"type":{"type":"string","description":"The transform type (see [Transformations in IdentityNow Using Seaspray](https://community.sailpoint.com/docs/DOC-4629)).","example":"concat"},"attributes":{"type":"object","nullable":true,"description":"Meta-data about the transform. Values in this list are specific to the type of transform to be executed.","example":{"inputFormat":"MMM dd yyyy, HH:mm:ss.SSS","outputFormat":"yyyy/dd/MM"}},"internal":{"type":"boolean","default":false,"readOnly":true,"description":"Indicates whether this is an internal SailPoint-created transform or a customer-created transform","example":false}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:transform:manage"]}],"method":"post","path":"/transforms","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"id":"2cd78adghjkja34jh2b1hkjhasuecd","name":"Timestamp To Date","type":"concat","attributes":{"inputFormat":"MMM dd yyyy, HH:mm:ss.SSS","outputFormat":"yyyy/dd/MM"}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create transform","description":{"content":"Creates a new transform object. Request body must include name, type, and attributes.\nA token with transform write authority is required to call this API.","type":"text/plain"},"url":{"path":["transforms"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create transform' (create-transform)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create transform + + + +Creates a new transform object. Request body must include name, type, and attributes. +A token with transform write authority is required to call this API. + +
Request Body required
+ +The transform to be created. + +
+ +Indicates the transform was successfully created and returns its representation. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-verified-from-address.api.mdx b/products/idn/api/beta/create-verified-from-address.api.mdx new file mode 100644 index 000000000..1741de694 --- /dev/null +++ b/products/idn/api/beta/create-verified-from-address.api.mdx @@ -0,0 +1,75 @@ +--- +id: create-verified-from-address +sidebar_label: Create Verified From Address +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createVerifiedFromAddress","tags":["Notifications"],"description":"Create a new sender email address and initiate verification process.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string","example":"sender@example.com"},"verificationStatus":{"type":"string","enum":["PENDING","SUCCESS","FAILED"]}}},"example":{"email":"sender@example.com"}}}},"responses":{"201":{"description":"New Verified Email Status","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string","example":"sender@example.com"},"verificationStatus":{"type":"string","enum":["PENDING","SUCCESS","FAILED"]}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/verified-from-addresses","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"id":"string","email":"sender@example.com","verificationStatus":"PENDING"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create Verified From Address","description":{"content":"Create a new sender email address and initiate verification process.","type":"text/plain"},"url":{"path":["verified-from-addresses"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Verified From Address' (create-verified-from-address)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Verified From Address + + + +Create a new sender email address and initiate verification process. + +
Request Body required
+ +New Verified Email Status + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-workflow.api.mdx b/products/idn/api/beta/create-workflow.api.mdx new file mode 100644 index 000000000..170ca7cac --- /dev/null +++ b/products/idn/api/beta/create-workflow.api.mdx @@ -0,0 +1,119 @@ +--- +id: create-workflow +sidebar_label: Create Workflow +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createWorkflow","tags":["Workflows"],"description":"Create a new workflow with the desired trigger and steps specified in the request body.","security":[{"oauth2":["sp:workflow:manage"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"required":["name","owner"]},{"type":"object","properties":{"name":{"type":"string","description":"The name of the workflow","example":"Send Email"},"owner":{"description":"The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request.","properties":{"type":{"type":"string","enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"},"id":{"type":"string","description":"The unique ID of the object","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The name of the object","example":"William Wilson"}}},"description":{"type":"string","description":"Description of what the workflow accomplishes","example":"Send an email to the identity who's attributes changed."},"definition":{"type":"object","description":"The map of steps that the workflow will execute.","properties":{"start":{"type":"string","description":"The name of the starting step.","example":"Send Email Test"},"steps":{"type":"object","description":"One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type.","additionalProperties":true,"example":{"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":{"type":"boolean","description":"Enable or disable the workflow. Workflows cannot be created in an enabled state.","default":false,"example":false},"trigger":{"type":"object","description":"The trigger that starts the workflow","required":["type","attributes"],"properties":{"type":{"type":"string","enum":["EVENT","EXTERNAL","SCHEDULED"],"example":"EVENT","description":"The trigger type"},"attributes":{"anyOf":[{"title":"Event Trigger Attributes","type":"object","description":"Attributes related to an IdentityNow ETS event","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the trigger","example":"idn:identity-attributes-changed"},"filter.$":{"type":"string","description":"JSON path expression that will limit which events the trigger will fire on","example":"$.changes[?(@.attribute == 'manager')]"}}},{"title":"External Trigger Attributes","type":"object","description":"Attributes related to an external trigger","required":["name"],"properties":{"name":{"type":"string","description":"A unique name for the external trigger","example":"search-and-notify"},"description":{"type":"string","description":"Additonal context about the external trigger","example":"Run a search and notify the results"}}},{"title":"Scheduled Trigger Attributes","type":"object","description":"Attributes related to a scheduled trigger","required":["cronString"],"properties":{"cronString":{"type":"string","description":"A valid CRON expression","externalDocs":{"description":"CRON expression editor","url":"https://crontab.guru/"},"example":"0 * */3 */5 *"}}}],"description":"Workflow Trigger Attributes."}}}}}]},"examples":{"Event Trigger":{"description":"Workflow initiated by an event trigger","value":{"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')]"}}}},"Scheduled Trigger":{"description":"Workflow initiated by a scheduled trigger","value":{"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":"SCHEDULED","attributes":{"cronString":"0 * */3 */5 *"}}}}}}}},"responses":{"200":{"description":"The Workflow object","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","description":"Workflow ID. This is a UUID generated upon creation.","example":"d201c5e9-d37b-4aff-af14-66414f39d569"},"executionCount":{"type":"integer","format":"int32","description":"The number of times this workflow has been executed","example":2},"failureCount":{"type":"integer","format":"int32","description":"The number of times this workflow has failed during execution","example":0},"created":{"type":"string","format":"date-time","description":"The date and time the workflow was created","example":"2022-01-10T16:06:16.636381447Z"},"creator":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that created the workflow.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}},"example":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"}}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the workflow","example":"Send Email"},"owner":{"description":"The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request.","properties":{"type":{"type":"string","enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"},"id":{"type":"string","description":"The unique ID of the object","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The name of the object","example":"William Wilson"}}},"description":{"type":"string","description":"Description of what the workflow accomplishes","example":"Send an email to the identity who's attributes changed."},"definition":{"type":"object","description":"The map of steps that the workflow will execute.","properties":{"start":{"type":"string","description":"The name of the starting step.","example":"Send Email Test"},"steps":{"type":"object","description":"One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type.","additionalProperties":true,"example":{"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":{"type":"boolean","description":"Enable or disable the workflow. Workflows cannot be created in an enabled state.","default":false,"example":false},"trigger":{"type":"object","description":"The trigger that starts the workflow","required":["type","attributes"],"properties":{"type":{"type":"string","enum":["EVENT","EXTERNAL","SCHEDULED"],"example":"EVENT","description":"The trigger type"},"attributes":{"anyOf":[{"title":"Event Trigger Attributes","type":"object","description":"Attributes related to an IdentityNow ETS event","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the trigger","example":"idn:identity-attributes-changed"},"filter.$":{"type":"string","description":"JSON path expression that will limit which events the trigger will fire on","example":"$.changes[?(@.attribute == 'manager')]"}}},{"title":"External Trigger Attributes","type":"object","description":"Attributes related to an external trigger","required":["name"],"properties":{"name":{"type":"string","description":"A unique name for the external trigger","example":"search-and-notify"},"description":{"type":"string","description":"Additonal context about the external trigger","example":"Run a search and notify the results"}}},{"title":"Scheduled Trigger Attributes","type":"object","description":"Attributes related to a scheduled trigger","required":["cronString"],"properties":{"cronString":{"type":"string","description":"A valid CRON expression","externalDocs":{"description":"CRON expression editor","url":"https://crontab.guru/"},"example":"0 * */3 */5 *"}}}],"description":"Workflow Trigger Attributes."}}}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/workflows","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"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')]"}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create Workflow","description":{"content":"Create a new workflow with the desired trigger and steps specified in the request body.","type":"text/plain"},"url":{"path":["workflows"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Workflow' (create-workflow)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Workflow + + + +Create a new workflow with the desired trigger and steps specified in the request body. + +
Request Body required
    owner required
    + +The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request. + +
    definition object
    + +The map of steps that the workflow will execute. + +
    steps object
    + +One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. + +
    trigger object
    + +The trigger that starts the workflow + +
    attributes object required
    + +Workflow Trigger Attributes. + +
    anyOf
+ +The Workflow object + +
Schema
    creator object
    + +The identity that created the workflow. + +
    owner
    + +The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request. + +
    definition object
    + +The map of steps that the workflow will execute. + +
    steps object
    + +One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. + +
    trigger object
    + +The trigger that starts the workflow + +
    attributes object
    + +Workflow Trigger Attributes. + +
    anyOf
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/create-workgroup.api.mdx b/products/idn/api/beta/create-workgroup.api.mdx new file mode 100644 index 000000000..99e14631b --- /dev/null +++ b/products/idn/api/beta/create-workgroup.api.mdx @@ -0,0 +1,83 @@ +--- +id: create-workgroup +sidebar_label: Create a new Governance Group. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createWorkgroup","security":[{"oauth2":["idn:workgroup:read","idn:workgroup:write"]}],"tags":["Governance Groups"],"description":"This API creates a new Governance Group.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"owner":{"description":"Owner of the Governance Group","type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable name of the owner","example":"William Wilson"},"displayName":{"type":"string","description":"Human-readable display name of the owner","example":"William"},"emailAddress":{"type":"string","description":"Email ID of the owner","example":"william@sailpoint.com"}}},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"description":{"type":"string","description":"Description of the Governance Group","example":"Description of the Governance Group"},"memberCount":{"type":"integer","format":"int64","example":1641498673000,"description":"Number of members in the Governance Group."},"connectionCount":{"type":"integer","format":"int64","example":1641498673000,"description":"Number of connections in the Governance Group."}}}}}},"responses":{"200":{"description":"Governance Group object created.","content":{"application/json":{"schema":{"type":"object","properties":{"owner":{"description":"Owner of the Governance Group","type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable name of the owner","example":"William Wilson"},"displayName":{"type":"string","description":"Human-readable display name of the owner","example":"William"},"emailAddress":{"type":"string","description":"Email ID of the owner","example":"william@sailpoint.com"}}},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"description":{"type":"string","description":"Description of the Governance Group","example":"Description of the Governance Group"},"memberCount":{"type":"integer","format":"int64","example":1641498673000,"description":"Number of members in the Governance Group."},"connectionCount":{"type":"integer","format":"int64","example":1641498673000,"description":"Number of connections in the Governance Group."}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/workgroups","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"owner":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson","displayName":"William","emailAddress":"william@sailpoint.com"},"id":"2c91808568c529c60168cca6f90c1313","description":"Description of the Governance Group","memberCount":1641498673000,"connectionCount":1641498673000},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Create a new Governance Group.","description":{"content":"This API creates a new Governance Group.","type":"text/plain"},"url":{"path":["workgroups"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a new Governance Group.' (create-workgroup)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create a new Governance Group. + + + +This API creates a new Governance Group. + +
Request Body required
    owner object
    + +Owner of the Governance Group + +
+ +Governance Group object created. + +
Schema
    owner object
    + +Owner of the Governance Group + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/custom-forms.tag.mdx b/products/idn/api/beta/custom-forms.tag.mdx new file mode 100644 index 000000000..b43f6ecea --- /dev/null +++ b/products/idn/api/beta/custom-forms.tag.mdx @@ -0,0 +1,28 @@ +--- +id: custom-forms +title: "Custom Forms" +description: "Custom Forms" +custom_edit_url: null +--- + + + +Use this API to build and manage custom forms. +With this functionality in place, administrators can create and view form definitions and form instances. + +Forms are composed of sections and fields. Sections split the form into logical groups of fields and fields are the data collection points within the form. Configure conditions to modify elements of the form as the responder provides input. Create form inputs to pass information from a calling feature, like a workflow, to your form. + +Forms can be used within workflows as an action or as a trigger. The Form Action allows you to assign a form as a step in a running workflow, suspending the workflow until the form is submitted or times out, and the workflow resumes. The Form Submitted Trigger initiates a workflow when a form is submitted. The trigger can be configured to initiate on submission of a full form, a form element with any value, or a form element with a particular value. + +Refer to [Forms](https://documentation.sailpoint.com/saas/help/forms/index.html) for more information about using forms in IdentityNow. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/custom-password-instructions.tag.mdx b/products/idn/api/beta/custom-password-instructions.tag.mdx new file mode 100644 index 000000000..d418650fc --- /dev/null +++ b/products/idn/api/beta/custom-password-instructions.tag.mdx @@ -0,0 +1,31 @@ +--- +id: custom-password-instructions +title: "Custom Password Instructions" +description: "Custom Password Instructions" +custom_edit_url: null +--- + + + +Use this API to implement custom password instruction functionality. +With this functionality in place, administrators can create custom password instructions to help users reset their passwords, change them, unlock their accounts, or recover their usernames. +This allows administrators to emphasize password policies or provide organization-specific instructions. + +Administrators must first use [Update Password Org Config](https://developer.sailpoint.com/idn/api/beta/update-password-org-config) to set `customInstructionsEnabled` to `true`. + +Once they have enabled custom instructions, they can use [Create Custom Password Instructions](https://developer.sailpoint.com/idn/api/beta/create-custom-password-instructions) to create custom page content for the specific pageId they select. + +For example, an administrator can use the pageId forget-username:user-email to set the custom text for the case when users forget their usernames and must enter their emails. + +Refer to [Creating Custom Instruction Text](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html#creating-custom-instruction-text) for more information about creating custom password instructions. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/delete-access-profile.api.mdx b/products/idn/api/beta/delete-access-profile.api.mdx new file mode 100644 index 000000000..1832c20f6 --- /dev/null +++ b/products/idn/api/beta/delete-access-profile.api.mdx @@ -0,0 +1,79 @@ +--- +id: delete-access-profile +sidebar_label: Delete the specified Access Profile +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteAccessProfile","tags":["Access Profiles"],"description":"This API deletes an existing Access Profile.\n\nThe Access Profile must not be in use. If it is, a 400 error is returned.\n\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a SOURCE_SUBADMIN token must be able to administer the Source associated with the Access Profile.","parameters":[{"name":"id","in":"path","description":"ID of the Access Profile to delete","required":true,"schema":{"type":"string","example":"2c91808a7813090a017814121919ecca"}}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Returned when an access profile cannot be deleted as it's being used.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"400.2.1.0 Object in use by another":{"description":"Returned when an access profile cannot be deleted as it's being used","value":{"detailCode":"400.2.1.0 Object in use by another","trackingId":"c9c1033c55b84ebc9e93e926dcf8b8b3","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The \"testAccessProfile\" access profile can't be deleted because it's in use."}]}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:access-profile:manage"]}],"method":"delete","path":"/access-profiles/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete the specified Access Profile","description":{"content":"This API deletes an existing Access Profile.\n\nThe Access Profile must not be in use. If it is, a 400 error is returned.\n\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a SOURCE_SUBADMIN token must be able to administer the Source associated with the Access Profile.","type":"text/plain"},"url":{"path":["access-profiles",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Access Profile to delete","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete the specified Access Profile' (delete-access-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete the specified Access Profile + + + +This API deletes an existing Access Profile. + +The Access Profile must not be in use. If it is, a 400 error is returned. + +A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a SOURCE_SUBADMIN token must be able to administer the Source associated with the Access Profile. + +
Path Parameters
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Returned when an access profile cannot be deleted as it's being used. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-access-profiles-in-bulk.api.mdx b/products/idn/api/beta/delete-access-profiles-in-bulk.api.mdx new file mode 100644 index 000000000..b5a130f42 --- /dev/null +++ b/products/idn/api/beta/delete-access-profiles-in-bulk.api.mdx @@ -0,0 +1,99 @@ +--- +id: delete-access-profiles-in-bulk +sidebar_label: Delete Access Profile(s) +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteAccessProfilesInBulk","tags":["Access Profiles"],"description":"This API initiates a bulk deletion of one or more Access Profiles.\n\nBy default, if any of the indicated Access Profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated Access Profiles will be deleted.\n\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to delete Access Profiles which are associated with Sources they are able to administer.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accessProfileIds":{"description":"List of IDs of Access Profiles to be deleted.","type":"array","items":{"type":"string"},"example":["2c9180847812e0b1017817051919ecca","2c9180887812e0b201781e129f151816"]},"bestEffortOnly":{"description":"If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use.","type":"boolean","example":true}}},"example":{"bestEffortOnly":true,"accessProfileIds":["2c91808876438bb2017668b91919ecca","2c91808876438ba801766e129f151816"]}}}},"responses":{"200":{"description":"Returned only if **bestEffortOnly** is **false**, and one or more Access Profiles are in use.","content":{"application/json":{"schema":{"type":"object","properties":{"taskId":{"type":"string","description":"ID of the task which is executing the bulk deletion. This can be passed to the **/task-status** API to track status.","example":"2c9180867817ac4d017817c491119a20"},"pending":{"type":"array","description":"List of IDs of Access Profiles which are pending deletion.","items":{"type":"string"},"example":["2c91808876438bbb017668c21919ecca","2c91808876438bb201766e129f151816"]},"inUse":{"type":"array","description":"List of usages of Access Profiles targeted for deletion.","items":{"type":"object","properties":{"accessProfileId":{"type":"string","description":"ID of the Access Profile that is in use","example":"2c91808876438bbb017668c21919ecca"},"usedBy":{"type":"array","description":"List of references to objects which are using the indicated Access Profile","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}}}}}}},"example":{"pending":[],"inUse":[{"accessProfileId":"2c91808876438ba801766e129f151816","usages":[{"type":"Role","id":"2c9180887643764201766e9f6e121518"}]}]}}}},"202":{"description":"Returned if at least one deletion will be performed.","content":{"application/json":{"schema":{"type":"object","properties":{"taskId":{"type":"string","description":"ID of the task which is executing the bulk deletion. This can be passed to the **/task-status** API to track status.","example":"2c9180867817ac4d017817c491119a20"},"pending":{"type":"array","description":"List of IDs of Access Profiles which are pending deletion.","items":{"type":"string"},"example":["2c91808876438bbb017668c21919ecca","2c91808876438bb201766e129f151816"]},"inUse":{"type":"array","description":"List of usages of Access Profiles targeted for deletion.","items":{"type":"object","properties":{"accessProfileId":{"type":"string","description":"ID of the Access Profile that is in use","example":"2c91808876438bbb017668c21919ecca"},"usedBy":{"type":"array","description":"List of references to objects which are using the indicated Access Profile","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}}}}}}},"example":{"taskId":"2c91808a7813090a01781412a1119a20","pending":["2c91808a7813090a017813fe1919ecca"],"inUse":[{"accessProfileId":"2c91808876438ba801766e129f151816","usages":[{"type":"Role","id":"2c9180887643764201766e9f6e121518"}]}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:access-profile:manage"]}],"method":"post","path":"/access-profiles/bulk-delete","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"accessProfileIds":["2c9180847812e0b1017817051919ecca","2c9180887812e0b201781e129f151816"],"bestEffortOnly":true},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete Access Profile(s)","description":{"content":"This API initiates a bulk deletion of one or more Access Profiles.\n\nBy default, if any of the indicated Access Profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated Access Profiles will be deleted.\n\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to delete Access Profiles which are associated with Sources they are able to administer.","type":"text/plain"},"url":{"path":["access-profiles","bulk-delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Access Profile(s)' (delete-access-profiles-in-bulk)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Access Profile(s) + + + +This API initiates a bulk deletion of one or more Access Profiles. + +By default, if any of the indicated Access Profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated Access Profiles will be deleted. + +A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to delete Access Profiles which are associated with Sources they are able to administer. + +
Request Body required
+ +Returned only if **bestEffortOnly** is **false**, and one or more Access Profiles are in use. + +
Schema
    inUse object[]
    + +List of usages of Access Profiles targeted for deletion. + +
    usedBy object[]
    + +List of references to objects which are using the indicated Access Profile + +
+ +Returned if at least one deletion will be performed. + +
Schema
    inUse object[]
    + +List of usages of Access Profiles targeted for deletion. + +
    usedBy object[]
    + +List of references to objects which are using the indicated Access Profile + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-account.api.mdx b/products/idn/api/beta/delete-account.api.mdx new file mode 100644 index 000000000..af1119ef0 --- /dev/null +++ b/products/idn/api/beta/delete-account.api.mdx @@ -0,0 +1,88 @@ +--- +id: delete-account +sidebar_label: Delete Account +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteAccount","tags":["Accounts"],"description":"This API submits an account delete task and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:accounts:manage"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The account ID","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"202":{"description":"Async task details","content":{"application/json":{"schema":{"description":"Accounts async response containing details on started async process","required":["id"],"type":"object","properties":{"id":{"description":"id of the task","type":"string","example":"2c91808474683da6017468693c260195"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/accounts/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete Account","description":{"content":"This API submits an account delete task and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The account ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Account' (delete-account)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Account + + + +This API submits an account delete task and returns the task ID. +A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
+ +Async task details + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-campaign-template-schedule.api.mdx b/products/idn/api/beta/delete-campaign-template-schedule.api.mdx new file mode 100644 index 000000000..8ed084bb5 --- /dev/null +++ b/products/idn/api/beta/delete-campaign-template-schedule.api.mdx @@ -0,0 +1,75 @@ +--- +id: delete-campaign-template-schedule +sidebar_label: Deletes a Campaign Template's Schedule +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteCampaignTemplateSchedule","tags":["Certification Campaigns"],"description":"Deletes the schedule for a campaign template. Returns a 404 if there is no schedule set.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the campaign template whose schedule is being deleted."}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/campaign-templates/{id}/schedule","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Deletes a Campaign Template's Schedule","description":{"content":"Deletes the schedule for a campaign template. Returns a 404 if there is no schedule set.","type":"text/plain"},"url":{"path":["campaign-templates",":id","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the campaign template whose schedule is being deleted.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Deletes a Campaign Template's Schedule' (delete-campaign-template-schedule)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Deletes a Campaign Template's Schedule + + + +Deletes the schedule for a campaign template. Returns a 404 if there is no schedule set. + +
Path Parameters
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-campaign-template.api.mdx b/products/idn/api/beta/delete-campaign-template.api.mdx new file mode 100644 index 000000000..4b4788d61 --- /dev/null +++ b/products/idn/api/beta/delete-campaign-template.api.mdx @@ -0,0 +1,87 @@ +--- +id: delete-campaign-template +sidebar_label: Delete a Campaign Template +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteCampaignTemplate","tags":["Certification Campaigns"],"description":"Deletes a campaign template by ID.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the campaign template being deleted.","example":"2c9180835d191a86015d28455b4a2329"}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/campaign-templates/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete a Campaign Template","description":{"content":"Deletes a campaign template by ID.","type":"text/plain"},"url":{"path":["campaign-templates",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the campaign template being deleted.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete a Campaign Template' (delete-campaign-template)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete a Campaign Template + + + +Deletes a campaign template by ID. + +
Path Parameters
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-campaigns.api.mdx b/products/idn/api/beta/delete-campaigns.api.mdx new file mode 100644 index 000000000..b2eeba601 --- /dev/null +++ b/products/idn/api/beta/delete-campaigns.api.mdx @@ -0,0 +1,91 @@ +--- +id: delete-campaigns +sidebar_label: Deletes Campaigns +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteCampaigns","tags":["Certification Campaigns"],"description":"Deletes campaigns whose Ids are specified in the provided list of campaign Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN.","requestBody":{"description":"The ids of the campaigns to delete.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"The ids of the campaigns to delete","type":"array","items":{"type":"string"},"example":["2c9180887335cee10173490db1776c26","2c9180836a712436016a7125a90c0021"]}}}}}},"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/campaigns/delete","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"ids":["2c9180887335cee10173490db1776c26","2c9180836a712436016a7125a90c0021"]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Deletes Campaigns","description":{"content":"Deletes campaigns whose Ids are specified in the provided list of campaign Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN.","type":"text/plain"},"url":{"path":["campaigns","delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Deletes Campaigns' (delete-campaigns)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Deletes Campaigns + + + +Deletes campaigns whose Ids are specified in the provided list of campaign Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. + +
Request Body required
+ +The ids of the campaigns to delete. + +
+ +Accepted - Returned if the request was successfully accepted into the system. + +
Schema
  • object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-connector-rule.api.mdx b/products/idn/api/beta/delete-connector-rule.api.mdx new file mode 100644 index 000000000..540999282 --- /dev/null +++ b/products/idn/api/beta/delete-connector-rule.api.mdx @@ -0,0 +1,88 @@ +--- +id: delete-connector-rule +sidebar_label: Delete a Connector-Rule +hide_title: true +hide_table_of_contents: true +api: {"tags":["Connector Rule Management"],"description":"Deletes the connector rule specified by the given ID.\nA token with ORG_ADMIN authority is required to call this API.","operationId":"deleteConnectorRule","parameters":[{"name":"id","in":"path","description":"ID of the connector rule to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"8c190e6787aa4ed9a90bd9d5344523fb"}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:rule-management-connector:manage"]}],"method":"delete","path":"/connector-rules/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete a Connector-Rule","description":{"content":"Deletes the connector rule specified by the given ID.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["connector-rules",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the connector rule to delete","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete a Connector-Rule' (delete-connector-rule)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete a Connector-Rule + + + +Deletes the connector rule specified by the given ID. +A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-custom-password-instructions.api.mdx b/products/idn/api/beta/delete-custom-password-instructions.api.mdx new file mode 100644 index 000000000..ab937c392 --- /dev/null +++ b/products/idn/api/beta/delete-custom-password-instructions.api.mdx @@ -0,0 +1,79 @@ +--- +id: delete-custom-password-instructions +sidebar_label: Delete Custom Password Instructions by page ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteCustomPasswordInstructions","tags":["Custom Password Instructions"],"description":"This API delete the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.","parameters":[{"in":"path","name":"pageId","schema":{"type":"string","enum":["change-password:enter-password","change-password:finish","flow-selection:select","forget-username:user-email","mfa:enter-code","mfa:enter-kba","mfa:select","reset-password:enter-password","reset-password:enter-username","reset-password:finish","unlock-account:enter-username","unlock-account:finish"]},"required":true,"description":"The page ID of custom password instructions to delete.","example":"mfa:select"},{"in":"query","name":"locale","schema":{"type":"string"},"description":"The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\"."}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/custom-password-instructions/{pageId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete Custom Password Instructions by page ID","description":{"content":"This API delete the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["custom-password-instructions",":pageId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\".","type":"text/plain"},"key":"locale","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The page ID of custom password instructions to delete.","type":"text/plain"},"type":"any","value":"","key":"pageId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Custom Password Instructions by page ID' (delete-custom-password-instructions)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Custom Password Instructions by page ID + + + +This API delete the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
Query Parameters
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-form-definition.api.mdx b/products/idn/api/beta/delete-form-definition.api.mdx new file mode 100644 index 000000000..21b6244c1 --- /dev/null +++ b/products/idn/api/beta/delete-form-definition.api.mdx @@ -0,0 +1,55 @@ +--- +id: delete-form-definition +sidebar_label: Deletes a form definition. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Custom Forms"],"description":"Parameter `{formDefinitionID}` should match a form definition ID.","operationId":"deleteFormDefinition","parameters":[{"name":"formDefinitionID","in":"path","description":"Form definition ID","required":true,"schema":{"type":"string","x-go-name":"FormDefinitionID"},"example":"00000000-0000-0000-0000-000000000000","x-go-name":"FormDefinitionID"}],"responses":{"204":{"description":"Returns an empty body","content":{"application/json":{"schema":{"title":"Nil represents the predeclared value nil.","type":"object","x-go-package":"go/types"}}}},"400":{"description":"An error with the request occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"401":{"description":"An error with the authorization occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"403":{"description":"An error with the user permissions occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"404":{"description":"An error with the item not found","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"title":"Error is the standard API error response type.","type":"object","properties":{"detailCode":{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"trackingId":{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"}}}},"500":{"description":"An internal server error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}}},"security":[{"oauth2":["sp:forms:manage"]}],"method":"delete","path":"/form-definitions/{formDefinitionID}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Deletes a form definition.","description":{"content":"Parameter `{formDefinitionID}` should match a form definition ID.","type":"text/plain"},"url":{"path":["form-definitions",":formDefinitionID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Form definition ID","type":"text/plain"},"type":"any","value":"","key":"formDefinitionID"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Deletes a form definition.' (delete-form-definition)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Deletes a form definition. + + + +Parameter `{formDefinitionID}` should match a form definition ID. + +
Path Parameters
+ +Returns an empty body + +
Schema
  • object
+ +An error with the request occurred + +
Schema
    messages object[]
+ +An error with the authorization occurred + +
Schema
    messages object[]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
+ +An error with the item not found + +
Schema
    messages object[]
+ +Too many requests + +
Schema
    messages object[]
+ +An internal server error occurred + +
Schema
    messages object[]
\ No newline at end of file diff --git a/products/idn/api/beta/delete-identity-profile.api.mdx b/products/idn/api/beta/delete-identity-profile.api.mdx new file mode 100644 index 000000000..226b900e9 --- /dev/null +++ b/products/idn/api/beta/delete-identity-profile.api.mdx @@ -0,0 +1,88 @@ +--- +id: delete-identity-profile +sidebar_label: Delete an Identity Profile +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteIdentityProfile","tags":["Identity Profiles"],"description":"This deletes an Identity Profile based on ID.\nA token with ORG_ADMIN authority is required to call this API to delete an Identity Profile.","parameters":[{"in":"path","name":"identity-profile-id","schema":{"type":"string","format":"uuid"},"required":true,"description":"The Identity Profile ID.","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"the application ID","example":"ff8081814d977c21014da056804a0af3"},"name":{"type":"string","description":"the application name","example":"Github"}},"description":"An object with a TaskResult reference of the delete job."}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:identity-profile:manage"]}],"method":"delete","path":"/identity-profiles/{identity-profile-id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete an Identity Profile","description":{"content":"This deletes an Identity Profile based on ID.\nA token with ORG_ADMIN authority is required to call this API to delete an Identity Profile.","type":"text/plain"},"url":{"path":["identity-profiles",":identity-profile-id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Identity Profile ID.","type":"text/plain"},"type":"any","value":"","key":"identity-profile-id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete an Identity Profile' (delete-identity-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete an Identity Profile + + + +This deletes an Identity Profile based on ID. +A token with ORG_ADMIN authority is required to call this API to delete an Identity Profile. + +
Path Parameters
+ +Accepted - Returned if the request was successfully accepted into the system. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-identity-profiles.api.mdx b/products/idn/api/beta/delete-identity-profiles.api.mdx new file mode 100644 index 000000000..fd7e5672e --- /dev/null +++ b/products/idn/api/beta/delete-identity-profiles.api.mdx @@ -0,0 +1,81 @@ +--- +id: delete-identity-profiles +sidebar_label: Delete Identity Profiles +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteIdentityProfiles","tags":["Identity Profiles"],"description":"This deletes multiple Identity Profiles via a list of supplied IDs.\nOn success, this endpoint will return a reference to the bulk delete task result.\nA token with ORG_ADMIN authority is required to call this API to delete a list of Identity Profiles.","requestBody":{"description":"Identity Profile bulk delete request body.","required":true,"content":{"application/json":{"schema":{"description":"List of Identity Profile IDs to delete.","type":"array","items":{"type":"string"},"example":["2c9180867b2a34e0017b3078d60b0699","2c9180867b2a34e0017b3078d60b0698"]}}}},"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"An object with a TaskResult reference of the bulk delete job"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:identity-profile:manage"]}],"method":"post","path":"/identity-profiles/bulk-delete","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":["2c9180867b2a34e0017b3078d60b0699","2c9180867b2a34e0017b3078d60b0698"],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete Identity Profiles","description":{"content":"This deletes multiple Identity Profiles via a list of supplied IDs.\nOn success, this endpoint will return a reference to the bulk delete task result.\nA token with ORG_ADMIN authority is required to call this API to delete a list of Identity Profiles.","type":"text/plain"},"url":{"path":["identity-profiles","bulk-delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Identity Profiles' (delete-identity-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Identity Profiles + + + +This deletes multiple Identity Profiles via a list of supplied IDs. +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 to delete a list of Identity Profiles. + +
Request Body array required
+ +Identity Profile bulk delete request body. + +
  • string
+ +Accepted - Returned if the request was successfully accepted into the system. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-identity.api.mdx b/products/idn/api/beta/delete-identity.api.mdx new file mode 100644 index 000000000..27267396b --- /dev/null +++ b/products/idn/api/beta/delete-identity.api.mdx @@ -0,0 +1,87 @@ +--- +id: delete-identity +sidebar_label: Deletes an identity. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteIdentity","tags":["Identities"],"description":"The API returns successful response if the requested identity was deleted.","security":[{"oauth2":["idn:identity:delete"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Identity Id","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request is invalid. It may indicate that the specified identity is marked as protected and cannot be deleted.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/identities/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Deletes an identity.","description":{"content":"The API returns successful response if the requested identity was deleted.","type":"text/plain"},"url":{"path":["identities",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Identity Id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Deletes an identity.' (delete-identity)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Deletes an identity. + + + +The API returns successful response if the requested identity was deleted. + +
Path Parameters
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request is invalid. It may indicate that the specified identity is marked as protected and cannot be deleted. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-non-employee-record-in-bulk.api.mdx b/products/idn/api/beta/delete-non-employee-record-in-bulk.api.mdx new file mode 100644 index 000000000..5fec43f1b --- /dev/null +++ b/products/idn/api/beta/delete-non-employee-record-in-bulk.api.mdx @@ -0,0 +1,81 @@ +--- +id: delete-non-employee-record-in-bulk +sidebar_label: Delete Multiple Non-Employee Records +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteNonEmployeeRecordInBulk","security":[{"oauth2":["idn:nelm:manage"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This request will delete multiple non-employee records based on the non-employee ids provided.\nRequest will require the following scope:\n'idn:nesr:delete'","requestBody":{"description":"Non-Employee bulk delete request body.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"List of non-employee ids.","type":"array","items":{"type":"string","format":"uuid"}}},"required":["ids"]}}}},"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/non-employee-records/bulk-delete","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"ids":["3fa85f64-5717-4562-b3fc-2c963f66afa6"]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete Multiple Non-Employee Records","description":{"content":"This request will delete multiple non-employee records based on the non-employee ids provided.\nRequest will require the following scope:\n'idn:nesr:delete'","type":"text/plain"},"url":{"path":["non-employee-records","bulk-delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Multiple Non-Employee Records' (delete-non-employee-record-in-bulk)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Multiple Non-Employee Records + + + +This request will delete multiple non-employee records based on the non-employee ids provided. +Request will require the following scope: +'idn:nesr:delete' + +
Request Body required
+ +Non-Employee bulk delete request body. + +
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-non-employee-record.api.mdx b/products/idn/api/beta/delete-non-employee-record.api.mdx new file mode 100644 index 000000000..621eeb29f --- /dev/null +++ b/products/idn/api/beta/delete-non-employee-record.api.mdx @@ -0,0 +1,75 @@ +--- +id: delete-non-employee-record +sidebar_label: Delete Non-Employee Record +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteNonEmployeeRecord","security":[{"oauth2":["idn:nelm:manage"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This request will delete a non-employee record.","parameters":[{"in":"path","name":"id","description":"Non-Employee record id (UUID)","required":true,"example":"2c91808b6ef1d43e016efba0ce470904","schema":{"type":"string"}}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/non-employee-records/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete Non-Employee Record","description":{"content":"This request will delete a non-employee record.","type":"text/plain"},"url":{"path":["non-employee-records",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Non-Employee record id (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Non-Employee Record' (delete-non-employee-record)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Non-Employee Record + + + +This request will delete a non-employee record. + +
Path Parameters
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-non-employee-request.api.mdx b/products/idn/api/beta/delete-non-employee-request.api.mdx new file mode 100644 index 000000000..060c96b12 --- /dev/null +++ b/products/idn/api/beta/delete-non-employee-request.api.mdx @@ -0,0 +1,87 @@ +--- +id: delete-non-employee-request +sidebar_label: Delete Non-Employee Request +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteNonEmployeeRequest","security":[{"oauth2":["idn:nelm:manage"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This request will delete a non-employee request.","parameters":[{"in":"path","name":"id","description":"Non-Employee request id in the UUID format","required":true,"example":"2c91808b6ef1d43e016efba0ce470904","schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/non-employee-requests/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete Non-Employee Request","description":{"content":"This request will delete a non-employee request.","type":"text/plain"},"url":{"path":["non-employee-requests",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Non-Employee request id in the UUID format","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Non-Employee Request' (delete-non-employee-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Non-Employee Request + + + +This request will delete a non-employee request. + +
Path Parameters
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-non-employee-schema-attribute.api.mdx b/products/idn/api/beta/delete-non-employee-schema-attribute.api.mdx new file mode 100644 index 000000000..215984364 --- /dev/null +++ b/products/idn/api/beta/delete-non-employee-schema-attribute.api.mdx @@ -0,0 +1,76 @@ +--- +id: delete-non-employee-schema-attribute +sidebar_label: Delete Non-Employee Source's Schema Attribute +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteNonEmployeeSchemaAttribute","security":[{"oauth2":["idn:nelm:manage"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This end-point deletes a specific schema attribute for a non-employee source.\n","parameters":[{"in":"path","name":"attributeId","schema":{"type":"string"},"required":true,"example":"2c91808b6ef1d43e016efba0ce470904","description":"The Schema Attribute Id (UUID)"},{"in":"path","name":"sourceId","schema":{"type":"string"},"required":true,"example":"2c91808b6ef1d43e016efba0ce470904","description":"The Source id"}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/non-employee-sources/{sourceId}/schema-attributes/{attributeId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete Non-Employee Source's Schema Attribute","description":{"content":"This end-point deletes a specific schema attribute for a non-employee source.\n","type":"text/plain"},"url":{"path":["non-employee-sources",":sourceId","schema-attributes",":attributeId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Schema Attribute Id (UUID)","type":"text/plain"},"type":"any","value":"","key":"attributeId"},{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Non-Employee Source's Schema Attribute' (delete-non-employee-schema-attribute)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Non-Employee Source's Schema Attribute + + + +This end-point deletes a specific schema attribute for a non-employee source. + + +
Path Parameters
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-non-employee-source-schema-attributes.api.mdx b/products/idn/api/beta/delete-non-employee-source-schema-attributes.api.mdx new file mode 100644 index 000000000..c6c7437ba --- /dev/null +++ b/products/idn/api/beta/delete-non-employee-source-schema-attributes.api.mdx @@ -0,0 +1,75 @@ +--- +id: delete-non-employee-source-schema-attributes +sidebar_label: Delete all custom schema attributes +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteNonEmployeeSourceSchemaAttributes","security":[{"oauth2":["idn:nelm:manage"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This end-point deletes all custom schema attributes for a non-employee source.","parameters":[{"in":"path","name":"sourceId","schema":{"type":"string"},"required":true,"example":"2c91808b6ef1d43e016efba0ce470904","description":"The Source id"}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/non-employee-sources/{sourceId}/schema-attributes","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete all custom schema attributes","description":{"content":"This end-point deletes all custom schema attributes for a non-employee source.","type":"text/plain"},"url":{"path":["non-employee-sources",":sourceId","schema-attributes"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete all custom schema attributes' (delete-non-employee-source-schema-attributes)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete all custom schema attributes + + + +This end-point deletes all custom schema attributes for a non-employee source. + +
Path Parameters
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-non-employee-source.api.mdx b/products/idn/api/beta/delete-non-employee-source.api.mdx new file mode 100644 index 000000000..4be1ad45b --- /dev/null +++ b/products/idn/api/beta/delete-non-employee-source.api.mdx @@ -0,0 +1,75 @@ +--- +id: delete-non-employee-source +sidebar_label: Delete Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteNonEmployeeSource","security":[{"oauth2":["idn:nelm:manage"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This request will delete a non-employee source.","parameters":[{"in":"path","name":"sourceId","description":"Source Id","required":true,"example":"2c91808b6ef1d43e016efba0ce470904","schema":{"type":"string"}}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/non-employee-sources/{sourceId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete Non-Employee Source","description":{"content":"This request will delete a non-employee source.","type":"text/plain"},"url":{"path":["non-employee-sources",":sourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Source Id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Non-Employee Source' (delete-non-employee-source)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Non-Employee Source + + + +This request will delete a non-employee source. + +
Path Parameters
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-notification-templates-in-bulk.api.mdx b/products/idn/api/beta/delete-notification-templates-in-bulk.api.mdx new file mode 100644 index 000000000..3d02c4063 --- /dev/null +++ b/products/idn/api/beta/delete-notification-templates-in-bulk.api.mdx @@ -0,0 +1,75 @@ +--- +id: delete-notification-templates-in-bulk +sidebar_label: Bulk Delete Notification Templates +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteNotificationTemplatesInBulk","tags":["Notifications"],"description":"This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, you can only delete a subset of your notifications, i.e. ones that show up in the list call.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"cloud_manual_work_item_summary"},"medium":{"type":"string","enum":["EMAIL","PHONE","SMS"],"example":"EMAIL"},"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en"}},"required":["key"]}}}}},"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/notification-templates/bulk-delete","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"key":"cloud_manual_work_item_summary","medium":"EMAIL","locale":"en"}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Bulk Delete Notification Templates","description":{"content":"This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, you can only delete a subset of your notifications, i.e. ones that show up in the list call.","type":"text/plain"},"url":{"path":["notification-templates","bulk-delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Bulk Delete Notification Templates' (delete-notification-templates-in-bulk)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Bulk Delete Notification Templates + + + +This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, you can only delete a subset of your notifications, i.e. ones that show up in the list call. + +
Request Body array required
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-oauth-client.api.mdx b/products/idn/api/beta/delete-oauth-client.api.mdx new file mode 100644 index 000000000..6e62d9c2b --- /dev/null +++ b/products/idn/api/beta/delete-oauth-client.api.mdx @@ -0,0 +1,87 @@ +--- +id: delete-oauth-client +sidebar_label: Delete OAuth Client +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteOauthClient","security":[{"oauth2":["sp:oauth-client:manage"]}],"tags":["OAuth Clients"],"description":"This deletes an OAuth client.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The OAuth client id","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"204":{"description":"No content."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/oauth-clients/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete OAuth Client","description":{"content":"This deletes an OAuth client.","type":"text/plain"},"url":{"path":["oauth-clients",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The OAuth client id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete OAuth Client' (delete-oauth-client)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete OAuth Client + + + +This deletes an OAuth client. + +
Path Parameters
+ +No content. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-password-sync-group.api.mdx b/products/idn/api/beta/delete-password-sync-group.api.mdx new file mode 100644 index 000000000..e6a1ddeb9 --- /dev/null +++ b/products/idn/api/beta/delete-password-sync-group.api.mdx @@ -0,0 +1,75 @@ +--- +id: delete-password-sync-group +sidebar_label: Delete Password Sync Group by ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deletePasswordSyncGroup","tags":["Password Sync Groups"],"description":"This API deletes the specified password sync group. A token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:password-sync-group-management:write"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of password sync group to delete.","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/password-sync-groups/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete Password Sync Group by ID","description":{"content":"This API deletes the specified password sync group. A token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["password-sync-groups",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of password sync group to delete.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Password Sync Group by ID' (delete-password-sync-group)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Password Sync Group by ID + + + +This API deletes the specified password sync group. A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-personal-access-token.api.mdx b/products/idn/api/beta/delete-personal-access-token.api.mdx new file mode 100644 index 000000000..77e74a6db --- /dev/null +++ b/products/idn/api/beta/delete-personal-access-token.api.mdx @@ -0,0 +1,87 @@ +--- +id: delete-personal-access-token +sidebar_label: Delete Personal Access Token +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deletePersonalAccessToken","security":[{"oauth2":["sp:my-personal-access-tokens:manage","sp:all-personal-access-tokens:manage"]}],"tags":["Personal Access Tokens"],"description":"This deletes a personal access token.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The personal access token id","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"204":{"description":"No content."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/personal-access-tokens/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete Personal Access Token","description":{"content":"This deletes a personal access token.","type":"text/plain"},"url":{"path":["personal-access-tokens",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The personal access token id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Personal Access Token' (delete-personal-access-token)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Personal Access Token + + + +This deletes a personal access token. + +
Path Parameters
+ +No content. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-provisioning-policy.api.mdx b/products/idn/api/beta/delete-provisioning-policy.api.mdx new file mode 100644 index 000000000..22434fe4f --- /dev/null +++ b/products/idn/api/beta/delete-provisioning-policy.api.mdx @@ -0,0 +1,88 @@ +--- +id: delete-provisioning-policy +sidebar_label: Delete Provisioning Policy by UsageType +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteProvisioningPolicy","tags":["Sources"],"description":"Deletes the provisioning policy with the specified usage on an application.\nA token with API, or ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:provisioning-policy:manage"]}],"parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source ID.","example":"2c9180835d191a86015d28455b4a2329"},{"in":"path","name":"usageType","required":true,"schema":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"description":"The type of ProvisioningPolicy usage."}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/sources/{sourceId}/provisioning-policies/{usageType}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete Provisioning Policy by UsageType","description":{"content":"Deletes the provisioning policy with the specified usage on an application.\nA token with API, or ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":sourceId","provisioning-policies",":usageType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source ID.","type":"text/plain"},"type":"any","value":"","key":"sourceId"},{"disabled":false,"description":{"content":"(Required) The type of ProvisioningPolicy usage.","type":"text/plain"},"type":"any","value":"","key":"usageType"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Provisioning Policy by UsageType' (delete-provisioning-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Provisioning Policy by UsageType + + + +Deletes the provisioning policy with the specified usage on an application. +A token with API, or ORG_ADMIN authority is required to call this API. + +
Path Parameters
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-reassignment-configuration.api.mdx b/products/idn/api/beta/delete-reassignment-configuration.api.mdx new file mode 100644 index 000000000..f0d78bf8c --- /dev/null +++ b/products/idn/api/beta/delete-reassignment-configuration.api.mdx @@ -0,0 +1,75 @@ +--- +id: delete-reassignment-configuration +sidebar_label: Delete Reassignment Configuration +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteReassignmentConfiguration","tags":["Work Reassignment"],"description":"Deletes all Reassignment Configuration for the specified identity","security":[{"oauth2":["idn:reassignment-configuration:delete"]}],"parameters":[{"in":"path","name":"identityId","schema":{"type":"string"},"description":"unique identity id","required":true,"example":"2c91808781a71ddb0181b9090b5c504e"}],"responses":{"204":{"description":"Reassignment Configuration deleted"},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/reassignment-configurations/{identityId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete Reassignment Configuration","description":{"content":"Deletes all Reassignment Configuration for the specified identity","type":"text/plain"},"url":{"path":["reassignment-configurations",":identityId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) unique identity id","type":"text/plain"},"type":"any","value":"","key":"identityId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Reassignment Configuration' (delete-reassignment-configuration)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Reassignment Configuration + + + +Deletes all Reassignment Configuration for the specified identity + +
Path Parameters
+ +Reassignment Configuration deleted + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-role.api.mdx b/products/idn/api/beta/delete-role.api.mdx new file mode 100644 index 000000000..cac68113d --- /dev/null +++ b/products/idn/api/beta/delete-role.api.mdx @@ -0,0 +1,76 @@ +--- +id: delete-role +sidebar_label: Delete a Role +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteRole","tags":["Roles"],"description":"This API deletes a Role by its ID.\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"ID of the Role","example":"2c91808a7813090a017814121e121518"}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:role-unchecked:manage","idn:role-checked:manage"]}],"method":"delete","path":"/roles/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete a Role","description":{"content":"This API deletes a Role by its ID.\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.","type":"text/plain"},"url":{"path":["roles",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Role","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete a Role' (delete-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete a Role + + + +This API deletes a Role by its ID. +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +
Path Parameters
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-search-attribute-config.api.mdx b/products/idn/api/beta/delete-search-attribute-config.api.mdx new file mode 100644 index 000000000..a8417f17e --- /dev/null +++ b/products/idn/api/beta/delete-search-attribute-config.api.mdx @@ -0,0 +1,76 @@ +--- +id: delete-search-attribute-config +sidebar_label: Delete an extended search attribute in IdentityNow. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteSearchAttributeConfig","tags":["Search Attribute Configuration"],"description":"This API accepts an extended attribute name and deletes the corresponding extended attribute configuration.\nA token with ORG_ADMIN authority is required to call this API.","parameters":[{"name":"name","in":"path","description":"Name of the extended search attribute configuration to delete.","required":true,"schema":{"type":"string","example":"newMailAttribute"}}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/accounts/search-attribute-config/{name}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete an extended search attribute in IdentityNow.","description":{"content":"This API accepts an extended attribute name and deletes the corresponding extended attribute configuration.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts","search-attribute-config",":name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Name of the extended search attribute configuration to delete.","type":"text/plain"},"type":"any","value":"","key":"name"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete an extended search attribute in IdentityNow.' (delete-search-attribute-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete an extended search attribute in IdentityNow. + + + +This API accepts an extended attribute name and deletes the corresponding extended attribute configuration. +A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-segment.api.mdx b/products/idn/api/beta/delete-segment.api.mdx new file mode 100644 index 000000000..7263483ab --- /dev/null +++ b/products/idn/api/beta/delete-segment.api.mdx @@ -0,0 +1,79 @@ +--- +id: delete-segment +sidebar_label: Delete Segment by ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteSegment","tags":["Segments"],"description":"This API deletes the segment specified by the given ID.\n\nNote that segment deletion may take some time to become effective.\n\nA token with ORG_ADMIN or API authority is required to call this API.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the Segment to delete.","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"204":{"description":"No content."},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/segments/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete Segment by ID","description":{"content":"This API deletes the segment specified by the given ID.\n\nNote that segment deletion may take some time to become effective.\n\nA token with ORG_ADMIN or API authority is required to call this API.","type":"text/plain"},"url":{"path":["segments",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the Segment to delete.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Segment by ID' (delete-segment)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Segment by ID + + + +This API deletes the segment specified by the given ID. + +Note that segment deletion may take some time to become effective. + +A token with ORG_ADMIN or API authority is required to call this API. + +
Path Parameters
+ +No content. + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-service-desk-integration.api.mdx b/products/idn/api/beta/delete-service-desk-integration.api.mdx new file mode 100644 index 000000000..82d437d5e --- /dev/null +++ b/products/idn/api/beta/delete-service-desk-integration.api.mdx @@ -0,0 +1,87 @@ +--- +id: delete-service-desk-integration +sidebar_label: Delete a Service Desk integration +hide_title: true +hide_table_of_contents: true +api: {"tags":["Service Desk Integration"],"description":"Delete an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","operationId":"deleteServiceDeskIntegration","parameters":[{"name":"id","in":"path","description":"ID of Service Desk integration to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"anId"}}],"responses":{"204":{"description":"Service Desk integration with the given ID successfully deleted"},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:service-desk-admin:manage","idn:service-desk-integration:manage"]}],"method":"delete","path":"/service-desk-integrations/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete a Service Desk integration","description":{"content":"Delete an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","type":"text/plain"},"url":{"path":["service-desk-integrations",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of Service Desk integration to delete","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete a Service Desk integration' (delete-service-desk-integration)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete a Service Desk integration + + + +Delete an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +
Path Parameters
+ +Service Desk integration with the given ID successfully deleted + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-sod-policy-schedule.api.mdx b/products/idn/api/beta/delete-sod-policy-schedule.api.mdx new file mode 100644 index 000000000..30c6a7a40 --- /dev/null +++ b/products/idn/api/beta/delete-sod-policy-schedule.api.mdx @@ -0,0 +1,88 @@ +--- +id: delete-sod-policy-schedule +sidebar_label: Delete SOD policy schedule +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteSodPolicySchedule","tags":["SOD Policy"],"description":"This deletes schedule for a specified SOD policy.\nRequires role of ORG_ADMIN.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the SOD policy the schedule must be deleted for.","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"204":{"description":"No content."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/sod-policies/{id}/schedule","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete SOD policy schedule","description":{"content":"This deletes schedule for a specified SOD policy.\nRequires role of ORG_ADMIN.","type":"text/plain"},"url":{"path":["sod-policies",":id","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the SOD policy the schedule must be deleted for.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete SOD policy schedule' (delete-sod-policy-schedule)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete SOD policy schedule + + + +This deletes schedule for a specified SOD policy. +Requires role of ORG_ADMIN. + +
Path Parameters
+ +No content. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-sod-policy.api.mdx b/products/idn/api/beta/delete-sod-policy.api.mdx new file mode 100644 index 000000000..10e9d1e75 --- /dev/null +++ b/products/idn/api/beta/delete-sod-policy.api.mdx @@ -0,0 +1,88 @@ +--- +id: delete-sod-policy +sidebar_label: Delete SOD policy by ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteSodPolicy","tags":["SOD Policy"],"description":"This deletes a specified SOD policy.\nRequires role of ORG_ADMIN.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the SOD Policy to delete.","example":"ef38f94347e94562b5bb8424a56397d8"},{"in":"query","name":"logical","schema":{"type":"boolean","default":true},"description":"Indicates whether this is a soft delete (logical true) or a hard delete.","required":false}],"responses":{"204":{"description":"No content."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/sod-policies/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete SOD policy by ID","description":{"content":"This deletes a specified SOD policy.\nRequires role of ORG_ADMIN.","type":"text/plain"},"url":{"path":["sod-policies",":id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Indicates whether this is a soft delete (logical true) or a hard delete.","type":"text/plain"},"key":"logical","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the SOD Policy to delete.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete SOD policy by ID' (delete-sod-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete SOD policy by ID + + + +This deletes a specified SOD policy. +Requires role of ORG_ADMIN. + +
Path Parameters
Query Parameters
+ +No content. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-source-schema.api.mdx b/products/idn/api/beta/delete-source-schema.api.mdx new file mode 100644 index 000000000..8d986379b --- /dev/null +++ b/products/idn/api/beta/delete-source-schema.api.mdx @@ -0,0 +1,87 @@ +--- +id: delete-source-schema +sidebar_label: Delete Source Schema by ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteSourceSchema","tags":["Sources"],"parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source ID.","example":"2c9180835d191a86015d28455b4a2329"},{"in":"path","name":"schemaId","schema":{"type":"string"},"required":true,"description":"The Schema ID.","example":"2c9180835d191a86015d28455b4a2329"}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"description":"Delete Source Schema by ID","method":"delete","path":"/sources/{sourceId}/schemas/{schemaId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete Source Schema by ID","description":{"type":"text/plain"},"url":{"path":["sources",":sourceId","schemas",":schemaId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source ID.","type":"text/plain"},"type":"any","value":"","key":"sourceId"},{"disabled":false,"description":{"content":"(Required) The Schema ID.","type":"text/plain"},"type":"any","value":"","key":"schemaId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Source Schema by ID' (delete-source-schema)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Source Schema by ID + + + +Delete Source Schema by ID + +
Path Parameters
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-subscription.api.mdx b/products/idn/api/beta/delete-subscription.api.mdx new file mode 100644 index 000000000..dc94ce402 --- /dev/null +++ b/products/idn/api/beta/delete-subscription.api.mdx @@ -0,0 +1,87 @@ +--- +id: delete-subscription +sidebar_label: Delete a Subscription +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteSubscription","tags":["Triggers"],"description":"Deletes an existing subscription to a trigger.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Subscription ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["sp:trigger-service-subscriptions:manage"]}],"method":"delete","path":"/trigger-subscriptions/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete a Subscription","description":{"content":"Deletes an existing subscription to a trigger.","type":"text/plain"},"url":{"path":["trigger-subscriptions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Subscription ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete a Subscription' (delete-subscription)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete a Subscription + + + +Deletes an existing subscription to a trigger. + +
Path Parameters
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-tagged-object.api.mdx b/products/idn/api/beta/delete-tagged-object.api.mdx new file mode 100644 index 000000000..891e8044c --- /dev/null +++ b/products/idn/api/beta/delete-tagged-object.api.mdx @@ -0,0 +1,75 @@ +--- +id: delete-tagged-object +sidebar_label: Delete Tagged Object +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteTaggedObject","security":[{"oauth2":["idn:tag:manage"]}],"tags":["Tagged Objects"],"description":"This deletes a tagged object for the specified type.","parameters":[{"in":"path","name":"type","schema":{"type":"string","enum":["ROLE","IDENTITY","SOD_POLICY"]},"required":true,"description":"The type of tagged object to delete.","example":"ROLE"},{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the object reference to delete.","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"204":{"description":"No content."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/tagged-objects/{type}/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete Tagged Object","description":{"content":"This deletes a tagged object for the specified type.","type":"text/plain"},"url":{"path":["tagged-objects",":type",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The type of tagged object to delete.","type":"text/plain"},"type":"any","value":"","key":"type"},{"disabled":false,"description":{"content":"(Required) The ID of the object reference to delete.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Tagged Object' (delete-tagged-object)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Tagged Object + + + +This deletes a tagged object for the specified type. + +
Path Parameters
+ +No content. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-transform.api.mdx b/products/idn/api/beta/delete-transform.api.mdx new file mode 100644 index 000000000..bfedc3e2c --- /dev/null +++ b/products/idn/api/beta/delete-transform.api.mdx @@ -0,0 +1,88 @@ +--- +id: delete-transform +sidebar_label: Delete a transform +hide_title: true +hide_table_of_contents: true +api: {"tags":["Transforms"],"description":"Deletes the transform specified by the given ID.\nA token with transform delete authority is required to call this API.","operationId":"deleteTransform","parameters":[{"name":"id","in":"path","description":"ID of the transform to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"2c9180835d2e5168015d32f890ca1581"}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:transform:manage"]}],"method":"delete","path":"/transforms/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete a transform","description":{"content":"Deletes the transform specified by the given ID.\nA token with transform delete authority is required to call this API.","type":"text/plain"},"url":{"path":["transforms",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the transform to delete","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete a transform' (delete-transform)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete a transform + + + +Deletes the transform specified by the given ID. +A token with transform delete authority is required to call this API. + +
Path Parameters
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-verified-from-address.api.mdx b/products/idn/api/beta/delete-verified-from-address.api.mdx new file mode 100644 index 000000000..7c9e2ddaa --- /dev/null +++ b/products/idn/api/beta/delete-verified-from-address.api.mdx @@ -0,0 +1,87 @@ +--- +id: delete-verified-from-address +sidebar_label: Delete Verified From Address +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteVerifiedFromAddress","tags":["Notifications"],"description":"Delete a verified sender email address","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/verified-from-addresses/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete Verified From Address","description":{"content":"Delete a verified sender email address","type":"text/plain"},"url":{"path":["verified-from-addresses",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Verified From Address' (delete-verified-from-address)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Verified From Address + + + +Delete a verified sender email address + +
Path Parameters
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete-workflow.api.mdx b/products/idn/api/beta/delete-workflow.api.mdx new file mode 100644 index 000000000..cb71204a3 --- /dev/null +++ b/products/idn/api/beta/delete-workflow.api.mdx @@ -0,0 +1,75 @@ +--- +id: delete-workflow +sidebar_label: Delete Workflow By Id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteWorkflow","tags":["Workflows"],"description":"Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled.","security":[{"oauth2":["sp:workflow:manage"]}],"parameters":[{"name":"id","in":"path","description":"Id of the Workflow","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b"}}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/workflows/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete Workflow By Id","description":{"content":"Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled.","type":"text/plain"},"url":{"path":["workflows",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the Workflow","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Workflow By Id' (delete-workflow)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Workflow By Id + + + +Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. + +
Path Parameters
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/delete.api.mdx b/products/idn/api/beta/delete.api.mdx new file mode 100644 index 000000000..902cb37d3 --- /dev/null +++ b/products/idn/api/beta/delete.api.mdx @@ -0,0 +1,89 @@ +--- +id: delete +sidebar_label: Delete Source by ID +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:sources:manage"]}],"operationId":"delete","tags":["Sources"],"description":"This end-point deletes a specific source in IdentityNow.\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.\nAll of accounts on the source will be removed first, then the source will be deleted. Actual status of task execution can be retrieved via method GET `/task-status/{id}`","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Source ID","example":"2c9180835d191a86015d28455b4a2329"}],"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["TASK_RESULT"],"example":"TASK_RESULT"},"id":{"type":"string","description":"ID of the task result","example":"2c91808779ecf55b0179f720942f181a"},"name":{"type":"string","description":"Human-readable display name of the task result (should be null/empty)","example":null}}},"examples":{"deleteSource":{"summary":"Response returned when deleting a source","value":{"type":"TASK_RESULT","id":"2c91808779ecf55b0179f720942f181a","name":null}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/sources/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Delete Source by ID","description":{"content":"This end-point deletes a specific source in IdentityNow.\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.\nAll of accounts on the source will be removed first, then the source will be deleted. Actual status of task execution can be retrieved via method GET `/task-status/{id}`","type":"text/plain"},"url":{"path":["sources",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Source by ID' (delete)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Source by ID + + + +This end-point deletes a specific source in IdentityNow. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. +All of accounts on the source will be removed first, then the source will be deleted. Actual status of task execution can be retrieved via method GET `/task-status/{id}` + +
Path Parameters
+ +Accepted - Returned if the request was successfully accepted into the system. + +
Schema

Response returned when deleting a source

+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/disable-account-for-identity.api.mdx b/products/idn/api/beta/disable-account-for-identity.api.mdx new file mode 100644 index 000000000..5ca2fa186 --- /dev/null +++ b/products/idn/api/beta/disable-account-for-identity.api.mdx @@ -0,0 +1,87 @@ +--- +id: disable-account-for-identity +sidebar_label: Disable IDN Account for Identity +hide_title: true +hide_table_of_contents: true +api: {"operationId":"disableAccountForIdentity","tags":["Accounts"],"description":"This API submits a task to disable IDN account for a single identity.","externalDocs":{"description":"Learn more about disabling identities here","url":"https://documentation.sailpoint.com/saas/help/common/users/user_access.html#disabling-user-identities"},"security":[{"oauth2":["idn:accounts-state:manage"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity id.","example":"2c91808384203c2d018437e631158309"}],"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/identities-accounts/{id}/disable","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Disable IDN Account for Identity","description":{"content":"This API submits a task to disable IDN account for a single identity.","type":"text/plain"},"url":{"path":["identities-accounts",":id","disable"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identity id.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Disable IDN Account for Identity' (disable-account-for-identity)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Disable IDN Account for Identity + + + +This API submits a task to disable IDN account for a single identity. + +
Path Parameters
+ +Accepted - Returned if the request was successfully accepted into the system. + +
Schema
  • object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/disable-account.api.mdx b/products/idn/api/beta/disable-account.api.mdx new file mode 100644 index 000000000..984333e1e --- /dev/null +++ b/products/idn/api/beta/disable-account.api.mdx @@ -0,0 +1,88 @@ +--- +id: disable-account +sidebar_label: Disable Account +hide_title: true +hide_table_of_contents: true +api: {"operationId":"disableAccount","tags":["Accounts"],"description":"This API submits a task to disable the account and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:accounts-state:manage"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The account id","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"Request used for account enable/disable","type":"object","properties":{"externalVerificationId":{"description":"If set, an external process validates that the user wants to proceed with this request.","type":"string","example":"3f9180835d2e5168015d32f890ca1581"},"forceProvisioning":{"description":"If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated.","type":"boolean","example":false}}}}}},"responses":{"202":{"description":"Async task details","content":{"application/json":{"schema":{"description":"Accounts async response containing details on started async process","required":["id"],"type":"object","properties":{"id":{"description":"id of the task","type":"string","example":"2c91808474683da6017468693c260195"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/accounts/{id}/disable","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"externalVerificationId":"3f9180835d2e5168015d32f890ca1581","forceProvisioning":false},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Disable Account","description":{"content":"This API submits a task to disable the account and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts",":id","disable"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The account id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Disable Account' (disable-account)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Disable Account + + + +This API submits a task to disable the account and returns the task ID. +A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
Request Body required
+ +Async task details + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/disable-accounts-for-identities.api.mdx b/products/idn/api/beta/disable-accounts-for-identities.api.mdx new file mode 100644 index 000000000..3344c9539 --- /dev/null +++ b/products/idn/api/beta/disable-accounts-for-identities.api.mdx @@ -0,0 +1,75 @@ +--- +id: disable-accounts-for-identities +sidebar_label: Disable IDN Accounts for Identities +hide_title: true +hide_table_of_contents: true +api: {"operationId":"disableAccountsForIdentities","tags":["Accounts"],"description":"This API submits tasks to disable IDN account for each identity provided in the request body.","externalDocs":{"description":"Learn more about disabling identities here","url":"https://documentation.sailpoint.com/saas/help/common/users/user_access.html#disabling-user-identities"},"security":[{"oauth2":["idn:accounts-state:manage"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityIds":{"description":"The ids of the identities for which enable/disable accounts.","type":"array","items":{"type":"string"},"example":["2c91808384203c2d018437e631158308","2c9180858082150f0180893dbaf553fe"]}}}}}},"responses":{"207":{"description":"Bulk response details.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Bulk response object.","properties":{"id":{"type":"string","description":"Identifier of bulk request item.","example":"2c9180858082150f0180893dbaf553fe"},"statusCode":{"type":"integer","format":"int32","description":"Response status value.","example":404},"message":{"type":"string","description":"Status containing additional context information about failures.","example":"Referenced identity \"2c9180858082150f0180893dbaf553fe\" was not found."}}},"example":[{"id":"2c9180858082150f0180893dbaf553fe","statusCode":404,"message":"Referenced identity \"2c9180858082150f0180893dbaf553fe\" was not found."},{"id":"2c91808384203c2d018437e631158308","statusCode":202,"message":null}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/identities-accounts/disable","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"identityIds":["2c91808384203c2d018437e631158308","2c9180858082150f0180893dbaf553fe"]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Disable IDN Accounts for Identities","description":{"content":"This API submits tasks to disable IDN account for each identity provided in the request body.","type":"text/plain"},"url":{"path":["identities-accounts","disable"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Disable IDN Accounts for Identities' (disable-accounts-for-identities)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Disable IDN Accounts for Identities + + + +This API submits tasks to disable IDN account for each identity provided in the request body. + +
Request Body required
+ +Bulk response details. + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/download-custom-violation-report.api.mdx b/products/idn/api/beta/download-custom-violation-report.api.mdx new file mode 100644 index 000000000..743bb3d64 --- /dev/null +++ b/products/idn/api/beta/download-custom-violation-report.api.mdx @@ -0,0 +1,88 @@ +--- +id: download-custom-violation-report +sidebar_label: Download custom violation report +hide_title: true +hide_table_of_contents: true +api: {"operationId":"downloadCustomViolationReport","tags":["SOD Policy"],"description":"This allows to download a specified named violation report for a given report reference.\nRequires role of ORG_ADMIN.","parameters":[{"in":"path","name":"reportResultId","schema":{"type":"string"},"required":true,"description":"The ID of the report reference to download.","example":"ef38f94347e94562b5bb8424a56397d8"},{"in":"path","name":"fileName","schema":{"type":"string"},"required":true,"description":"Custom Name for the file.","example":"custom-name"}],"responses":{"200":{"description":"Returns the zip file with given custom name that contains the violation report file.","content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sod-violation-report/{reportResultId}/download/{fileName}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Download custom violation report","description":{"content":"This allows to download a specified named violation report for a given report reference.\nRequires role of ORG_ADMIN.","type":"text/plain"},"url":{"path":["sod-violation-report",":reportResultId","download",":fileName"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the report reference to download.","type":"text/plain"},"type":"any","value":"","key":"reportResultId"},{"disabled":false,"description":{"content":"(Required) Custom Name for the file.","type":"text/plain"},"type":"any","value":"","key":"fileName"}]},"header":[{"key":"Accept","value":"application/zip"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Download custom violation report' (download-custom-violation-report)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Download custom violation report + + + +This allows to download a specified named violation report for a given report reference. +Requires role of ORG_ADMIN. + +
Path Parameters
+ +Returns the zip file with given custom name that contains the violation report file. + +
Schema
  • string binary
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/download-default-violation-report.api.mdx b/products/idn/api/beta/download-default-violation-report.api.mdx new file mode 100644 index 000000000..8836e9b7e --- /dev/null +++ b/products/idn/api/beta/download-default-violation-report.api.mdx @@ -0,0 +1,88 @@ +--- +id: download-default-violation-report +sidebar_label: Download violation report +hide_title: true +hide_table_of_contents: true +api: {"operationId":"downloadDefaultViolationReport","tags":["SOD Policy"],"description":"This allows to download a violation report for a given report reference.\nRequires role of ORG_ADMIN.","parameters":[{"in":"path","name":"reportResultId","schema":{"type":"string"},"required":true,"description":"The ID of the report reference to download.","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"Returns the PolicyReport.zip that contains the violation report file.","content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sod-violation-report/{reportResultId}/download","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Download violation report","description":{"content":"This allows to download a violation report for a given report reference.\nRequires role of ORG_ADMIN.","type":"text/plain"},"url":{"path":["sod-violation-report",":reportResultId","download"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the report reference to download.","type":"text/plain"},"type":"any","value":"","key":"reportResultId"}]},"header":[{"key":"Accept","value":"application/zip"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Download violation report' (download-default-violation-report)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Download violation report + + + +This allows to download a violation report for a given report reference. +Requires role of ORG_ADMIN. + +
Path Parameters
+ +Returns the PolicyReport.zip that contains the violation report file. + +
Schema
  • string binary
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/download-role-insights-entitlements-changes.api.mdx b/products/idn/api/beta/download-role-insights-entitlements-changes.api.mdx new file mode 100644 index 000000000..fef658c73 --- /dev/null +++ b/products/idn/api/beta/download-role-insights-entitlements-changes.api.mdx @@ -0,0 +1,71 @@ +--- +id: download-role-insights-entitlements-changes +sidebar_label: Download entitlement insights for a role +hide_title: true +hide_table_of_contents: true +api: {"operationId":"downloadRoleInsightsEntitlementsChanges","tags":["Role Insights"],"description":"This endpoint returns the entitlement insights for a role.","parameters":[{"in":"path","name":"insightId","schema":{"type":"string"},"required":true,"description":"The role insight id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"query","name":"sorters","description":"sort by identitiesWithAccess, default order descending","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"in":"query","name":"filters","description":"Filter parameter(s) by \"starts with\" for the name and description.","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Succeeded. Returns a csv file containing a list of entitlements to be added for a role.","content":{"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/role-insights/{insightId}/entitlement-changes/download","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Download entitlement insights for a role","description":{"content":"This endpoint returns the entitlement insights for a role.","type":"text/plain"},"url":{"path":["role-insights",":insightId","entitlement-changes","download"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"sort by identitiesWithAccess, default order descending","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"Filter parameter(s) by \"starts with\" for the name and description.","type":"text/plain"},"key":"filters","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The role insight id","type":"text/plain"},"type":"any","value":"","key":"insightId"}]},"header":[{"key":"Accept","value":"text/csv"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Download entitlement insights for a role' (download-role-insights-entitlements-changes)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Download entitlement insights for a role + + + +This endpoint returns the entitlement insights for a role. + +
Path Parameters
Query Parameters
+ +Succeeded. Returns a csv file containing a list of entitlements to be added for a role. + +
Schema
  • string
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/download-role-mining-potential-role-zip.api.mdx b/products/idn/api/beta/download-role-mining-potential-role-zip.api.mdx new file mode 100644 index 000000000..bd11014c9 --- /dev/null +++ b/products/idn/api/beta/download-role-mining-potential-role-zip.api.mdx @@ -0,0 +1,71 @@ +--- +id: download-role-mining-potential-role-zip +sidebar_label: Export (download) details for a potential role in a role mining session +hide_title: true +hide_table_of_contents: true +api: {"operationId":"downloadRoleMiningPotentialRoleZip","tags":["IAI Role Mining"],"description":"This endpoint downloads a completed export of information for a potential role in a role mining session.","parameters":[{"in":"path","name":"sessionId","schema":{"type":"string","format":"uuid"},"required":true,"description":"The role mining session id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"path","name":"potentialRoleId","schema":{"type":"string","format":"uuid"},"required":true,"description":"A potential role id in a role mining session","example":"278359a6-04b7-4669-9468-924cf580964a"},{"in":"path","name":"exportId","schema":{"type":"string","format":"uuid"},"required":true,"description":"The id of a previously run export job for this potential role","example":"4940ffd4-836f-48a3-b2b0-6d498c3fdf40"}],"responses":{"200":{"description":"Succeeded. Returns a zip file containing csv files for identities and entitlements for the potential role.","content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Export (download) details for a potential role in a role mining session","description":{"content":"This endpoint downloads a completed export of information for a potential role in a role mining session.","type":"text/plain"},"url":{"path":["role-mining-sessions",":sessionId","potential-roles",":potentialRoleId","export-async",":exportId","download"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The role mining session id","type":"text/plain"},"type":"any","value":"","key":"sessionId"},{"disabled":false,"description":{"content":"(Required) A potential role id in a role mining session","type":"text/plain"},"type":"any","value":"","key":"potentialRoleId"},{"disabled":false,"description":{"content":"(Required) The id of a previously run export job for this potential role","type":"text/plain"},"type":"any","value":"","key":"exportId"}]},"header":[{"key":"Accept","value":"application/zip"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Export (download) details for a potential role in a role mining session' (download-role-mining-potential-role-zip)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Export (download) details for a potential role in a role mining session + + + +This endpoint downloads a completed export of information for a potential role in a role mining session. + +
Path Parameters
+ +Succeeded. Returns a zip file containing csv files for identities and entitlements for the potential role. + +
Schema
  • string binary
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/enable-account-for-identity.api.mdx b/products/idn/api/beta/enable-account-for-identity.api.mdx new file mode 100644 index 000000000..ed020952f --- /dev/null +++ b/products/idn/api/beta/enable-account-for-identity.api.mdx @@ -0,0 +1,87 @@ +--- +id: enable-account-for-identity +sidebar_label: Enable IDN Account for Identity +hide_title: true +hide_table_of_contents: true +api: {"operationId":"enableAccountForIdentity","tags":["Accounts"],"description":"This API submits a task to enable IDN account for a single identity.","externalDocs":{"description":"Learn more about enabling identities here","url":"https://documentation.sailpoint.com/saas/help/common/users/user_access.html#enabling-user-identities"},"security":[{"oauth2":["idn:accounts-state:manage"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity id.","example":"2c91808384203c2d018437e631158309"}],"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/identities-accounts/{id}/enable","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Enable IDN Account for Identity","description":{"content":"This API submits a task to enable IDN account for a single identity.","type":"text/plain"},"url":{"path":["identities-accounts",":id","enable"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identity id.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Enable IDN Account for Identity' (enable-account-for-identity)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Enable IDN Account for Identity + + + +This API submits a task to enable IDN account for a single identity. + +
Path Parameters
+ +Accepted - Returned if the request was successfully accepted into the system. + +
Schema
  • object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/enable-account.api.mdx b/products/idn/api/beta/enable-account.api.mdx new file mode 100644 index 000000000..88e541909 --- /dev/null +++ b/products/idn/api/beta/enable-account.api.mdx @@ -0,0 +1,88 @@ +--- +id: enable-account +sidebar_label: Enable Account +hide_title: true +hide_table_of_contents: true +api: {"operationId":"enableAccount","tags":["Accounts"],"description":"This API submits a task to enable account and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:accounts-state:manage"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The account id","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"Request used for account enable/disable","type":"object","properties":{"externalVerificationId":{"description":"If set, an external process validates that the user wants to proceed with this request.","type":"string","example":"3f9180835d2e5168015d32f890ca1581"},"forceProvisioning":{"description":"If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated.","type":"boolean","example":false}}}}}},"responses":{"202":{"description":"Async task details","content":{"application/json":{"schema":{"description":"Accounts async response containing details on started async process","required":["id"],"type":"object","properties":{"id":{"description":"id of the task","type":"string","example":"2c91808474683da6017468693c260195"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/accounts/{id}/enable","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"externalVerificationId":"3f9180835d2e5168015d32f890ca1581","forceProvisioning":false},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Enable Account","description":{"content":"This API submits a task to enable account and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts",":id","enable"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The account id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Enable Account' (enable-account)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Enable Account + + + +This API submits a task to enable account and returns the task ID. +A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
Request Body required
+ +Async task details + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/enable-accounts-for-identities.api.mdx b/products/idn/api/beta/enable-accounts-for-identities.api.mdx new file mode 100644 index 000000000..aec08e4c1 --- /dev/null +++ b/products/idn/api/beta/enable-accounts-for-identities.api.mdx @@ -0,0 +1,75 @@ +--- +id: enable-accounts-for-identities +sidebar_label: Enable IDN Accounts for Identities +hide_title: true +hide_table_of_contents: true +api: {"operationId":"enableAccountsForIdentities","tags":["Accounts"],"description":"This API submits tasks to enable IDN account for each identity provided in the request body.","externalDocs":{"description":"Learn more about enabling identities here","url":"https://documentation.sailpoint.com/saas/help/common/users/user_access.html#enabling-user-identities"},"security":[{"oauth2":["idn:accounts-state:manage"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityIds":{"description":"The ids of the identities for which enable/disable accounts.","type":"array","items":{"type":"string"},"example":["2c91808384203c2d018437e631158308","2c9180858082150f0180893dbaf553fe"]}}}}}},"responses":{"207":{"description":"Bulk response details.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Bulk response object.","properties":{"id":{"type":"string","description":"Identifier of bulk request item.","example":"2c9180858082150f0180893dbaf553fe"},"statusCode":{"type":"integer","format":"int32","description":"Response status value.","example":404},"message":{"type":"string","description":"Status containing additional context information about failures.","example":"Referenced identity \"2c9180858082150f0180893dbaf553fe\" was not found."}}},"example":[{"id":"2c9180858082150f0180893dbaf553fe","statusCode":404,"message":"Referenced identity \"2c9180858082150f0180893dbaf553fe\" was not found."},{"id":"2c91808384203c2d018437e631158308","statusCode":202,"message":null}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/identities-accounts/enable","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"identityIds":["2c91808384203c2d018437e631158308","2c9180858082150f0180893dbaf553fe"]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Enable IDN Accounts for Identities","description":{"content":"This API submits tasks to enable IDN account for each identity provided in the request body.","type":"text/plain"},"url":{"path":["identities-accounts","enable"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Enable IDN Accounts for Identities' (enable-accounts-for-identities)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Enable IDN Accounts for Identities + + + +This API submits tasks to enable IDN account for each identity provided in the request body. + +
Request Body required
+ +Bulk response details. + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/entitlements.tag.mdx b/products/idn/api/beta/entitlements.tag.mdx new file mode 100644 index 000000000..2faf1fb48 --- /dev/null +++ b/products/idn/api/beta/entitlements.tag.mdx @@ -0,0 +1,69 @@ +--- +id: entitlements +title: "Entitlements" +description: "Entitlements" +custom_edit_url: null +--- + + + +Use this API to implement and customize entitlement functionality. +With this functionality in place, administrators can view entitlements and configure them for use throughout IdentityNow in certifications, access profiles, and roles. +Administrators in IdentityNow can then grant users access to the entitlements or configure them so users themselves can request access to the entitlements whenever they need them. +With a good approval process, this entitlement functionality allows users to gain the specific access they need on sources quickly and securely. + +Entitlements represent access rights on sources. +Entitlements are the most granular form of access in IdentityNow. +Entitlements are often grouped into access profiles, and access profiles themselves are often grouped into roles, the broadest form of access in IdentityNow. + +For example, an Active Directory source in IdentityNow can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +An administrator can then create an even broader set of access in the form of a role grouping the 'AD Developers' access profile with another profile, 'GitHub Developers,' grouping entitlements for the GitHub source. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +When users need both the 'AD Developers' access profile and the 'GitHub Developers' access profile, they can request access to the role grouping both. + +Administrators often use roles and access profiles within those roles to manage access so that users can gain access more quickly, but the hierarchy of access all starts with entitlements. + +Anywhere entitlements appear, you can select them to find more information about the following: + +- Cloud Access Details: These provide details about the cloud access entitlements on cloud-enabled sources. + +- Permissions: Permissions represent individual units of read/write/admin access to a system. + +- Relationships: These list each entitlement's parent and child relationships. + +- Type: This is the entitlement's type. Some sources support multiple types, each with a different attribute schema. + +IdentityNow uses entitlements in many features, including the following: + +- Certifications: Entitlements can be revoked from an identity that no longer needs them. + +- Roles: Roles can group access profiles which themselves group entitlements. You can grant and revoke access on a broad level with roles. Role membership criteria can grant roles to identities based on whether they have certain entitlements or attributes. + +- Access Profiles: Access profiles group entitlements. +They are the most important units of access in IdentityNow. +IdentityNow uses them in provisioning, certifications, and access requests, and administrators can configure them to grant very broad or very granular access. + +You cannot delete entitlements directly from IdentityNow. +Entitlements are deleted based on their inclusion in aggregations. + +Refer to [Deleting Entitlements](https://documentation.sailpoint.com/saas/help/access/entitlements.html#deleting-entitlements) more information about deleting entitlements. + +Refer to [Entitlements](https://documentation.sailpoint.com/saas/help/access/entitlements.html) for more information about entitlements. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/export-form-definitions-by-tenant.api.mdx b/products/idn/api/beta/export-form-definitions-by-tenant.api.mdx new file mode 100644 index 000000000..2f9d28a96 --- /dev/null +++ b/products/idn/api/beta/export-form-definitions-by-tenant.api.mdx @@ -0,0 +1,83 @@ +--- +id: export-form-definitions-by-tenant +sidebar_label: List form definitions by tenant. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Custom Forms"],"description":"No parameters required.","operationId":"exportFormDefinitionsByTenant","parameters":[{"name":"offset","in":"query","description":"Offset\n\nInteger specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nThe offset value is record-based, not page-based, and the index starts at 0.","schema":{"type":"integer","format":"int64","default":0,"x-go-name":"Offset"},"example":0,"required":false,"x-go-name":"Offset"},{"name":"limit","in":"query","description":"Limit\n\nInteger 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).\nIf it is not specified, a default limit is used.","schema":{"type":"integer","format":"int64","maxLength":250,"minLength":0,"default":250,"x-go-name":"Limit"},"example":250,"required":false,"x-go-name":"Limit"},{"name":"filters","in":"query","description":"Filters\n\nFilter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\nname: eq, gt, sw, in\ndescription: eq, gt, sw, in\ncreated: eq, gt, sw, in\nmodified: eq, gt, sw, in","schema":{"type":"string","x-go-name":"Filters"},"example":"name sw \"my form\"","required":false,"x-go-name":"Filters"},{"name":"sorters","in":"query","description":"Sorters\n\nItem will be sorted in the returned array if the sorters expression evaluates to true for that item. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/#sorting-results).\nSorting is supported for the following fields:\nname\ndescription\ncreated\nmodified","schema":{"type":"string","default":"name","x-go-name":"Sorters"},"example":"name","required":false,"x-go-name":"Sorters"}],"responses":{"200":{"description":"Returns a list of form definition objects by tenant used by SP-Config","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"object":{"properties":{"created":{"description":"Created is the date the form definition was created","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Created"},"description":{"description":"Description is the form definition description","example":"My form description","type":"string","x-go-name":"Description"},"formConditions":{"description":"FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form","items":{"description":"FormCondition represent a form conditional","properties":{"effects":{"description":"Effects is a list of effects","items":{"description":"ConditionEffect is the effect produced by a condition","properties":{"config":{"additionalProperties":{},"description":"Config is a arbitrary map that holds a configuration based on EffectType","example":{},"type":"object","x-go-name":"Config"},"effectType":{"description":"EffectType is the type of effect to perform when the conditions are evaluated for this logic block\nHIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","enum":["HIDE","SHOW","DISABLE","ENABLE","REQUIRE","OPTIONAL","SUBMIT_MESSAGE","SUBMIT_NOTIFICATION","SET_DEFAULT_VALUE"],"example":"HIDE","type":"string","x-go-enum-desc":"HIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","x-go-name":"EffectType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Effects"},"ruleOperator":{"description":"RuleOperator is a ConditionRuleLogicalOperatorType value\nAND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","enum":["AND","OR"],"example":"AND","type":"string","x-go-enum-desc":"AND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","x-go-name":"RuleOperator"},"rules":{"description":"Rules is a list of rules","items":{"properties":{"operator":{"description":"Operator is a ConditionRuleComparisonOperatorType value\nEQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","enum":["EQ","NE","CO","NOT_CO","IN","NOT_IN","EM","NOT_EM","SW","NOT_SW","EW","NOT_EW"],"example":"EQ","type":"string","x-go-enum-desc":"EQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","x-go-name":"Operator"},"source":{"description":"Source, if the sourceType is ConditionRuleSourceTypeInput then the source type is the name of the form input to accept. While if the sourceType is ConditionRuleSourceTypeElement\nthen source is the name of a technical key of an element to retrieve its value","example":"department","type":"string","x-go-name":"Source"},"sourceType":{"description":"SourceType defines what type of object is being selected. Either a reference to a form input (by input name), or a form element (by technical key)\nINPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","enum":["INPUT","ELEMENT"],"example":"ELEMENT","type":"string","x-go-enum-desc":"INPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","x-go-name":"SourceType"},"value":{"description":"Value is the value based on the ValueType","example":"Engineering","x-go-name":"Value"},"valueType":{"description":"ValueType is a ConditionRuleValueType type\nSTRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","enum":["STRING","STRING_LIST","INPUT","ELEMENT","LIST","BOOLEAN"],"example":"STRING","type":"string","x-go-enum-desc":"STRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","x-go-name":"ValueType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Rules"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormConditions"},"formElements":{"description":"FormElements is a list of nested form elements","items":{"properties":{"config":{"additionalProperties":{},"description":"Config is a config object","example":{"label":"Department"},"type":"object","x-go-name":"Config"},"elementType":{"description":"ElementType is a FormElementType value\nTEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","enum":["TEXT","TOGGLE","TEXTAREA","HIDDEN","PHONE","EMAIL","SELECT","DATE","SECTION","COLUMNS"],"example":"TEXT","type":"string","x-go-enum-desc":"TEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","x-go-name":"ElementType"},"id":{"description":"ID is a form element identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"key":{"description":"Key is the technical key","example":"department","type":"string","x-go-name":"Key"},"validations":{"description":"FormElementValidationsSet is a set of FormElementValidation items","example":[{"validationType":"REQUIRED"}],"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormElements"},"formInput":{"description":"FormInput is a list of form inputs that are required when creating a form-instance object","items":{"properties":{"description":{"description":"Description is the description for this form input value","example":"A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic","type":"string","x-go-name":"Description"},"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"label":{"description":"Label is the name for this form input value","example":"input1","type":"string","x-go-name":"Label"},"type":{"description":"Type is a FormDefinitionInputType value\nSTRING FormDefinitionInputTypeString","enum":["STRING"],"example":"STRING","type":"string","x-go-enum-desc":"STRING FormDefinitionInputTypeString","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormInput"},"id":{"description":"FormDefinitionID is a unique guid identifying this form definition","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"FormDefinitionID"},"modified":{"description":"Modified is the last date the form definition was modified","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Modified"},"name":{"description":"Name is the form definition name","example":"My form","type":"string","x-go-name":"Name"},"owner":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a FormOwnerType value\nIDENTITY FormOwnerTypeIdentity","enum":["IDENTITY"],"example":"IDENTITY","type":"string","x-go-enum-desc":"IDENTITY FormOwnerTypeIdentity","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"usedBy":{"description":"UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used","items":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a FormUsedByType value\nWORKFLOW FormUsedByTypeWorkflow\nSOURCE FormUsedByTypeSource","enum":["WORKFLOW","SOURCE"],"example":"WORKFLOW","type":"string","x-go-enum-desc":"WORKFLOW FormUsedByTypeWorkflow\nSOURCE FormUsedByTypeSource","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"UsedBy"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"self":{"type":"string","x-go-name":"Self"},"version":{"type":"integer","format":"int8","x-go-name":"Version"}}}}}}},"400":{"description":"An error with the request occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"401":{"description":"An error with the authorization occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"403":{"description":"An error with the user permissions occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"title":"Error is the standard API error response type.","type":"object","properties":{"detailCode":{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"trackingId":{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"}}}},"500":{"description":"An internal server error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}}},"security":[{"oauth2":["sp:forms:manage"]}],"method":"get","path":"/form-definitions/export","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List form definitions by tenant.","description":{"content":"No parameters required.","type":"text/plain"},"url":{"path":["form-definitions","export"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Offset\n\nInteger specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nThe offset value is record-based, not page-based, and the index starts at 0.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Limit\n\nInteger 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).\nIf it is not specified, a default limit is used.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Filters\n\nFilter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\nname: eq, gt, sw, in\ndescription: eq, gt, sw, in\ncreated: eq, gt, sw, in\nmodified: eq, gt, sw, in","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sorters\n\nItem will be sorted in the returned array if the sorters expression evaluates to true for that item. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/#sorting-results).\nSorting is supported for the following fields:\nname\ndescription\ncreated\nmodified","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List form definitions by tenant.' (export-form-definitions-by-tenant)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List form definitions by tenant. + + + +No parameters required. + +
Query Parameters
    name: eq, gt, sw, in\ndescription: eq, gt, sw, in\ncreated: eq, gt, sw, in\nmodified: eq, gt, sw, in","schema":{"type":"string","x-go-name":"Filters"},"example":"name sw \"my form\"","required":false,"x-go-name":"Filters"}}>name\ndescription\ncreated\nmodified","schema":{"type":"string","default":"name","x-go-name":"Sorters"},"example":"name","required":false,"x-go-name":"Sorters"}}>
+ +Returns a list of form definition objects by tenant used by SP-Config + +
Schema array
    object object
    formConditions object[]
    + +FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form + +
    effects object[]
    + +Effects is a list of effects + +
    config object
    + +Config is a arbitrary map that holds a configuration based on EffectType + +
    rules object[]
    + +Rules is a list of rules + +
    formElements object[]
    + +FormElements is a list of nested form elements + +
    config object
    + +Config is a config object + +
    formInput object[]
    + +FormInput is a list of form inputs that are required when creating a form-instance object + +
    owner object
    usedBy object[]
    + +UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used + +
+ +An error with the request occurred + +
Schema
    messages object[]
+ +An error with the authorization occurred + +
Schema
    messages object[]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
+ +Too many requests + +
Schema
    messages object[]
+ +An internal server error occurred + +
Schema
    messages object[]
\ No newline at end of file diff --git a/products/idn/api/beta/export-identity-profiles.api.mdx b/products/idn/api/beta/export-identity-profiles.api.mdx new file mode 100644 index 000000000..afb53b3fb --- /dev/null +++ b/products/idn/api/beta/export-identity-profiles.api.mdx @@ -0,0 +1,103 @@ +--- +id: export-identity-profiles +sidebar_label: Export Identity Profiles +hide_title: true +hide_table_of_contents: true +api: {"operationId":"exportIdentityProfiles","tags":["Identity Profiles"],"description":"This exports existing identity profiles in the format specified by the sp-config service.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, ne*\n\n**name**: *eq, ne*\n\n**priority**: *eq, ne*","example":"id eq 8c190e6787aa4ed9a90bd9d5344523fb"},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **id**, **name**, **priority**","example":"name,-priority"}],"responses":{"200":{"description":"List of export objects with identity profiles.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Identity Profile exported object","properties":{"version":{"type":"integer","example":1,"description":"Version or object from the target service."},"self":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"object":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true},"modified":{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}},{"type":"object","required":["authoritativeSource"],"properties":{"description":{"type":"string","description":"The description of the Identity Profile.","example":"My custom flat file profile","nullable":true},"owner":{"type":"object","description":"The owner of the Identity Profile.","nullable":true,"properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Type of the object to which this reference applies","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"priority":{"type":"integer","format":"int64","description":"The priority for an Identity Profile.","example":10},"authoritativeSource":{"type":"object","properties":{"type":{"type":"string","enum":["SOURCE"],"description":"Type of the object to which this reference applies","example":"SOURCE"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"HR Active Directory"}}},"identityRefreshRequired":{"type":"boolean","default":false,"description":"True if a identity refresh is needed. Typically triggered when a change on the source has been made.","example":true},"identityCount":{"type":"integer","description":"The number of identities that belong to the Identity Profile.","format":"int32","example":8},"identityAttributeConfig":{"type":"object","description":"Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process.","properties":{"enabled":{"description":"The backend will only promote values if the profile/mapping is enabled.","type":"boolean","default":false,"example":true},"attributeTransforms":{"type":"array","items":{"type":"object","description":"Defines a transformation definition for an identity attribute.","properties":{"identityAttributeName":{"type":"string","description":"Name of the identity attribute.","example":"email"},"transformDefinition":{"description":"The seaspray transformation definition.","type":"object","properties":{"type":{"type":"string","description":"The type of the transform definition.","example":"accountAttribute"},"attributes":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"object"}]},"description":"Arbitrary key-value pairs to store any metadata for the object","example":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}}}}}}}}},"identityExceptionReportReference":{"type":"object","nullable":true,"properties":{"taskResultId":{"type":"string","format":"uuid","description":"The id of the task result.","example":"2b838de9-db9b-abcf-e646-d4f274ad4238"},"reportName":{"type":"string","example":"My annual report","description":"The name of the report."}}},"hasTimeBasedAttr":{"description":"Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile.","type":"boolean","default":false,"example":true}}}]}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:identity-profile:read","idn:identity-profile:manage"]}],"method":"get","path":"/identity-profiles/export","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Export Identity Profiles","description":{"content":"This exports existing identity profiles in the format specified by the sp-config service.","type":"text/plain"},"url":{"path":["identity-profiles","export"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, ne*\n\n**name**: *eq, ne*\n\n**priority**: *eq, ne*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **id**, **name**, **priority**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Export Identity Profiles' (export-identity-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Export Identity Profiles + + + +This exports existing identity profiles in the format specified by the sp-config service. + +
Query Parameters
+ +List of export objects with identity profiles. + +
Schema array
    self object
    object object
    owner object
    + +The owner of the Identity Profile. + +
    authoritativeSource object
    identityAttributeConfig object
    + +Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. + +
    attributeTransforms object[]
    transformDefinition object
    + +The seaspray transformation definition. + +
    attributes object
    + +Arbitrary key-value pairs to store any metadata for the object + +
    identityExceptionReportReference object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/export-non-employee-records.api.mdx b/products/idn/api/beta/export-non-employee-records.api.mdx new file mode 100644 index 000000000..9c7f6af72 --- /dev/null +++ b/products/idn/api/beta/export-non-employee-records.api.mdx @@ -0,0 +1,87 @@ +--- +id: export-non-employee-records +sidebar_label: Exports Non-Employee Records to CSV +hide_title: true +hide_table_of_contents: true +api: {"operationId":"exportNonEmployeeRecords","security":[{"oauth2":["idn:nelm:read","idn:nelm:manage"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This requests a CSV download for all non-employees from a provided source.","parameters":[{"in":"path","example":"2c918085842e69ae018432d22ccb212f","name":"id","description":"Source Id (UUID)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Exported CSV","content":{"text/csv":{"example":"accountName,firstName,lastName,phone,email,manager,startDate,endDate\nJon.Smith, Jon, Smith, 555-555-5555, jon@jon.doe.nope.com, Jim Smith, 2020-04-05T08:00:00-10:00,2020-08-07T19:00:00-10:00\nWilliam.Chaffin, William, Chaffin, 555-555-5555, william@chaffins.nope.com, Bertram Chaffin, 2020-04-05T08:00:00-10:00,2020-08-07T19:00:00-10:00\n"}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-sources/{id}/non-employees/download","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Exports Non-Employee Records to CSV","description":{"content":"This requests a CSV download for all non-employees from a provided source.","type":"text/plain"},"url":{"path":["non-employee-sources",":id","non-employees","download"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Source Id (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"text/csv"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Exports Non-Employee Records to CSV' (export-non-employee-records)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Exports Non-Employee Records to CSV + + + +This requests a CSV download for all non-employees from a provided source. + +
Path Parameters
+ +Exported CSV + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/export-non-employee-source-schema-template.api.mdx b/products/idn/api/beta/export-non-employee-source-schema-template.api.mdx new file mode 100644 index 000000000..154309ea4 --- /dev/null +++ b/products/idn/api/beta/export-non-employee-source-schema-template.api.mdx @@ -0,0 +1,89 @@ +--- +id: export-non-employee-source-schema-template +sidebar_label: Exports Source Schema Template +hide_title: true +hide_table_of_contents: true +api: {"operationId":"exportNonEmployeeSourceSchemaTemplate","security":[{"oauth2":["idn:nelm:read"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This requests a download for the Source Schema Template for a provided source.\nRequest will require the following security scope:\nidn:nesr:read'","parameters":[{"in":"path","example":"2c918085842e69ae018432d22ccb212f","name":"id","description":"Source Id (UUID)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Exported Source Schema Template","content":{"text/csv":{"example":"accountName,firstName,lastName,phone,email,manager,startDate,endDate\n"}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-sources/{id}/schema-attributes-template/download","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Exports Source Schema Template","description":{"content":"This requests a download for the Source Schema Template for a provided source.\nRequest will require the following security scope:\nidn:nesr:read'","type":"text/plain"},"url":{"path":["non-employee-sources",":id","schema-attributes-template","download"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Source Id (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"text/csv"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Exports Source Schema Template' (export-non-employee-source-schema-template)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Exports Source Schema Template + + + +This requests a download for the Source Schema Template for a provided source. +Request will require the following security scope: +idn:nesr:read' + +
Path Parameters
+ +Exported Source Schema Template + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/export-outliers-zip.api.mdx b/products/idn/api/beta/export-outliers-zip.api.mdx new file mode 100644 index 000000000..ceb86aa9d --- /dev/null +++ b/products/idn/api/beta/export-outliers-zip.api.mdx @@ -0,0 +1,76 @@ +--- +id: export-outliers-zip +sidebar_label: IAI Identity Outliers Export +hide_title: true +hide_table_of_contents: true +api: {"operationId":"exportOutliersZip","tags":["IAI Outliers"],"description":"This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported Columns will include: identityID, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes)\nRequires authorization scope of 'iai:outliers-management:read'","parameters":[{"name":"type","in":"query","description":"Type of the identity outliers snapshot to filter on","required":false,"schema":{"type":"string","enum":["LOW_SIMILARITY","STRUCTURAL"]}}],"responses":{"200":{"description":"Succeeded. Returns zip of 2 CSVs to download. 1 CSV for ignored outliers and 1 for non-ignored outliers","content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/outliers/export","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"IAI Identity Outliers Export","description":{"content":"This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported Columns will include: identityID, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes)\nRequires authorization scope of 'iai:outliers-management:read'","type":"text/plain"},"url":{"path":["outliers","export"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Type of the identity outliers snapshot to filter on","type":"text/plain"},"key":"type","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/zip"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'IAI Identity Outliers Export' (export-outliers-zip)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## IAI Identity Outliers Export + + + +This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported Columns will include: identityID, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes) +Requires authorization scope of 'iai:outliers-management:read' + +
Query Parameters
+ +Succeeded. Returns zip of 2 CSVs to download. 1 CSV for ignored outliers and 1 for non-ignored outliers + +
Schema
  • string binary
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/export-role-mining-potential-role-async.api.mdx b/products/idn/api/beta/export-role-mining-potential-role-async.api.mdx new file mode 100644 index 000000000..ac9a2bfb6 --- /dev/null +++ b/products/idn/api/beta/export-role-mining-potential-role-async.api.mdx @@ -0,0 +1,71 @@ +--- +id: export-role-mining-potential-role-async +sidebar_label: Asynchronously export details for a potential role in a role mining session and upload to S3 +hide_title: true +hide_table_of_contents: true +api: {"operationId":"exportRoleMiningPotentialRoleAsync","tags":["IAI Role Mining"],"description":"This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role.","parameters":[{"in":"path","name":"sessionId","schema":{"type":"string"},"required":true,"description":"The role mining session id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"path","name":"potentialRoleId","schema":{"type":"string"},"required":true,"description":"A potential role id in a role mining session","example":"278359a6-04b7-4669-9468-924cf580964a"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"minEntitlementPopularity":{"type":"integer","description":"The minimum popularity among identities in the role which an entitlement must have to be included in the report","example":0},"includeCommonAccess":{"type":"boolean","description":"If false, do not include entitlements that are highly popular among the entire orginization","example":true}},"example":{"minEntitlementPopularity":0,"includeCommonAccess":true}}}}},"responses":{"202":{"description":"Job Submitted. Returns a reportId that can be used to download the zip once complete","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"minEntitlementPopularity":{"type":"integer","description":"The minimum popularity among identities in the role which an entitlement must have to be included in the report","example":0},"includeCommonAccess":{"type":"boolean","description":"If false, do not include entitlements that are highly popular among the entire orginization","example":true}},"example":{"minEntitlementPopularity":0,"includeCommonAccess":true}},{"type":"object","properties":{"exportId":{"type":"string","format":"uuid","description":"ID used to reference this export","example":"0c6cdb76-1227-4aaf-af21-192dbdfbfa04"},"status":{"description":"The status of this export","example":"QUEUED","type":"string","enum":["QUEUED","IN_PROGRESS","SUCCESS","ERROR"]}}}],"example":{"exportId":"0c6cdb76-1227-4aaf-af21-192dbdfbfa04","status":"QUEUED","minEntitlementPopularity":0,"includeCommonAccess":true}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"minEntitlementPopularity":0,"includeCommonAccess":true},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Asynchronously export details for a potential role in a role mining session and upload to S3","description":{"content":"This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role.","type":"text/plain"},"url":{"path":["role-mining-sessions",":sessionId","potential-roles",":potentialRoleId","export-async"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The role mining session id","type":"text/plain"},"type":"any","value":"","key":"sessionId"},{"disabled":false,"description":{"content":"(Required) A potential role id in a role mining session","type":"text/plain"},"type":"any","value":"","key":"potentialRoleId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Asynchronously export details for a potential role in a role mining session and upload to S3' (export-role-mining-potential-role-async)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Asynchronously export details for a potential role in a role mining session and upload to S3 + + + +This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. + +
Path Parameters
Request Body
+ +Job Submitted. Returns a reportId that can be used to download the zip once complete + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/export-role-mining-potential-role-status.api.mdx b/products/idn/api/beta/export-role-mining-potential-role-status.api.mdx new file mode 100644 index 000000000..4bb80490e --- /dev/null +++ b/products/idn/api/beta/export-role-mining-potential-role-status.api.mdx @@ -0,0 +1,71 @@ +--- +id: export-role-mining-potential-role-status +sidebar_label: Retrieve status of a potential role export job +hide_title: true +hide_table_of_contents: true +api: {"operationId":"exportRoleMiningPotentialRoleStatus","tags":["IAI Role Mining"],"description":"This endpoint retrieves information about the current status of a potential role export.","parameters":[{"in":"path","name":"sessionId","schema":{"type":"string","format":"uuid"},"required":true,"description":"The role mining session id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"path","name":"potentialRoleId","schema":{"type":"string","format":"uuid"},"required":true,"description":"A potential role id in a role mining session","example":"278359a6-04b7-4669-9468-924cf580964a"},{"in":"path","name":"exportId","schema":{"type":"string","format":"uuid"},"required":true,"description":"The id of a previously run export job for this potential role","example":"4940ffd4-836f-48a3-b2b0-6d498c3fdf40"}],"responses":{"200":{"description":"Success. Returns the current status of this export","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"minEntitlementPopularity":{"type":"integer","description":"The minimum popularity among identities in the role which an entitlement must have to be included in the report","example":0},"includeCommonAccess":{"type":"boolean","description":"If false, do not include entitlements that are highly popular among the entire orginization","example":true}},"example":{"minEntitlementPopularity":0,"includeCommonAccess":true}},{"type":"object","properties":{"exportId":{"type":"string","format":"uuid","description":"ID used to reference this export","example":"0c6cdb76-1227-4aaf-af21-192dbdfbfa04"},"status":{"description":"The status of this export","example":"QUEUED","type":"string","enum":["QUEUED","IN_PROGRESS","SUCCESS","ERROR"]}}}],"example":{"exportId":"0c6cdb76-1227-4aaf-af21-192dbdfbfa04","status":"QUEUED","minEntitlementPopularity":0,"includeCommonAccess":true}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Retrieve status of a potential role export job","description":{"content":"This endpoint retrieves information about the current status of a potential role export.","type":"text/plain"},"url":{"path":["role-mining-sessions",":sessionId","potential-roles",":potentialRoleId","export-async",":exportId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The role mining session id","type":"text/plain"},"type":"any","value":"","key":"sessionId"},{"disabled":false,"description":{"content":"(Required) A potential role id in a role mining session","type":"text/plain"},"type":"any","value":"","key":"potentialRoleId"},{"disabled":false,"description":{"content":"(Required) The id of a previously run export job for this potential role","type":"text/plain"},"type":"any","value":"","key":"exportId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Retrieve status of a potential role export job' (export-role-mining-potential-role-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieve status of a potential role export job + + + +This endpoint retrieves information about the current status of a potential role export. + +
Path Parameters
+ +Success. Returns the current status of this export + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/export-role-mining-potential-role.api.mdx b/products/idn/api/beta/export-role-mining-potential-role.api.mdx new file mode 100644 index 000000000..09d0cedb0 --- /dev/null +++ b/products/idn/api/beta/export-role-mining-potential-role.api.mdx @@ -0,0 +1,71 @@ +--- +id: export-role-mining-potential-role +sidebar_label: Export (download) details for a potential role in a role mining session +hide_title: true +hide_table_of_contents: true +api: {"operationId":"exportRoleMiningPotentialRole","tags":["IAI Role Mining"],"description":"This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role.","parameters":[{"in":"path","name":"sessionId","schema":{"type":"string"},"required":true,"description":"The role mining session id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"path","name":"potentialRoleId","schema":{"type":"string"},"required":true,"description":"A potential role id in a role mining session","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"}],"responses":{"200":{"description":"Succeeded. Returns a zip file containing csv files for identities and entitlements for the potential role.","content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Export (download) details for a potential role in a role mining session","description":{"content":"This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role.","type":"text/plain"},"url":{"path":["role-mining-sessions",":sessionId","potential-roles",":potentialRoleId","export"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The role mining session id","type":"text/plain"},"type":"any","value":"","key":"sessionId"},{"disabled":false,"description":{"content":"(Required) A potential role id in a role mining session","type":"text/plain"},"type":"any","value":"","key":"potentialRoleId"}]},"header":[{"key":"Accept","value":"application/zip"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Export (download) details for a potential role in a role mining session' (export-role-mining-potential-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Export (download) details for a potential role in a role mining session + + + +This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. + +
Path Parameters
+ +Succeeded. Returns a zip file containing csv files for identities and entitlements for the potential role. + +
Schema
  • string binary
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/export-sp-config.api.mdx b/products/idn/api/beta/export-sp-config.api.mdx new file mode 100644 index 000000000..d78685df1 --- /dev/null +++ b/products/idn/api/beta/export-sp-config.api.mdx @@ -0,0 +1,97 @@ +--- +id: export-sp-config +sidebar_label: Initiates configuration objects export job +hide_title: true +hide_table_of_contents: true +api: {"operationId":"exportSpConfig","security":[{"oauth2":["sp:config:read","sp:config:manage"]}],"tags":["SP-Config"],"description":"This post will export objects from the tenant to a JSON configuration file.\nFor 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).","requestBody":{"description":"Export options control what will be included in the export.","required":true,"content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"excludeTypes":{"description":"Object type names to be excluded from an sp-config export command.","type":"array","items":{"type":"string","enum":["ACCESS_PROFILE","ACCESS_REQUEST_CONFIG","ATTR_SYNC_SOURCE_CONFIG","AUTH_ORG","CAMPAIGN_FILTER","FORM_DEFINITION","GOVERNANCE_GROUP","IDENTITY_PROFILE","LIFECYCLE_STATE","NOTIFICATION_TEMPLATE","PASSWORD_POLICY","PASSWORD_SYNC_GROUP","PUBLIC_IDENTITIES_CONFIG","ROLE","RULE","SERVICE_DESK_INTEGRATION","SOD_POLICY","SOURCE","TRANSFORM","TRIGGER_SUBSCRIPTION","WORKFLOWS"],"example":"SOURCE"}},"includeTypes":{"description":"Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes.","type":"array","items":{"type":"string","enum":["ACCESS_PROFILE","ACCESS_REQUEST_CONFIG","ATTR_SYNC_SOURCE_CONFIG","AUTH_ORG","CAMPAIGN_FILTER","FORM_DEFINITION","GOVERNANCE_GROUP","IDENTITY_PROFILE","LIFECYCLE_STATE","NOTIFICATION_TEMPLATE","PASSWORD_POLICY","PASSWORD_SYNC_GROUP","PUBLIC_IDENTITIES_CONFIG","ROLE","RULE","SERVICE_DESK_INTEGRATION","SOD_POLICY","SOURCE","TRANSFORM","TRIGGER_SUBSCRIPTION","WORKFLOWS"],"example":"TRIGGER_SUBSCRIPTION"}},"objectOptions":{"description":"Additional options targeting specific objects related to each item in the includeTypes field","type":"object","additionalProperties":{"type":"object","properties":{"includedIds":{"description":"Object ids to be included in an import or export.","type":"array","items":{"type":"string","example":"be9e116d-08e1-49fc-ab7f-fa585e96c9e4"}},"includedNames":{"description":"Object names to be included in an import or export.","type":"array","items":{"type":"string","example":"Test Object"}}}},"example":{"TRIGGER_SUBSCRIPTION":{"includedIds":["be9e116d-08e1-49fc-ab7f-fa585e96c9e4"],"includedNames":["Test 2"]}}}}}],"properties":{"description":{"type":"string","description":"Optional user defined description/name for export job.","example":"Export Job 1 Test"}}},"examples":{"Export all objects available":{"description":"Export all object types available in IDN.","value":{"description":"Export all available objects","excludeTypes":[],"includeTypes":["ACCESS_PROFILE","ACCESS_REQUEST_CONFIG","ATTR_SYNC_SOURCE_CONFIG","AUTH_ORG","CAMPAIGN_FILTER","FORM_DEFINITION","GOVERNANCE_GROUP","IDENTITY_OBJECT_CONFIG","IDENTITY_PROFILE","LIFECYCLE_STATE","NOTIFICATION_TEMPLATE","PASSWORD_POLICY","PASSWORD_SYNC_GROUP","PUBLIC_IDENTITIES_CONFIG","ROLE","RULE","SERVICE_DESK_INTEGRATION","SOD_POLICY","SOURCE","TRANSFORM","TRIGGER_SUBSCRIPTION","WORKFLOWS"],"objectOptions":{}}},"Export sources by ID":{"description":"Export only sources that match the IDs specified in the export options.","value":{"description":"Export sources by ID","excludeTypes":[],"includeTypes":["SOURCE"],"objectOptions":{"SOURCE":{"includedIds":["be9e116d-08e1-49fc-ab7f-fa585e96c9e4","be9p119e-90e1-49pk-ac9f-fa576e96c9e4"],"includedNames":[]}}}},"Export transforms by name":{"description":"Export only transforms that match the names specified in the export options.","value":{"description":"Export transforms by name","excludeTypes":[],"includeTypes":["TRANSFORM"],"objectOptions":{"TRANSFORM":{"includedIds":[],"includedNames":["Remove Diacritical Marks","Common - Location Lookup"]}}}},"Export trigger subscriptions triggers and transforms with custom options":{"description":"Export trigger subscriptions and transforms that match the export options.","value":{"description":"Export trigger subscriptions and transforms with custom filter options","excludeTypes":[],"includeTypes":["TRANSFORM","TRIGGER_SUBSCRIPTION"],"objectOptions":{"TRANSFORM":{"includedIds":[],"includedNames":["Remove Diacritical Marks","Common - Location Lookup"]},"TRIGGER_SUBSCRIPTION":{"includedIds":["be9e116d-08e1-49fc-ab7f-fa585e96c9e4","be9p119e-90e1-49pk-ac9f-fa576e96c9e4"],"includedNames":["NGROK Test: fire and forget","Manager Certification"]}}}}}}}},"responses":{"202":{"description":"Export job accepted and queued for processing.","content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"type":"string","description":"Unique id assigned to this job.","example":"3469b87d-48ca-439a-868f-2160001da8c1"},"status":{"type":"string","description":"Status of the job.","enum":["NOT_STARTED","IN_PROGRESS","COMPLETE","CANCELLED","FAILED"],"example":"COMPLETE"},"type":{"type":"string","description":"Type of the job, either export or import.","enum":["EXPORT","IMPORT"],"example":"IMPORT"},"message":{"type":"string","description":"This message contains additional information about the overall status of the job.","example":"Download import results for details."},"description":{"type":"string","description":"Optional user defined description/name for export job.","example":"ETS configuration objects from Acme-Solar sandbox"},"expiration":{"type":"string","format":"date-time","description":"The time until which the artifacts will be available for download.","example":"2021-05-11T22:23:16Z"},"created":{"type":"string","format":"date-time","description":"The time the job was started.","example":"2021-05-11T22:23:16Z"},"modified":{"type":"string","format":"date-time","description":"The time of the last update to the job.","example":"2021-05-11T22:23:16Z"},"completed":{"type":"string","format":"date-time","description":"The time the job was completed.","example":"2021-05-11T22:23:16Z"}},"required":["jobId","status","type","message","description","expiration","created","modified","completed"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.\n","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sp-config/export","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"excludeTypes":["SOURCE"],"includeTypes":["TRIGGER_SUBSCRIPTION"],"objectOptions":{"TRIGGER_SUBSCRIPTION":{"includedIds":["be9e116d-08e1-49fc-ab7f-fa585e96c9e4"],"includedNames":["Test 2"]}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Initiates configuration objects export job","description":{"content":"This post will export objects from the tenant to a JSON configuration file.\nFor 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).","type":"text/plain"},"url":{"path":["sp-config","export"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Initiates configuration objects export job' (export-sp-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Initiates configuration objects export job + + + +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). + +
Request Body required
+ +Export options control what will be included in the export. + +
    objectOptions object
    + +Additional options targeting specific objects related to each item in the includeTypes field + +
  • property name* object
+ +Export job accepted and queued for processing. + +
Schema
+ +Client Error - Returned if the request body is invalid. + + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/forward-access-request.api.mdx b/products/idn/api/beta/forward-access-request.api.mdx new file mode 100644 index 000000000..f827b8a68 --- /dev/null +++ b/products/idn/api/beta/forward-access-request.api.mdx @@ -0,0 +1,91 @@ +--- +id: forward-access-request +sidebar_label: Forwards an access request approval to a new owner. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"forwardAccessRequest","tags":["Access Request Approvals"],"description":"This endpoint forwards an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.","parameters":[{"in":"path","name":"approvalId","schema":{"type":"string"},"required":true,"description":"The id of the approval.","example":"2c91808b7294bea301729568c68c002e"}],"requestBody":{"description":"Information about the forwarded approval.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["newOwnerId","comment"],"properties":{"newOwnerId":{"type":"string","description":"The Id of the new owner","minLength":1,"maxLength":255},"comment":{"type":"string","description":"The comment provided by the forwarder","minLength":1,"maxLength":255}}}}}},"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/access-request-approvals/{approvalId}/forward","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"newOwnerId":"string","comment":"string"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Forwards an access request approval to a new owner.","description":{"content":"This endpoint forwards an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.","type":"text/plain"},"url":{"path":["access-request-approvals",":approvalId","forward"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The id of the approval.","type":"text/plain"},"type":"any","value":"","key":"approvalId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Forwards an access request approval to a new owner.' (forward-access-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Forwards an access request approval to a new owner. + + + +This endpoint forwards an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +
Path Parameters
Request Body required
+ +Information about the forwarded approval. + +
+ +Accepted - Returned if the request was successfully accepted into the system. + +
Schema
  • object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/forward-work-item.api.mdx b/products/idn/api/beta/forward-work-item.api.mdx new file mode 100644 index 000000000..5e091fd12 --- /dev/null +++ b/products/idn/api/beta/forward-work-item.api.mdx @@ -0,0 +1,75 @@ +--- +id: forward-work-item +sidebar_label: Forward a Work Item +hide_title: true +hide_table_of_contents: true +api: {"operationId":"forwardWorkItem","tags":["Work Items"],"description":"This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the work item","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["targetOwnerId","comment"],"properties":{"targetOwnerId":{"type":"string","description":"The ID of the identity to forward this work item to.","example":"2c9180835d2e5168015d32f890ca1581"},"comment":{"type":"string","description":"Comments to send to the target owner","example":"I'm going on vacation."},"sendNotifications":{"type":"boolean","description":"If true, send a notification to the target owner.","default":true,"example":true}}}}}},"responses":{"200":{"description":"Success, but no data is returned."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/work-items/{id}/forward","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"targetOwnerId":"2c9180835d2e5168015d32f890ca1581","comment":"I'm going on vacation.","sendNotifications":true},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Forward a Work Item","description":{"content":"This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request.","type":"text/plain"},"url":{"path":["work-items",":id","forward"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the work item","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Forward a Work Item' (forward-work-item)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Forward a Work Item + + + +This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. + +
Path Parameters
Request Body required
+ +Success, but no data is returned. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/generate-campaign-template.api.mdx b/products/idn/api/beta/generate-campaign-template.api.mdx new file mode 100644 index 000000000..21a4798a4 --- /dev/null +++ b/products/idn/api/beta/generate-campaign-template.api.mdx @@ -0,0 +1,79 @@ +--- +id: generate-campaign-template +sidebar_label: Generate a Campaign from Template +hide_title: true +hide_table_of_contents: true +api: {"operationId":"generateCampaignTemplate","tags":["Certification Campaigns"],"description":"Generates a new campaign from a campaign template.\nThe campaign object contained in the template has special formatting applied to its name and description fields in order to determine the generated campaign's name/description. Placeholders in those fields are formatted with the current date and time upon generation.\nPlaceholders consist of a percent sign followed by a letter indicating what should be inserted; for example, \"%Y\" will insert the current year; a campaign template named \"Campaign for %y\" would generate a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020).\nValid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html).\nRequires roles ORG_ADMIN.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the campaign template to use for generation."}],"responses":{"200":{"description":"Indicates a campaign was successfully generated from this template, and returns a reference to the new campaign.","content":{"application/json":{"schema":{"type":"object","required":["id","name","type","campaignType","description","correlatedStatus","mandatoryCommentRequirement"],"properties":{"id":{"type":"string","description":"The unique ID of the campaign.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the campaign.","example":"Campaign Name"},"type":{"type":"string","enum":["CAMPAIGN"],"description":"The type of object that is being referenced.","example":"CAMPAIGN"},"campaignType":{"type":"string","enum":["MANAGER","SOURCE_OWNER","SEARCH"],"description":"The type of the campaign.","example":"MANAGER"},"description":{"type":"string","description":"The description of the campaign set by the admin who created it.","nullable":true,"example":"A description of the campaign"},"correlatedStatus":{"description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"},"mandatoryCommentRequirement":{"type":"string","description":"Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.","enum":["ALL_DECISIONS","REVOKE_ONLY_DECISIONS","NO_DECISIONS"],"example":"NO_DECISIONS"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/campaign-templates/{id}/generate","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Generate a Campaign from Template","description":{"content":"Generates a new campaign from a campaign template.\nThe campaign object contained in the template has special formatting applied to its name and description fields in order to determine the generated campaign's name/description. Placeholders in those fields are formatted with the current date and time upon generation.\nPlaceholders consist of a percent sign followed by a letter indicating what should be inserted; for example, \"%Y\" will insert the current year; a campaign template named \"Campaign for %y\" would generate a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020).\nValid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html).\nRequires roles ORG_ADMIN.","type":"text/plain"},"url":{"path":["campaign-templates",":id","generate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the campaign template to use for generation.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Generate a Campaign from Template' (generate-campaign-template)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Generate a Campaign from Template + + + +Generates a new campaign from a campaign template. +The campaign object contained in the template has special formatting applied to its name and description fields in order to determine the generated campaign's name/description. Placeholders in those fields are formatted with the current date and time upon generation. +Placeholders consist of a percent sign followed by a letter indicating what should be inserted; for example, "%Y" will insert the current year; a campaign template named "Campaign for %y" would generate a campaign called "Campaign for 2020" (assuming the year at generation time is 2020). +Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). +Requires roles ORG_ADMIN. + +
Path Parameters
+ +Indicates a campaign was successfully generated from this template, and returns a reference to the new campaign. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/generate-digit-token.api.mdx b/products/idn/api/beta/generate-digit-token.api.mdx new file mode 100644 index 000000000..c31ed8d79 --- /dev/null +++ b/products/idn/api/beta/generate-digit-token.api.mdx @@ -0,0 +1,67 @@ +--- +id: generate-digit-token +sidebar_label: Generate a digit token +hide_title: true +hide_table_of_contents: true +api: {"operationId":"generateDigitToken","tags":["Password Management"],"description":"This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\".","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","description":"The uid of the user requested for digit token","example":"Abby.Smith"},"length":{"type":"integer","description":"The length of digit token. It should be from 6 to 18, inclusive. The default value is 6.","example":8},"durationMinutes":{"type":"integer","description":"The time to live for the digit token in minutes. The default value is 5 minutes.","example":5}}},"example":{"userId":"Abby.Smith","length":8,"durationMinutes":5}}}},"responses":{"200":{"description":"The digit token for password management.","content":{"application/json":{"schema":{"type":"object","properties":{"digitToken":{"type":"string","description":"The digit token for password management","example":9087713},"requestId":{"type":"string","description":"The reference ID of the digit token generation request","example":"e1267ecd-fcd9-4c73-9c55-12555efad136"}}},"example":{"digitToken":"09087713","requestId":"e1267ecd-fcd9-4c73-9c55-12555efad136"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/generate-password-reset-token/digit","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"userId":"Abby.Smith","length":8,"durationMinutes":5},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Generate a digit token","description":{"content":"This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\".","type":"text/plain"},"url":{"path":["generate-password-reset-token","digit"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Generate a digit token' (generate-digit-token)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Generate a digit token + + + +This API is used to generate a digit token for password management. Requires authorization scope of "idn:password-digit-token:create". + +
Request Body required
+ +The digit token for password management. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/generate-identity-preview.api.mdx b/products/idn/api/beta/generate-identity-preview.api.mdx new file mode 100644 index 000000000..e12184fa6 --- /dev/null +++ b/products/idn/api/beta/generate-identity-preview.api.mdx @@ -0,0 +1,92 @@ +--- +id: generate-identity-preview +sidebar_label: Generate Identity Profile Preview +hide_title: true +hide_table_of_contents: true +api: {"operationId":"generateIdentityPreview","tags":["Identity Profiles"],"description":"This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy's attribute config is applied.\nA token with ORG_ADMIN authority is required to call this API to generate an identity preview.","requestBody":{"description":"Identity Preview request body.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","format":"uuid","example":"2c9180857893f12901789445619b0366"},"identityAttributeConfig":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If the profile or mapping is enabled","example":true,"default":true},"attributeTransforms":{"type":"array","items":{"type":"object","properties":{"identityAttributeName":{"type":"string","description":"Name of the identity attribute","example":"email"},"transformDefinition":{"description":"The seaspray transformation definition","type":"object","properties":{"type":{"type":"string","description":"The type of the transform definition.","example":"accountAttribute"},"attributes":{"type":"object","nullable":true,"additionalProperties":true,"description":"Arbitrary key-value pairs to store any metadata for the object","example":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}}}}}}}}}}}}}},"responses":{"200":{"description":"Object representing the preview object with all of the identity attributes using the current mappings.","content":{"application/json":{"schema":{"type":"object","properties":{"identity":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"previewAttributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the attribute that is being previewed.","example":"email"},"value":{"type":"object","description":"Value that was derived during the preview.","example":"email@mail.com"},"previousValue":{"type":"object","description":"The value of the attribute before the preview.","example":"oldEmail@mail.com"},"errorMessages":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}},"description":"A list of errors that may have been encountered"}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:identity-profile:manage"]}],"method":"post","path":"/identity-profiles/identity-preview","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"identityId":"2c9180857893f12901789445619b0366","identityAttributeConfig":{"enabled":true,"attributeTransforms":[{"identityAttributeName":"email","transformDefinition":{"type":"accountAttribute","attributes":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}}}]}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Generate Identity Profile Preview","description":{"content":"This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy's attribute config is applied.\nA token with ORG_ADMIN authority is required to call this API to generate an identity preview.","type":"text/plain"},"url":{"path":["identity-profiles","identity-preview"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Generate Identity Profile Preview' (generate-identity-preview)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Generate Identity Profile Preview + + + +This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy's attribute config is applied. +A token with ORG_ADMIN authority is required to call this API to generate an identity preview. + +
Request Body required
+ +Identity Preview request body. + +
    identityAttributeConfig object
    attributeTransforms object[]
    transformDefinition object
    + +The seaspray transformation definition + +
    attributes object
    + +Arbitrary key-value pairs to store any metadata for the object + +
+ +Object representing the preview object with all of the identity attributes using the current mappings. + +
Schema
    identity object
    previewAttributes object[]
    errorMessages object[]
    + +A list of errors that may have been encountered + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-access-profile-entitlements.api.mdx b/products/idn/api/beta/get-access-profile-entitlements.api.mdx new file mode 100644 index 000000000..e741e791c --- /dev/null +++ b/products/idn/api/beta/get-access-profile-entitlements.api.mdx @@ -0,0 +1,89 @@ +--- +id: get-access-profile-entitlements +sidebar_label: List Access Profile's Entitlements +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAccessProfileEntitlements","tags":["Access Profiles"],"description":"This API lists the Entitlements associated with a given Access Profile\n\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a token with SOURCE_SUBADMIN authority must have access to the Source associated with the given Access Profile","parameters":[{"name":"id","in":"path","description":"ID of the containing Access Profile","required":true,"schema":{"type":"string","example":"2c91808a7813090a017814121919ecca"}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following Entitlement fields and operators:\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**attribute**: *eq, sw*\n\n**value**: *eq, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**source.id**: *eq, in*","example":"attribute eq \"memberOf\"","required":false},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name, attribute, value, created, modified**","example":"name,-modified","required":false}],"responses":{"200":{"description":"List of Entitlements","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The entitlement id","example":"2c91808874ff91550175097daaec161c"},"name":{"type":"string","description":"The entitlement name","example":"LauncherTest2"},"created":{"type":"string","description":"Time when the entitlement was created","format":"date-time","example":"2020-10-08T18:33:52.029Z"},"modified":{"type":"string","description":"Time when the entitlement was last modified","format":"date-time","example":"2020-10-08T18:33:52.029Z"},"attribute":{"type":"string","description":"The entitlement attribute name","example":"memberOf"},"value":{"type":"string","description":"The value of the entitlement","example":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local"},"sourceSchemaObjectType":{"type":"string","description":"The object type of the entitlement from the source schema","example":"group"},"privileged":{"type":"boolean","default":false,"description":"True if the entitlement is privileged","example":true},"cloudGoverned":{"type":"boolean","default":false,"description":"True if the entitlement is cloud governed","example":true},"description":{"type":"string","description":"The description of the entitlement","example":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local"},"requestable":{"type":"boolean","default":false,"description":"True if the entitlement is requestable","example":true},"attributes":{"type":"object","description":"A map of free-form key-value pairs from the source system","example":{"fieldName":"fieldValue"},"additionalProperties":true},"source":{"type":"object","properties":{"id":{"type":"string","description":"The source ID","example":"2c9180827ca885d7017ca8ce28a000eb"},"type":{"type":"string","description":"The source type, will always be \"SOURCE\"","example":"SOURCE"},"name":{"type":"string","description":"The source name","example":"ODS-AD-Source"}}},"owner":{"type":"object","description":"Simplified DTO for the owner object of the entitlement","properties":{"id":{"type":"string","description":"The owner id for the entitlement","example":"2a2fdacca5e345f18bf7970cfbb8fec2"},"name":{"type":"string","description":"The owner name for the entitlement","example":"identity 1"},"type":{"type":"string","enum":["IDENTITY"],"description":"The type of the owner. Initially only type IDENTITY is supported","example":"IDENTITY"}}},"directPermissions":{"type":"array","items":{"type":"object","description":"Simplified DTO for the Permission objects stored in SailPoint's database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers.","properties":{"rights":{"type":"array","description":"All the rights (e.g. actions) that this permission allows on the target","readOnly":true,"items":{"type":"string","example":"SELECT"}},"target":{"type":"string","description":"The target the permission would grants rights on.","readOnly":true,"example":"SYS.GV_$TRANSACTION"}}}},"segments":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of IDs of segments, if any, to which this Entitlement is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]},"manuallyUpdatedFields":{"description":"Object contains entitlement manually updated fields. Field value is true if is was updated manually via entitlement import csv or patch endpoint. Field value is false if that property value has not been changed after first entitlement aggregation. Values for all manually updatable fields must be specified. For now only two entitlement fields support this: DISPLAY_NAME and DESCRIPTION.","example":{"DISPLAY_NAME":true,"DESCRIPTION":true},"type":"object","properties":{"DISPLAY_NAME":{"type":"boolean","default":false,"description":"True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation.\nField refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property.","example":true},"DESCRIPTION":{"type":"boolean","default":false,"description":"True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation.\nField refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property.","example":true}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:access-profile:read","idn:access-profile:manage"]}],"method":"get","path":"/access-profiles/{id}/entitlements","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Access Profile's Entitlements","description":{"content":"This API lists the Entitlements associated with a given Access Profile\n\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a token with SOURCE_SUBADMIN authority must have access to the Source associated with the given Access Profile","type":"text/plain"},"url":{"path":["access-profiles",":id","entitlements"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following Entitlement fields and operators:\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**attribute**: *eq, sw*\n\n**value**: *eq, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**source.id**: *eq, in*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name, attribute, value, created, modified**","type":"text/plain"},"key":"sorters","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the containing Access Profile","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Access Profile's Entitlements' (get-access-profile-entitlements)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Access Profile's Entitlements + + + +This API lists the Entitlements associated with a given Access Profile + +A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a token with SOURCE_SUBADMIN authority must have access to the Source associated with the given Access Profile + +
Path Parameters
Query Parameters
+ +List of Entitlements + +
Schema array
    attributes object
    + +A map of free-form key-value pairs from the source system + +
    source object
    owner object
    + +Simplified DTO for the owner object of the entitlement + +
    directPermissions object[]
    manuallyUpdatedFields object
    + +Object contains entitlement manually updated fields. Field value is true if is was updated manually via entitlement import csv or patch endpoint. Field value is false if that property value has not been changed after first entitlement aggregation. Values for all manually updatable fields must be specified. For now only two entitlement fields support this: DISPLAY_NAME and DESCRIPTION. + +
    `name` property."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}> `description` property."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-access-profile.api.mdx b/products/idn/api/beta/get-access-profile.api.mdx new file mode 100644 index 000000000..53517c2e6 --- /dev/null +++ b/products/idn/api/beta/get-access-profile.api.mdx @@ -0,0 +1,113 @@ +--- +id: get-access-profile +sidebar_label: Get an Access Profile +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAccessProfile","tags":["Access Profiles"],"description":"This API returns an Access Profile by its ID.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"ID of the Access Profile","example":"2c9180837ca6693d017ca8d097500149"}],"responses":{"200":{"description":"An AccessProfile","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Access Profile","example":"2c91808a7190d06e01719938fcd20792","readOnly":true},"name":{"type":"string","description":"Name of the Access Profile","example":"Employee-database-read-write"},"description":{"type":"string","nullable":true,"description":"Information about the Access Profile","example":"Collection of entitlements to read/write the employee database"},"created":{"type":"string","description":"Date the Access Profile was created","format":"date-time","example":"2021-03-01T22:32:58.104Z","readOnly":true},"modified":{"type":"string","description":"Date the Access Profile was last modified.","format":"date-time","example":"2021-03-02T20:22:28.104Z","readOnly":true},"enabled":{"type":"boolean","description":"Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement.","example":true},"owner":{"description":"Owner of the Access Profile","type":"object","nullable":true,"properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"source":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Source with with which the Access Profile is associated","example":"2c91809773dee3610173fdb0b6061ef4"},"type":{"type":"string","enum":["SOURCE"],"description":"The type of the Source, will always be SOURCE","example":"SOURCE"},"name":{"type":"string","description":"The display name of the associated Source","example":"ODS-AD-SOURCE"}}},"entitlements":{"type":"array","description":"A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement.","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Entitlement","example":"2c91809773dee32014e13e122092014e"},"type":{"type":"string","enum":["ENTITLEMENT"],"description":"The type of the Entitlement, will always be ENTITLEMENT","example":"ENTITLEMENT"},"name":{"type":"string","description":"The display name of the Entitlement","example":"CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"}}}},"requestable":{"type":"boolean","description":"Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error.","example":true},"accessRequestConfig":{"nullable":true,"description":"Access request configuration for this object","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":true},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":true},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"revocationRequestConfig":{"nullable":true,"description":"Revocation request configuration for this object.","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":false,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":false,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the revocation request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"segments":{"type":"array","nullable":true,"items":{"type":"string"},"description":"List of IDs of segments, if any, to which this Access Profile is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]},"provisioningCriteria":{"description":"When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression is evaluated against those Accounts to choose one to provision with the Access Profile.","nullable":true,"example":{"operation":"OR","children":[{"operation":"AND","children":[{"attribute":"dn","operation":"CONTAINS","value":"useast"},{"attribute":"manager","operation":"CONTAINS","value":"Scott.Clark"}]},{"operation":"AND","children":[{"attribute":"dn","operation":"EQUALS","value":"Gibson"},{"attribute":"telephoneNumber","operation":"CONTAINS","value":"512"}]}]},"type":"object","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","nullable":true,"description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines matching criteria for an Account to be provisioned with a specific Access Profile","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","nullable":true,"description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines matching criteria for an Account to be provisioned with a specific Access Profile","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.","example":null}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.","example":null}}}},"required":["owner","name","source"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:access-profile:read","idn:access-profile:manage"]}],"method":"get","path":"/access-profiles/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get an Access Profile","description":{"content":"This API returns an Access Profile by its ID.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["access-profiles",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Access Profile","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get an Access Profile' (get-access-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get an Access Profile + + + +This API returns an Access Profile by its ID. + +A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +
Path Parameters
+ +An AccessProfile + +
Schema
    owner object
    + +Owner of the Access Profile + +
    source object
    entitlements object[]
    + +A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. + +
    accessRequestConfig object
    + +Access request configuration for this object + +
    approvalSchemes object[]
    + +List describing the steps in approving the request + +
    revocationRequestConfig object
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]
    + +List describing the steps in approving the revocation request + +
    provisioningCriteria object
    + +When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression is evaluated against those Accounts to choose one to provision with the Access Profile. + +
    children object[]
    + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + +
    children object[]
    + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-access-request-approval-summary.api.mdx b/products/idn/api/beta/get-access-request-approval-summary.api.mdx new file mode 100644 index 000000000..88f69670e --- /dev/null +++ b/products/idn/api/beta/get-access-request-approval-summary.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-access-request-approval-summary +sidebar_label: Get the number of pending, approved and rejected access requests approvals +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAccessRequestApprovalSummary","tags":["Access Request Approvals"],"description":"This endpoint returns the number of pending, approved and rejected access requests approvals. See \"owner-id\" query parameter below for authorization info.","parameters":[{"in":"query","name":"owner-id","schema":{"type":"string"},"description":"The id of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity.\n * ORG_ADMIN users can call this with any identity ID value.\n * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used.\n * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value."},{"in":"query","name":"from-date","schema":{"type":"string"},"description":"From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format\n\nexample: from-date=2020-03-19T19:59:11Z"}],"responses":{"200":{"description":"Number of pending, approved, rejected access request approvals.","content":{"application/json":{"schema":{"type":"object","properties":{"pending":{"type":"integer","description":"The number of pending access requests approvals."},"approved":{"type":"integer","description":"The number of approved access requests approvals."},"rejected":{"type":"integer","description":"The number of rejected access requests approvals."}}}}}},"400":{"description":"Client Error - Returned if the query parameter is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/access-request-approvals/approval-summary","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get the number of pending, approved and rejected access requests approvals","description":{"content":"This endpoint returns the number of pending, approved and rejected access requests approvals. See \"owner-id\" query parameter below for authorization info.","type":"text/plain"},"url":{"path":["access-request-approvals","approval-summary"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The id of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity.\n * ORG_ADMIN users can call this with any identity ID value.\n * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used.\n * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value.","type":"text/plain"},"key":"owner-id","value":""},{"disabled":false,"description":{"content":"From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format\n\nexample: from-date=2020-03-19T19:59:11Z","type":"text/plain"},"key":"from-date","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get the number of pending, approved and rejected access requests approvals' (get-access-request-approval-summary)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get the number of pending, approved and rejected access requests approvals + + + +This endpoint returns the number of pending, approved and rejected access requests approvals. See "owner-id" query parameter below for authorization info. + +
Query Parameters
+ +Number of pending, approved, rejected access request approvals. + +
Schema
+ +Client Error - Returned if the query parameter is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-access-request-config.api.mdx b/products/idn/api/beta/get-access-request-config.api.mdx new file mode 100644 index 000000000..86d80cd96 --- /dev/null +++ b/products/idn/api/beta/get-access-request-config.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-access-request-config +sidebar_label: Get Access Request Configuration +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAccessRequestConfig","tags":["Access Requests"],"description":"This endpoint returns the current access-request configuration.","responses":{"200":{"description":"Access Request Configuration Details.","content":{"application/json":{"schema":{"type":"object","properties":{"approvalsMustBeExternal":{"type":"boolean","description":"If true, then approvals must be processed by external system.","example":true},"autoApprovalEnabled":{"type":"boolean","description":"If true and requester and reviewer are the same, then automatically approve the approval.","example":true},"requestOnBehalfOfConfig":{"description":"Request On Behalf Of Configuration.","type":"object","properties":{"allowRequestOnBehalfOfAnyoneByAnyone":{"type":"boolean","description":"If anyone can request access for anyone.","example":true},"allowRequestOnBehalfOfEmployeeByManager":{"type":"boolean","description":"If a manager can request access for his/her direct reports.","example":true}}},"approvalReminderAndEscalationConfig":{"description":"Approval Reminder and Escalation Configuration.","type":"object","properties":{"daysUntilEscalation":{"type":"integer","description":"Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation.","format":"int32","example":0},"daysBetweenReminders":{"type":"integer","description":"Number of days to wait between reminder notifications.","format":"int32","example":0},"maxReminders":{"type":"integer","description":"Maximum number of reminder notification to send to the reviewer before approval escalation.","format":"int32","example":0},"fallbackApproverRef":{"type":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"},"id":{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"},"name":{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"},"email":{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}}}},"entitlementRequestConfig":{"description":"Entitlement Request Configuration.","type":"object","properties":{"allowEntitlementRequest":{"type":"boolean","description":"Flag for allowing entitlement request.","example":true},"requestCommentsRequired":{"type":"boolean","description":"Flag for requiring comments while submitting an entitlement request.","default":false,"example":false},"deniedCommentsRequired":{"type":"boolean","description":"Flag for requiring comments while rejecting an entitlement request.","default":false,"example":false},"grantRequestApprovalSchemes":{"type":"string","description":"Approval schemes for granting entitlement request. This can be empty if no approval is needed.\nMultiple schemes must be comma-separated. The valid schemes are \"entitlementOwner\", \"sourceOwner\", \"manager\" and \"workgroup:{id}\".\nMultiple workgroups (governance groups) can be used.\n","default":"sourceOwner","example":"entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584"}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/access-request-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Access Request Configuration","description":{"content":"This endpoint returns the current access-request configuration.","type":"text/plain"},"url":{"path":["access-request-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Access Request Configuration' (get-access-request-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Access Request Configuration + + + +This endpoint returns the current access-request configuration. + +
+ +Access Request Configuration Details. + +
Schema
    requestOnBehalfOfConfig object
    + +Request On Behalf Of Configuration. + +
    approvalReminderAndEscalationConfig object
    + +Approval Reminder and Escalation Configuration. + +
    fallbackApproverRef object
    entitlementRequestConfig object
    + +Entitlement Request Configuration. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-access-request-recommendations-ignored-items.api.mdx b/products/idn/api/beta/get-access-request-recommendations-ignored-items.api.mdx new file mode 100644 index 000000000..17bc71bd1 --- /dev/null +++ b/products/idn/api/beta/get-access-request-recommendations-ignored-items.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-access-request-recommendations-ignored-items +sidebar_label: List of Ignored Access Request Recommendations +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAccessRequestRecommendationsIgnoredItems","tags":["IAI Access Request Recommendations"],"description":"This API returns the list of ignored access request recommendations.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter recommendations using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*"},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **access.id, access.type, identityId, timestamp**"}],"responses":{"200":{"description":"Returns list of ignored access request recommendations.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"identityId":{"type":"string","format":"UUID","description":"The identity ID taking the action.","example":"2c91808570313110017040b06f344ec9"},"access":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"},"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE"}}},"timestamp":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/ai-access-request-recommendations/ignored-items","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List of Ignored Access Request Recommendations","description":{"content":"This API returns the list of ignored access request recommendations.","type":"text/plain"},"url":{"path":["ai-access-request-recommendations","ignored-items"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter recommendations using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **access.id, access.type, identityId, timestamp**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List of Ignored Access Request Recommendations' (get-access-request-recommendations-ignored-items)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List of Ignored Access Request Recommendations + + + +This API returns the list of ignored access request recommendations. + +
Query Parameters
+ +Returns list of ignored access request recommendations. + +
Schema array
    access object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-access-request-recommendations-requested-items.api.mdx b/products/idn/api/beta/get-access-request-recommendations-requested-items.api.mdx new file mode 100644 index 000000000..20b3e9013 --- /dev/null +++ b/products/idn/api/beta/get-access-request-recommendations-requested-items.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-access-request-recommendations-requested-items +sidebar_label: List of Requested Access Request Recommendations +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAccessRequestRecommendationsRequestedItems","tags":["IAI Access Request Recommendations"],"description":"This API returns a list of requested access request recommendations.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter recommendations using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*"},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **access.id, access.type, identityId, timestamp**"}],"responses":{"200":{"description":"Returns the list of requested access request recommendations.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"identityId":{"type":"string","format":"UUID","description":"The identity ID taking the action.","example":"2c91808570313110017040b06f344ec9"},"access":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"},"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE"}}},"timestamp":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/ai-access-request-recommendations/requested-items","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List of Requested Access Request Recommendations","description":{"content":"This API returns a list of requested access request recommendations.","type":"text/plain"},"url":{"path":["ai-access-request-recommendations","requested-items"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter recommendations using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **access.id, access.type, identityId, timestamp**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List of Requested Access Request Recommendations' (get-access-request-recommendations-requested-items)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List of Requested Access Request Recommendations + + + +This API returns a list of requested access request recommendations. + +
Query Parameters
+ +Returns the list of requested access request recommendations. + +
Schema array
    access object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-access-request-recommendations-viewed-items.api.mdx b/products/idn/api/beta/get-access-request-recommendations-viewed-items.api.mdx new file mode 100644 index 000000000..50fbe919d --- /dev/null +++ b/products/idn/api/beta/get-access-request-recommendations-viewed-items.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-access-request-recommendations-viewed-items +sidebar_label: List of Viewed Access Request Recommendations +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAccessRequestRecommendationsViewedItems","tags":["IAI Access Request Recommendations"],"description":"This API returns the list of viewed access request recommendations.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter recommendations using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*"},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **access.id, access.type, identityId, timestamp**"}],"responses":{"200":{"description":"Returns list of viewed access request recommendations.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"identityId":{"type":"string","format":"UUID","description":"The identity ID taking the action.","example":"2c91808570313110017040b06f344ec9"},"access":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"},"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE"}}},"timestamp":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/ai-access-request-recommendations/viewed-items","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List of Viewed Access Request Recommendations","description":{"content":"This API returns the list of viewed access request recommendations.","type":"text/plain"},"url":{"path":["ai-access-request-recommendations","viewed-items"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter recommendations using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**access.id**: *eq, in*\n\n**access.type**: *eq, in*\n\n**identityId**: *eq, in*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **access.id, access.type, identityId, timestamp**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List of Viewed Access Request Recommendations' (get-access-request-recommendations-viewed-items)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List of Viewed Access Request Recommendations + + + +This API returns the list of viewed access request recommendations. + +
Query Parameters
+ +Returns list of viewed access request recommendations. + +
Schema array
    access object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-access-request-recommendations.api.mdx b/products/idn/api/beta/get-access-request-recommendations.api.mdx new file mode 100644 index 000000000..53f193b7d --- /dev/null +++ b/products/idn/api/beta/get-access-request-recommendations.api.mdx @@ -0,0 +1,79 @@ +--- +id: get-access-request-recommendations +sidebar_label: Identity Access Request Recommendations +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAccessRequestRecommendations","tags":["IAI Access Request Recommendations"],"description":"This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user.","parameters":[{"in":"query","name":"identity-id","description":"Get access request recommendations for an identityId. *me* indicates the current user.","schema":{"type":"string","default":"me"},"required":false,"example":"2c91808570313110017040b06f344ec9"},{"in":"query","name":"limit","description":"Max number of results to return.","required":false,"schema":{"type":"integer","minimum":0,"maximum":15,"default":15}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"include-translation-messages","description":"If *true* it will populate a list of translation messages in the response.","schema":{"type":"boolean","default":false},"required":false,"example":false},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter recommendations using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**access.name**: *co*\n\n**access.type**: *eq, in*\n\n**access.description**: *co*"},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **access.name, access.type**\n\nBy default the recommendations are sorted by highest confidence first."}],"responses":{"200":{"description":"List of access request recommendations for the identityId","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"identityId":{"type":"string","format":"UUID","description":"Identity ID for the recommendation","example":"2c91808570313110017040b06f344ec9"},"access":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"},"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE"},"name":{"type":"string","description":"Name of the access item","example":"Employee-database-read-write"},"description":{"type":"string","description":"Description of the access item","example":"This item grants an employee read and write access to the database"}}},"ignored":{"type":"boolean","example":true,"description":"Whether or not the identity has already chosen to ignore this recommendation."},"requested":{"type":"boolean","example":true,"description":"Whether or not the identity has already chosen to request this recommendation."},"viewed":{"type":"boolean","example":true,"description":"Whether or not the identity reportedly viewed this recommendation."},"messages":{"type":"array","items":{"type":"object","properties":{"interpretation":{"type":"string","description":"Information about why the access item was recommended.","example":"95% of your peers have this access."}}}},"translationMessages":{"description":"The list of translation messages","type":"array","example":[{"key":"recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH","values":["75","department"]}],"items":{"properties":{"key":{"type":"string","description":"The key of the translation message","example":"recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH"},"values":{"type":"array","description":"The values corresponding to the translation messages","items":{"type":"string"},"example":["75","department"]}}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/ai-access-request-recommendations","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Identity Access Request Recommendations","description":{"content":"This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user.","type":"text/plain"},"url":{"path":["ai-access-request-recommendations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Get access request recommendations for an identityId. *me* indicates the current user.","type":"text/plain"},"key":"identity-id","value":""},{"disabled":false,"description":{"content":"Max number of results to return.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"If *true* it will populate a list of translation messages in the response.","type":"text/plain"},"key":"include-translation-messages","value":""},{"disabled":false,"description":{"content":"Filter recommendations using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**access.name**: *co*\n\n**access.type**: *eq, in*\n\n**access.description**: *co*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **access.name, access.type**\n\nBy default the recommendations are sorted by highest confidence first.","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Identity Access Request Recommendations' (get-access-request-recommendations)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Identity Access Request Recommendations + + + +This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. + +
Query Parameters
+ +List of access request recommendations for the identityId + +
Schema array
    access object
    messages object[]
    translationMessages undefined[]
    + +The list of translation messages + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-account-activity.api.mdx b/products/idn/api/beta/get-account-activity.api.mdx new file mode 100644 index 000000000..82db2257d --- /dev/null +++ b/products/idn/api/beta/get-account-activity.api.mdx @@ -0,0 +1,99 @@ +--- +id: get-account-activity +sidebar_label: Get Account Activity +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAccountActivity","tags":["Account Activities"],"description":"This gets a single account activity by its id.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The account activity id","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"An account activity object","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the account activity itself","example":"2c9180835d2e5168015d32f890ca1581"},"name":{"type":"string","example":"2c9180835d2e5168015d32f890ca1581"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z"},"completed":{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z"},"completionStatus":{"nullable":true,"type":"string","description":"The status after completion.","enum":["SUCCESS","FAILURE","INCOMPLETE","PENDING"],"example":"SUCCESS"},"type":{"type":"string","example":"appRequest"},"requesterIdentitySummary":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"ID of this identity summary","example":"ff80818155fe8c080155fe8d925b0316"},"name":{"type":"string","description":"Human-readable display name of identity","example":"SailPoint Services"},"identityId":{"type":"string","description":"ID of the identity that this summary represents","example":"c15b9f5cca5a4e9599eaa0e64fa921bd"},"completed":{"type":"boolean","description":"Indicates if all access items for this summary have been decided on","example":true}}},"targetIdentitySummary":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"ID of this identity summary","example":"ff80818155fe8c080155fe8d925b0316"},"name":{"type":"string","description":"Human-readable display name of identity","example":"SailPoint Services"},"identityId":{"type":"string","description":"ID of the identity that this summary represents","example":"c15b9f5cca5a4e9599eaa0e64fa921bd"},"completed":{"type":"boolean","description":"Indicates if all access items for this summary have been decided on","example":true}}},"errors":{"type":"array","items":{"type":"string"},"example":["sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds."]},"warnings":{"type":"array","items":{"type":"string"},"example":null},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Item id","example":"48c545831b264409a81befcabb0e3c5a"},"name":{"type":"string","description":"Human-readable display name of item","example":"48c545831b264409a81befcabb0e3c5a"},"requested":{"type":"string","format":"date-time","description":"Date and time item was requested","example":"2017-07-11T18:45:37.098Z"},"approvalStatus":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item","nullable":true},"provisioningStatus":{"type":"string","enum":["PENDING","FINISHED","UNVERIFIABLE","COMMITED","FAILED","RETRY"],"description":"Provisioning state of an account activity item","example":"PENDING"},"requesterComment":{"type":"object","nullable":true,"properties":{"commenterId":{"type":"string","description":"Id of the identity making the comment","example":"2c918084660f45d6016617daa9210584"},"commenterName":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"},"body":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat."},"date":{"type":"string","format":"date-time","description":"Date and time comment was made","example":"2017-07-11T18:45:37.098Z"}}},"reviewerIdentitySummary":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"ID of this identity summary","example":"ff80818155fe8c080155fe8d925b0316"},"name":{"type":"string","description":"Human-readable display name of identity","example":"SailPoint Services"},"identityId":{"type":"string","description":"ID of the identity that this summary represents","example":"c15b9f5cca5a4e9599eaa0e64fa921bd"},"completed":{"type":"boolean","description":"Indicates if all access items for this summary have been decided on","example":true}}},"reviewerComment":{"type":"object","nullable":true,"properties":{"commenterId":{"type":"string","description":"Id of the identity making the comment","example":"2c918084660f45d6016617daa9210584"},"commenterName":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"},"body":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat."},"date":{"type":"string","format":"date-time","description":"Date and time comment was made","example":"2017-07-11T18:45:37.098Z"}}},"operation":{"nullable":true,"type":"string","enum":["ADD","CREATE","MODIFY","DELETE","DISABLE","ENABLE","UNLOCK","LOCK","REMOVE"],"description":"Represents an operation in an account activity item","example":"ADD"},"attribute":{"type":"string","description":"Attribute to which account activity applies","nullable":true,"example":"detectedRoles"},"value":{"type":"string","description":"Value of attribute","nullable":true,"example":"Treasury Analyst [AccessProfile-1529010191212]"},"nativeIdentity":{"nullable":true,"type":"string","description":"Native identity in the target system to which the account activity applies","example":"Sandie.Camero"},"sourceId":{"type":"string","description":"Id of Source to which account activity applies","example":"2c91808363ef85290164000587130c0c"},"accountRequestInfo":{"type":"object","nullable":true,"properties":{"requestedObjectId":{"type":"string","description":"Id of requested object","example":"2c91808563ef85690164001c31140c0c"},"requestedObjectName":{"type":"string","description":"Human-readable name of requested object","example":"Treasury Analyst"},"requestedObjectType":{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"Enum represented the currently supported requestable object types. Additional values may be added in the future without notice.","example":"ACCESS_PROFILE"}},"description":"If an account activity item is associated with an access request, captures details of that request."},"clientMetadata":{"nullable":true,"type":"object","additionalProperties":{"type":"string"},"description":"Arbitrary key-value pairs, if any were included in the corresponding access request item","example":{"customKey1":"custom value 1","customKey2":"custom value 2"}},"removeDate":{"nullable":true,"type":"string","description":"The date the role or access profile is no longer assigned to the specified identity.","format":"date-time","example":"2020-07-11T00:00:00Z"}}}},"executionStatus":{"type":"string","description":"The current state of execution.","enum":["EXECUTING","VERIFYING","TERMINATED","COMPLETED"],"example":"COMPLETED"},"clientMetadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Arbitrary key-value pairs, if any were included in the corresponding access request"},"cancelable":{"type":"boolean","description":"Whether the account activity can be canceled before completion"},"cancelComment":{"type":"object","nullable":true,"properties":{"commenterId":{"type":"string","description":"Id of the identity making the comment","example":"2c918084660f45d6016617daa9210584"},"commenterName":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"},"body":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat."},"date":{"type":"string","format":"date-time","description":"Date and time comment was made","example":"2017-07-11T18:45:37.098Z"}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/account-activities/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Account Activity","description":{"content":"This gets a single account activity by its id.","type":"text/plain"},"url":{"path":["account-activities",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The account activity id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Account Activity' (get-account-activity)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Account Activity + + + +This gets a single account activity by its id. + +
Path Parameters
+ +An account activity object + +
Schema
    requesterIdentitySummary object
    targetIdentitySummary object
    items object[]
    requesterComment object
    reviewerIdentitySummary object
    reviewerComment object
    accountRequestInfo object
    + +If an account activity item is associated with an access request, captures details of that request. + +
    clientMetadata object
    + +Arbitrary key-value pairs, if any were included in the corresponding access request item + +
  • property name* string
    • clientMetadata object
    + +Arbitrary key-value pairs, if any were included in the corresponding access request + +
  • property name* string
    • cancelComment object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-account-aggregation-status.api.mdx b/products/idn/api/beta/get-account-aggregation-status.api.mdx new file mode 100644 index 000000000..7eba10bb5 --- /dev/null +++ b/products/idn/api/beta/get-account-aggregation-status.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-account-aggregation-status +sidebar_label: In-progress Account Aggregation status +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAccountAggregationStatus","tags":["Account Aggregations"],"description":"This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far.\n\nAccounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not.\n\nSince this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint.\n\n*Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.*\n\nA token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN or DASHBOARD authority is required to call this API.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The account aggregation id","example":"2c91808477a6b0c60177a81146b8110b"}],"responses":{"200":{"description":"An account aggregation status object","content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","format":"date-time","example":"2021-01-31T14:30:05.104Z","description":"When the aggregation started."},"status":{"type":"string","enum":["STARTED","ACCOUNTS_COLLECTED","COMPLETED","CANCELLED","RETRIED","TERMINATED"],"example":"ACCOUNTS_COLLECTED","description":"STARTED - Aggregation started, but source account iteration has not completed.\n\nACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed.\n\nCOMPLETED - Aggregation completed (*possibly with errors*).\n\nCANCELLED - Aggregation cancelled by user.\n\nRETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance.\n\nTERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance.\n"},"totalAccounts":{"type":"integer","example":520,"description":"The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.*"},"processedAccounts":{"type":"integer","example":150,"description":"The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.*"}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/account-aggregations/{id}/status","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"In-progress Account Aggregation status","description":{"content":"This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far.\n\nAccounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not.\n\nSince this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint.\n\n*Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.*\n\nA token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN or DASHBOARD authority is required to call this API.","type":"text/plain"},"url":{"path":["account-aggregations",":id","status"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The account aggregation id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'In-progress Account Aggregation status' (get-account-aggregation-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## In-progress Account Aggregation status + + + +This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. + +Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. + +Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. + +*Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* + +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN or DASHBOARD authority is required to call this API. + +
Path Parameters
+ +An account aggregation status object + +
Schema
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-account-entitlements.api.mdx b/products/idn/api/beta/get-account-entitlements.api.mdx new file mode 100644 index 000000000..dea2b42d3 --- /dev/null +++ b/products/idn/api/beta/get-account-entitlements.api.mdx @@ -0,0 +1,100 @@ +--- +id: get-account-entitlements +sidebar_label: Account Entitlements +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAccountEntitlements","tags":["Accounts"],"description":"This API returns entitlements of the account. \nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:accounts:read"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The account id","example":"ef38f94347e94562b5bb8424a56397d8"},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"An array of account entitlements","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The entitlement id","example":"2c91808874ff91550175097daaec161c"},"name":{"type":"string","description":"The entitlement name","example":"LauncherTest2"},"created":{"type":"string","description":"Time when the entitlement was created","format":"date-time","example":"2020-10-08T18:33:52.029Z"},"modified":{"type":"string","description":"Time when the entitlement was last modified","format":"date-time","example":"2020-10-08T18:33:52.029Z"},"attribute":{"type":"string","description":"The entitlement attribute name","example":"memberOf"},"value":{"type":"string","description":"The value of the entitlement","example":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local"},"sourceSchemaObjectType":{"type":"string","description":"The object type of the entitlement from the source schema","example":"group"},"privileged":{"type":"boolean","default":false,"description":"True if the entitlement is privileged","example":true},"cloudGoverned":{"type":"boolean","default":false,"description":"True if the entitlement is cloud governed","example":true},"description":{"type":"string","description":"The description of the entitlement","example":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local"},"requestable":{"type":"boolean","default":false,"description":"True if the entitlement is requestable","example":true},"attributes":{"type":"object","description":"A map of free-form key-value pairs from the source system","example":{"fieldName":"fieldValue"},"additionalProperties":true},"source":{"type":"object","properties":{"id":{"type":"string","description":"The source ID","example":"2c9180827ca885d7017ca8ce28a000eb"},"type":{"type":"string","description":"The source type, will always be \"SOURCE\"","example":"SOURCE"},"name":{"type":"string","description":"The source name","example":"ODS-AD-Source"}}},"owner":{"type":"object","description":"Simplified DTO for the owner object of the entitlement","properties":{"id":{"type":"string","description":"The owner id for the entitlement","example":"2a2fdacca5e345f18bf7970cfbb8fec2"},"name":{"type":"string","description":"The owner name for the entitlement","example":"identity 1"},"type":{"type":"string","enum":["IDENTITY"],"description":"The type of the owner. Initially only type IDENTITY is supported","example":"IDENTITY"}}},"directPermissions":{"type":"array","items":{"type":"object","description":"Simplified DTO for the Permission objects stored in SailPoint's database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers.","properties":{"rights":{"type":"array","description":"All the rights (e.g. actions) that this permission allows on the target","readOnly":true,"items":{"type":"string","example":"SELECT"}},"target":{"type":"string","description":"The target the permission would grants rights on.","readOnly":true,"example":"SYS.GV_$TRANSACTION"}}}},"segments":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of IDs of segments, if any, to which this Entitlement is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]},"manuallyUpdatedFields":{"description":"Object contains entitlement manually updated fields. Field value is true if is was updated manually via entitlement import csv or patch endpoint. Field value is false if that property value has not been changed after first entitlement aggregation. Values for all manually updatable fields must be specified. For now only two entitlement fields support this: DISPLAY_NAME and DESCRIPTION.","example":{"DISPLAY_NAME":true,"DESCRIPTION":true},"type":"object","properties":{"DISPLAY_NAME":{"type":"boolean","default":false,"description":"True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation.\nField refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property.","example":true},"DESCRIPTION":{"type":"boolean","default":false,"description":"True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation.\nField refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property.","example":true}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/accounts/{id}/entitlements","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Account Entitlements","description":{"content":"This API returns entitlements of the account. \nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts",":id","entitlements"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The account id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Account Entitlements' (get-account-entitlements)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Account Entitlements + + + +This API returns entitlements of the account. +A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
Query Parameters
+ +An array of account entitlements + +
Schema array
    attributes object
    + +A map of free-form key-value pairs from the source system + +
    source object
    owner object
    + +Simplified DTO for the owner object of the entitlement + +
    directPermissions object[]
    manuallyUpdatedFields object
    + +Object contains entitlement manually updated fields. Field value is true if is was updated manually via entitlement import csv or patch endpoint. Field value is false if that property value has not been changed after first entitlement aggregation. Values for all manually updatable fields must be specified. For now only two entitlement fields support this: DISPLAY_NAME and DESCRIPTION. + +
    `name` property."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}> `description` property."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-account.api.mdx b/products/idn/api/beta/get-account.api.mdx new file mode 100644 index 000000000..6325f7e65 --- /dev/null +++ b/products/idn/api/beta/get-account.api.mdx @@ -0,0 +1,92 @@ +--- +id: get-account +sidebar_label: Account Details +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAccount","tags":["Accounts"],"description":"This API returns the details for a single account based on the ID. \nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:accounts:read","idn:accounts:manage"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The account ID","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"An account object","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"},"modified":{"description":"Last modification date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}},{"type":"object","required":["sourceId","sourceName","attributes","authoritative","disabled","locked","nativeIdentity","systemAccount","uncorrelated","manuallyCorrelated","hasEntitlements"],"properties":{"sourceId":{"type":"string","example":"2c9180835d2e5168015d32f890ca1581","description":"The unique ID of the source this account belongs to"},"sourceName":{"type":"string","example":"Employees","description":"The display name of the source this account belongs to"},"identityId":{"type":"string","example":"2c9180835d2e5168015d32f890ca1581","description":"The unique ID of the identity this account is correlated to"},"attributes":{"type":"object","additionalProperties":true,"description":"The account attributes that are aggregated","example":{"firstName":"SailPoint","lastName":"Support","displayName":"SailPoint Support"}},"authoritative":{"type":"boolean","description":"Indicates if this account is from an authoritative source","example":false},"description":{"type":"string","description":"A description of the account","nullable":true,"example":null},"disabled":{"type":"boolean","description":"Indicates if the account is currently disabled","example":false},"locked":{"type":"boolean","description":"Indicates if the account is currently locked","example":false},"nativeIdentity":{"type":"string","description":"The unique ID of the account generated by the source system","example":"552775"},"systemAccount":{"type":"boolean","example":false,"description":"If true, this is a user account within IdentityNow. If false, this is an account from a source system."},"uncorrelated":{"type":"boolean","description":"Indicates if this account is not correlated to an identity","example":false},"uuid":{"type":"string","description":"The unique ID of the account as determined by the account schema","example":"slpt.support","nullable":true},"manuallyCorrelated":{"type":"boolean","description":"Indicates if the account has been manually correlated to an identity","example":false},"hasEntitlements":{"type":"boolean","description":"Indicates if the account has entitlements","example":true}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/accounts/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Account Details","description":{"content":"This API returns the details for a single account based on the ID. \nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The account ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Account Details' (get-account)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Account Details + + + +This API returns the details for a single account based on the ID. +A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
+ +An account object + +
Schema
    attributes object
    + +The account attributes that are aggregated + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-active-campaigns.api.mdx b/products/idn/api/beta/get-active-campaigns.api.mdx new file mode 100644 index 000000000..b8a8fb1b1 --- /dev/null +++ b/products/idn/api/beta/get-active-campaigns.api.mdx @@ -0,0 +1,123 @@ +--- +id: get-active-campaigns +sidebar_label: List Campaigns +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getActiveCampaigns","tags":["Certification Campaigns"],"description":"Gets campaigns and returns them in a list. Can provide increased level of detail for each campaign if provided the correct query.","security":[{"oauth2":[]}],"deprecated":true,"parameters":[{"in":"query","name":"detail","schema":{"type":"string","enum":["SLIM","FULL"]},"required":false,"description":"Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.","example":"FULL"},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"required":false,"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**status**: *eq, in*","example":"name eq \"Manager Campaign\""},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"required":false,"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**, **created**","example":"name"}],"responses":{"200":{"description":"A list of campaign objects.","content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"type":"object","title":"Slim Campaign","required":["name","description","type"],"properties":{"id":{"type":"string","readOnly":true,"description":"Id of the campaign","example":"2c9079b270a266a60170a2779fcb0007"},"name":{"description":"The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","type":"string","example":"Manager Campaign"},"description":{"type":"string","description":"The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","example":"Everyone needs to be reviewed by their manager"},"deadline":{"type":"string","format":"date-time","description":"The campaign's completion deadline.","example":"2020-03-15T10:00:01.456Z"},"type":{"type":"string","description":"The type of campaign. Could be extended in the future.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"},"emailNotificationEnabled":{"type":"boolean","description":"Enables email notification for this campaign","default":false,"example":false},"autoRevokeAllowed":{"type":"boolean","description":"Allows auto revoke for this campaign","default":false,"example":false},"recommendationsEnabled":{"type":"boolean","description":"Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.","default":false,"example":true},"status":{"type":"string","description":"The campaign's current status.","readOnly":true,"enum":["PENDING","STAGED","CANCELING","ACTIVATING","ACTIVE","COMPLETING","COMPLETED","ERROR","ARCHIVED"],"example":"ACTIVE"},"correlatedStatus":{"type":"string","description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"}}},{"type":"object","title":"Campaign","allOf":[{"type":"object","title":"Slim Campaign","required":["name","description","type"],"properties":{"id":{"type":"string","readOnly":true,"description":"Id of the campaign","example":"2c9079b270a266a60170a2779fcb0007"},"name":{"description":"The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","type":"string","example":"Manager Campaign"},"description":{"type":"string","description":"The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","example":"Everyone needs to be reviewed by their manager"},"deadline":{"type":"string","format":"date-time","description":"The campaign's completion deadline.","example":"2020-03-15T10:00:01.456Z"},"type":{"type":"string","description":"The type of campaign. Could be extended in the future.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"},"emailNotificationEnabled":{"type":"boolean","description":"Enables email notification for this campaign","default":false,"example":false},"autoRevokeAllowed":{"type":"boolean","description":"Allows auto revoke for this campaign","default":false,"example":false},"recommendationsEnabled":{"type":"boolean","description":"Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.","default":false,"example":true},"status":{"type":"string","description":"The campaign's current status.","readOnly":true,"enum":["PENDING","STAGED","CANCELING","ACTIVATING","ACTIVE","COMPLETING","COMPLETED","ERROR","ARCHIVED"],"example":"ACTIVE"},"correlatedStatus":{"type":"string","description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"}}},{"type":"object","properties":{"created":{"type":"string","readOnly":true,"format":"date-time","description":"Created time of the campaign","example":"2020-03-03T22:15:13.611Z"},"modified":{"type":"string","readOnly":true,"format":"date-time","description":"Modified time of the campaign","example":"2020-03-03T22:20:12.674Z"},"correlatedStatus":{"description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"},"filter":{"type":"object","description":"Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank.","properties":{"id":{"type":"string","description":"The ID of whatever type of filter is being used.","example":"0fbe863c063c4c88a35fd7f17e8a3df5"},"type":{"type":"string","description":"Type of the filter","enum":["CAMPAIGN_FILTER","RULE"],"example":"CAMPAIGN_FILTER"},"name":{"type":"string","description":"Name of the filter","example":"Test Filter"}}},"sunsetCommentsRequired":{"type":"boolean","description":"Determines if comments on sunset date changes are required.","default":true,"example":true},"sourceOwnerCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SOURCE_OWNER.","properties":{"sourceIds":{"type":"array","description":"The list of sources to be included in the campaign.","items":{"type":"string"},"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]}}},"searchCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SEARCH.","properties":{"type":{"type":"string","description":"The type of search campaign represented.","enum":["IDENTITY","ACCESS"],"example":"ACCESS"},"description":{"type":"string","description":"Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available.","example":"Search Campaign description"},"reviewer":{"description":"If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"query":{"type":"string","description":"The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set.","example":"Search Campaign query description"},"identityIds":{"type":"array","description":"A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set.","items":{"type":"string"},"maxItems":1000,"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]},"accessConstraints":{"type":"array","description":"Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT","ACCESS_PROFILE","ROLE"],"description":"Type of Access","example":"ENTITLEMENT"},"ids":{"description":"Must be set only if operator is SELECTED.","type":"array","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"operator":{"type":"string","enum":["ALL","SELECTED"],"description":"Used to determine whether the scope of the campaign should be reduced for selected ids or all.","example":"SELECTED"}},"required":["type","operator"]},"maxItems":1000}},"required":["type"]},"roleCompositionCampaignInfo":{"type":"object","description":"Optional configuration options for role composition campaigns.","properties":{"reviewer":{"description":"If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"roleIds":{"type":"array","description":"Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"remediatorRef":{"type":"object","description":"This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin.","properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Legal Remediator Type","example":"IDENTITY"},"id":{"type":"string","description":"The ID of the remediator.","example":"2c90ad2a70ace7d50170acf22ca90010"},"name":{"type":"string","description":"The name of the remediator.","readOnly":true,"example":"Role Admin"}},"required":["type","id"]},"query":{"type":"string","description":"Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","example":"Search Query"},"description":{"type":"string","description":"Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available.","example":"Role Composition Description"}},"required":["remediatorRef"]},"alerts":{"type":"array","description":"A list of errors and warnings that have accumulated.","readOnly":true,"items":{"type":"object","properties":{"level":{"type":"string","enum":["ERROR","WARN","INFO"],"description":"Denotes the level of the message","example":"ERROR"},"localizations":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}},"totalCertifications":{"type":"integer","description":"The total number of certifications in this campaign.","readOnly":true,"example":100},"completedCertifications":{"type":"integer","description":"The number of completed certifications in this campaign.","readOnly":true,"example":10},"sourcesWithOrphanEntitlements":{"type":"array","description":"A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented).","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the source","example":"2c90ad2a70ace7d50170acf22ca90010"},"type":{"type":"string","enum":["SOURCE"],"description":"Type","example":"SOURCE"},"name":{"type":"string","description":"Name of the source","example":"Source with orphan entitlements"}}}},"mandatoryCommentRequirement":{"type":"string","description":"Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.","enum":["ALL_DECISIONS","REVOKE_ONLY_DECISIONS","NO_DECISIONS"],"example":"NO_DECISIONS"}}}]}]}},"examples":{"Slim Campaign":{"description":"List of Slim Campaigns that would result from not specifying *detail* or specifying SLIM","value":[{"id":"2c918086719eec070171a7e3355a360a","name":"Manager Review","description":"A review of everyone's access by their manager.","deadline":"2020-12-25T06:00:00.123Z","type":"MANAGER","status":"ACTIVE","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false},{"id":"7e1a731e3fb845cfbe58112ba4673ee4","name":"Search Campaign","description":"Search Campaign Info","deadline":"2022-07-26T15:42:44Z","type":"SEARCH","status":"ACTIVE","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false},{"id":"2c918086719eec070171a7e3355a412b","name":"AD Source Review","description":"A review of our AD source.","deadline":"2020-12-25T06:00:00.123Z","type":"SOURCE_OWNER","status":"STAGED","emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"correlatedStatus":"CORRELATED"},{"id":"3b2e2e5821e84127b6d693d41c40623b","name":"Role Composition Campaign","description":"A review done by a role owner.","deadline":"2020-12-25T06:00:00.468Z","type":"ROLE_COMPOSITION","status":"ACTIVE","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false}]},"Full Campaign":{"description":"List of Campaigns that would result from specifying *detail* as FULL","value":[{"id":"078696a575e045c68d6722ccdb9f101d","name":"Role Composition Campaign","description":"A review done by a role owner.","deadline":"2020-12-25T06:00:00.468Z","type":"ROLE_COMPOSITION","status":"ERROR","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"created":"2022-08-02T20:29:51.065Z","modified":"2022-08-02T20:29:51.331Z","filter":{"type":"CAMPAIGN_FILTER","id":"0fbe863c063c4c88a35fd7f17e8a3df5","name":"Test Role Composition Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":null,"roleCompositionCampaignInfo":{"remediatorRef":{"type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"reviewerId":null,"reviewer":null,"roleIds":["b15d609fc5c8434b865fe552315fda8f"],"query":null,"description":null},"alerts":[{"level":"ERROR","localizations":[{"locale":"en","localeOrigin":"DEFAULT","text":"Composite criterion must have children non-composite criterion must not."}]}],"totalCertifications":0,"completedCertifications":0,"sourcesWithOrphanEntitlements":null,"mandatoryCommentRequirement":"NO_DECISIONS"},{"id":"1be8fc1103914bf0a4e14e316b6a7b7c","name":"Manager Review","description":"A review of everyone's access by their manager.","deadline":"2020-12-25T06:00:00.468Z","type":"MANAGER","status":"STAGED","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"created":"2022-08-02T19:00:27.731Z","modified":"2022-08-02T19:00:34.391Z","filter":{"type":"CAMPAIGN_FILTER","id":"0fbe863c063c4c88a35fd7f17e8a3df5","name":"Test Manager Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":null,"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":5,"completedCertifications":0,"sourcesWithOrphanEntitlements":[],"mandatoryCommentRequirement":"NO_DECISIONS"},{"id":"7e1a731e3fb845cfbe58112ba4673ee4","name":"Search Campaign","description":"Search Campaign for Identities","deadline":"2022-07-26T15:42:44Z","type":"SEARCH","status":"ACTIVE","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"created":"2022-07-25T15:42:18.276Z","modified":"2022-07-25T15:42:53.718Z","filter":{"type":"CAMPAIGN_FILTER","id":"0fbe863c063c4c88a35fd7f17e8a3df5","name":"Test Search Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":{"type":"IDENTITY","description":"Example of Search Campaign","reviewer":{"type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":null},"query":"user","identityIds":null,"accessConstraints":[]},"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":6,"completedCertifications":0,"sourcesWithOrphanEntitlements":[],"mandatoryCommentRequirement":"NO_DECISIONS"},{"id":"ad3cf3dd50394b1bad646de4bc51b999","name":"Source Owner Campaign","description":"Example for Source Owner Campaign","deadline":"2022-08-10T17:09:02Z","type":"SOURCE_OWNER","status":"ACTIVE","emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"created":"2022-07-27T17:04:19.027Z","modified":"2022-07-27T17:09:13.925Z","filter":{"type":"CAMPAIGN_FILTER","id":"0fbe863c063c4c88a35fd7f17e8a3df5","name":"Test Source Owner Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":{"sourceIds":["2c91808781fd5aea01821200dc88318e"]},"searchCampaignInfo":null,"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":2,"completedCertifications":0,"sourcesWithOrphanEntitlements":[],"correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/campaigns","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Campaigns","description":{"content":"Gets campaigns and returns them in a list. Can provide increased level of detail for each campaign if provided the correct query.","type":"text/plain"},"url":{"path":["campaigns"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.","type":"text/plain"},"key":"detail","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**status**: *eq, in*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**, **created**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Campaigns' (get-active-campaigns)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Campaigns + +:::caution deprecated + +This endpoint has been deprecated and may be removed in future versions of the API. + +::: + +Gets campaigns and returns them in a list. Can provide increased level of detail for each campaign if provided the correct query. + +
Query Parameters
+ +A list of campaign objects. + +
Schema array
    oneOf
    filter object
    + +Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank. + +
    sourceOwnerCampaignInfo object
    + +Must be set only if the campaign type is SOURCE_OWNER. + +
    searchCampaignInfo object
    + +Must be set only if the campaign type is SEARCH. + +
    reviewer object
    + +If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP + +
    accessConstraints object[]
    + +**Possible values:** `<= 1000` + +
    + +Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. + +
    roleCompositionCampaignInfo object
    + +Optional configuration options for role composition campaigns. + +
    reviewer object
    + +If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP + +
    remediatorRef object
    + +This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin. + +
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
    localizations object[]
    sourcesWithOrphanEntitlements object[]
    + +A list of sources in the campaign that contain \"orphan entitlements\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-campaign-reports-config.api.mdx b/products/idn/api/beta/get-campaign-reports-config.api.mdx new file mode 100644 index 000000000..68008b757 --- /dev/null +++ b/products/idn/api/beta/get-campaign-reports-config.api.mdx @@ -0,0 +1,64 @@ +--- +id: get-campaign-reports-config +sidebar_label: Get Campaign Reports Configuration +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getCampaignReportsConfig","tags":["Certification Campaigns"],"description":"Fetches configuration for campaign reports. Currently it includes only one element - identity attributes defined as custom report columns.\nRequires roles of CERT_ADMIN and ORG_ADMIN.","responses":{"200":{"description":"Campaign Report Configuration","content":{"application/json":{"schema":{"type":"object","title":"Campaign Reports Configuration","properties":{"identityAttributeColumns":{"type":"array","items":{"type":"string"},"example":["firstname","lastname"]}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/campaigns/reports-configuration","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Campaign Reports Configuration","description":{"content":"Fetches configuration for campaign reports. Currently it includes only one element - identity attributes defined as custom report columns.\nRequires roles of CERT_ADMIN and ORG_ADMIN.","type":"text/plain"},"url":{"path":["campaigns","reports-configuration"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Campaign Reports Configuration' (get-campaign-reports-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Campaign Reports Configuration + + + +Fetches configuration for campaign reports. Currently it includes only one element - identity attributes defined as custom report columns. +Requires roles of CERT_ADMIN and ORG_ADMIN. + +
+ +Campaign Report Configuration + +
Schema
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-campaign-reports.api.mdx b/products/idn/api/beta/get-campaign-reports.api.mdx new file mode 100644 index 000000000..206109764 --- /dev/null +++ b/products/idn/api/beta/get-campaign-reports.api.mdx @@ -0,0 +1,76 @@ +--- +id: get-campaign-reports +sidebar_label: Get Campaign Reports +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getCampaignReports","tags":["Certification Campaigns"],"description":"Fetches all reports for a certification campaign by campaign ID.\nRequires roles of CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN","parameters":[{"in":"path","name":"id","schema":{"type":"string","example":"2c91808571bcfcf80171c23e4b4221fc"},"required":true,"description":"The ID of the campaign for which reports are being fetched."}],"responses":{"200":{"description":"Array of campaign report objects.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","title":"Campaign Report","required":["reportType"],"allOf":[{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object","properties":{"status":{"type":"string","enum":["SUCCESS","WARNING","ERROR","TERMINATED","TEMP_ERROR","PENDING"]}}}]},{"type":"object","properties":{"reportType":{"type":"string","enum":["CAMPAIGN_COMPOSITION_REPORT","CAMPAIGN_REMEDIATION_STATUS_REPORT","CAMPAIGN_STATUS_REPORT","CERTIFICATION_SIGNOFF_REPORT"]},"lastRunAt":{"type":"string","readOnly":true,"format":"date-time","description":"The most recent date and time this report was run"}}}],"example":{"type":"REPORT_RESULT","id":"2c91808568c529c60168cca6f90c1313","name":"Campaign Composition Report","status":"SUCCESS","reportType":"CAMPAIGN_COMPOSITION_REPORT","lastRunAt":"2019-12-19T13:49:37.385Z"}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/campaigns/{id}/reports","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Campaign Reports","description":{"content":"Fetches all reports for a certification campaign by campaign ID.\nRequires roles of CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN","type":"text/plain"},"url":{"path":["campaigns",":id","reports"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the campaign for which reports are being fetched.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Campaign Reports' (get-campaign-reports)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Campaign Reports + + + +Fetches all reports for a certification campaign by campaign ID. +Requires roles of CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN + +
Path Parameters
+ +Array of campaign report objects. + +
Schema array
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-campaign-template-schedule.api.mdx b/products/idn/api/beta/get-campaign-template-schedule.api.mdx new file mode 100644 index 000000000..e6df54987 --- /dev/null +++ b/products/idn/api/beta/get-campaign-template-schedule.api.mdx @@ -0,0 +1,147 @@ +--- +id: get-campaign-template-schedule +sidebar_label: Gets a Campaign Template's Schedule +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getCampaignTemplateSchedule","tags":["Certification Campaigns"],"description":"Gets the schedule for a campaign template. Returns a 404 if there is no schedule set.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the campaign template whose schedule is being fetched."}],"responses":{"200":{"description":"The current schedule for the campaign template. See the PUT endpoint documentation for more examples.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have 'hours' set, but not 'days'; a WEEKLY schedule can have both 'hours' and 'days' set.","enum":["DAILY","WEEKLY","MONTHLY","ANNUALLY","CALENDAR"]},"months":{"type":"object","description":"Specifies which months of a schedule are active. Only valid for ANNUALLY schedule types. Examples:\n\nOn February and March:\n* type LIST\n* values \"2\", \"3\"\n\nEvery 3 months, starting in January (quarterly):\n* type LIST\n* values \"1\"\n* interval 3\n\nEvery two months between July and December:\n* type RANGE\n* values \"7\", \"12\"\n* interval 2\n","properties":{"type":{"type":"string","enum":["LIST","RANGE"]},"values":{"type":"array","items":{"type":"string"}},"interval":{"type":"integer"}},"required":["type","values"]},"days":{"type":"object","description":"Specifies which day(s) a schedule is active for. This is required for all schedule types except DAILY.\nThe \"values\" field holds different data depending on the type of schedule:\n* WEEKLY: days of the week (1-7)\n* MONTHLY: days of the month (1-31, L, L-1...)\n* ANNUALLY: if the \"months\" field is also set: days of the month (1-31, L, L-1...); otherwise: ISO-8601 dates without year (\"--12-31\")\n* CALENDAR: ISO-8601 dates (\"2020-12-31\")\n\nNote that CALENDAR only supports the LIST type, and ANNUALLY does not support the RANGE type when provided\nwith ISO-8601 dates without year.\n\nExamples:\n\nOn Sundays:\n* type LIST\n* values \"1\"\n\nThe second to last day of the month:\n* type LIST\n* values \"L-1\"\n\nFrom the 20th to the last day of the month:\n* type RANGE\n* values \"20\", \"L\"\n\nEvery March 2nd:\n* type LIST\n* values \"--03-02\"\n\nOn March 2nd, 2021:\n* type: LIST\n* values \"2021-03-02\"\n","properties":{"type":{"type":"string","enum":["LIST","RANGE"]},"values":{"type":"array","items":{"type":"string"}},"interval":{"type":"integer"}},"required":["type","values"]},"hours":{"type":"object","description":"Specifies which hour(s) a schedule is active for. Examples:\n\nEvery three hours starting from 8AM, inclusive:\n* type LIST\n* values \"8\"\n* interval 3\n\nDuring business hours:\n* type RANGE\n* values \"9\", \"5\"\n\nAt 5AM, noon, and 5PM:\n* type LIST\n* values \"5\", \"12\", \"17\"\n","properties":{"type":{"type":"string","enum":["LIST","RANGE"]},"values":{"type":"array","items":{"type":"string"}},"interval":{"type":"integer"}},"required":["type","values"]},"expiration":{"type":"string","format":"date-time","description":"Specifies the time after which this schedule will no longer occur."},"timeZoneId":{"type":"string","description":"The time zone to use when running the schedule. For instance, if the schedule is a DAILY schedule that runs at 1AM, and this field is set to \"CST\", the schedule will run at 1AM CST."}},"required":["type","hours"],"example":{"type":"MONTHLY","hours":{"type":"LIST","values":["0"]},"days":{"type":"LIST","values":["1"]}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/campaign-templates/{id}/schedule","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Gets a Campaign Template's Schedule","description":{"content":"Gets the schedule for a campaign template. Returns a 404 if there is no schedule set.","type":"text/plain"},"url":{"path":["campaign-templates",":id","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the campaign template whose schedule is being fetched.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Gets a Campaign Template's Schedule' (get-campaign-template-schedule)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Gets a Campaign Template's Schedule + + + +Gets the schedule for a campaign template. Returns a 404 if there is no schedule set. + +
Path Parameters
+ +The current schedule for the campaign template. See the PUT endpoint documentation for more examples. + +
Schema
    months object
    + +Specifies which months of a schedule are active. Only valid for ANNUALLY schedule types. Examples: + +On February and March: +* type LIST +* values "2", "3" + +Every 3 months, starting in January (quarterly): +* type LIST +* values "1" +* interval 3 + +Every two months between July and December: +* type RANGE +* values "7", "12" +* interval 2 + + +
    days object
    + +Specifies which day(s) a schedule is active for. This is required for all schedule types except DAILY. +The "values" field holds different data depending on the type of schedule: +* WEEKLY: days of the week (1-7) +* MONTHLY: days of the month (1-31, L, L-1...) +* ANNUALLY: if the "months" field is also set: days of the month (1-31, L, L-1...); otherwise: ISO-8601 dates without year ("--12-31") +* CALENDAR: ISO-8601 dates ("2020-12-31") + +Note that CALENDAR only supports the LIST type, and ANNUALLY does not support the RANGE type when provided +with ISO-8601 dates without year. + +Examples: + +On Sundays: +* type LIST +* values "1" + +The second to last day of the month: +* type LIST +* values "L-1" + +From the 20th to the last day of the month: +* type RANGE +* values "20", "L" + +Every March 2nd: +* type LIST +* values "--03-02" + +On March 2nd, 2021: +* type: LIST +* values "2021-03-02" + + +
    hours object
    + +Specifies which hour(s) a schedule is active for. Examples: + +Every three hours starting from 8AM, inclusive: +* type LIST +* values "8" +* interval 3 + +During business hours: +* type RANGE +* values "9", "5" + +At 5AM, noon, and 5PM: +* type LIST +* values "5", "12", "17" + + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-campaign-template.api.mdx b/products/idn/api/beta/get-campaign-template.api.mdx new file mode 100644 index 000000000..ee0624eb4 --- /dev/null +++ b/products/idn/api/beta/get-campaign-template.api.mdx @@ -0,0 +1,135 @@ +--- +id: get-campaign-template +sidebar_label: Get a Campaign Template +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getCampaignTemplate","tags":["Certification Campaigns"],"description":"Fetches a campaign template by ID.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The desired campaign template's ID.","example":"2c9180835d191a86015d28455b4a2329"}],"responses":{"200":{"description":"The data for the campaign matching the given ID.","content":{"application/json":{"schema":{"type":"object","description":"Campaign Template","properties":{"id":{"type":"string","description":"Id of the campaign template","example":"2c9079b270a266a60170a277bb960008"},"name":{"type":"string","description":"This template's name. Has no bearing on generated campaigns' names.","example":"Manager Campaign Template"},"description":{"type":"string","description":"This template's description. Has no bearing on generated campaigns' descriptions.","example":"Template for the annual manager campaign."},"created":{"type":"string","description":"Creation date of Campaign Template","readOnly":true,"format":"date-time","example":"2020-03-05T22:44:00.364Z"},"modified":{"type":"string","description":"Modification date of Campaign Template","readOnly":true,"format":"date-time","example":"2020-03-05T22:52:09.969Z"},"scheduled":{"type":"boolean","readOnly":true,"description":"Indicates if this campaign template has been scheduled.","example":false},"ownerRef":{"type":"object","description":"The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user.","properties":{"id":{"type":"string","description":"Id of the owner","example":"2c918086676d3e0601677611dbde220f"},"type":{"type":"string","enum":["IDENTITY"],"description":"Type of the owner","example":"IDENTITY"},"name":{"type":"string","description":"Name of the owner","example":"Mister Manager"},"email":{"type":"string","description":"Email of the owner","example":"mr.manager@example.com"}}},"deadlineDuration":{"type":"string","description":"The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign's deadline would be 2020-01-15 (the current date plus 14 days).","example":"P2W"},"campaign":{"type":"object","title":"Campaign","allOf":[{"type":"object","title":"Slim Campaign","required":["name","description","type"],"properties":{"id":{"type":"string","readOnly":true,"description":"Id of the campaign","example":"2c9079b270a266a60170a2779fcb0007"},"name":{"description":"The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","type":"string","example":"Manager Campaign"},"description":{"type":"string","description":"The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","example":"Everyone needs to be reviewed by their manager"},"deadline":{"type":"string","format":"date-time","description":"The campaign's completion deadline.","example":"2020-03-15T10:00:01.456Z"},"type":{"type":"string","description":"The type of campaign. Could be extended in the future.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"},"emailNotificationEnabled":{"type":"boolean","description":"Enables email notification for this campaign","default":false,"example":false},"autoRevokeAllowed":{"type":"boolean","description":"Allows auto revoke for this campaign","default":false,"example":false},"recommendationsEnabled":{"type":"boolean","description":"Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.","default":false,"example":true},"status":{"type":"string","description":"The campaign's current status.","readOnly":true,"enum":["PENDING","STAGED","CANCELING","ACTIVATING","ACTIVE","COMPLETING","COMPLETED","ERROR","ARCHIVED"],"example":"ACTIVE"},"correlatedStatus":{"type":"string","description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"}}},{"type":"object","properties":{"created":{"type":"string","readOnly":true,"format":"date-time","description":"Created time of the campaign","example":"2020-03-03T22:15:13.611Z"},"modified":{"type":"string","readOnly":true,"format":"date-time","description":"Modified time of the campaign","example":"2020-03-03T22:20:12.674Z"},"correlatedStatus":{"description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"},"filter":{"type":"object","description":"Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank.","properties":{"id":{"type":"string","description":"The ID of whatever type of filter is being used.","example":"0fbe863c063c4c88a35fd7f17e8a3df5"},"type":{"type":"string","description":"Type of the filter","enum":["CAMPAIGN_FILTER","RULE"],"example":"CAMPAIGN_FILTER"},"name":{"type":"string","description":"Name of the filter","example":"Test Filter"}}},"sunsetCommentsRequired":{"type":"boolean","description":"Determines if comments on sunset date changes are required.","default":true,"example":true},"sourceOwnerCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SOURCE_OWNER.","properties":{"sourceIds":{"type":"array","description":"The list of sources to be included in the campaign.","items":{"type":"string"},"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]}}},"searchCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SEARCH.","properties":{"type":{"type":"string","description":"The type of search campaign represented.","enum":["IDENTITY","ACCESS"],"example":"ACCESS"},"description":{"type":"string","description":"Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available.","example":"Search Campaign description"},"reviewer":{"description":"If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"query":{"type":"string","description":"The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set.","example":"Search Campaign query description"},"identityIds":{"type":"array","description":"A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set.","items":{"type":"string"},"maxItems":1000,"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]},"accessConstraints":{"type":"array","description":"Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT","ACCESS_PROFILE","ROLE"],"description":"Type of Access","example":"ENTITLEMENT"},"ids":{"description":"Must be set only if operator is SELECTED.","type":"array","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"operator":{"type":"string","enum":["ALL","SELECTED"],"description":"Used to determine whether the scope of the campaign should be reduced for selected ids or all.","example":"SELECTED"}},"required":["type","operator"]},"maxItems":1000}},"required":["type"]},"roleCompositionCampaignInfo":{"type":"object","description":"Optional configuration options for role composition campaigns.","properties":{"reviewer":{"description":"If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"roleIds":{"type":"array","description":"Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"remediatorRef":{"type":"object","description":"This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin.","properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Legal Remediator Type","example":"IDENTITY"},"id":{"type":"string","description":"The ID of the remediator.","example":"2c90ad2a70ace7d50170acf22ca90010"},"name":{"type":"string","description":"The name of the remediator.","readOnly":true,"example":"Role Admin"}},"required":["type","id"]},"query":{"type":"string","description":"Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","example":"Search Query"},"description":{"type":"string","description":"Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available.","example":"Role Composition Description"}},"required":["remediatorRef"]},"alerts":{"type":"array","description":"A list of errors and warnings that have accumulated.","readOnly":true,"items":{"type":"object","properties":{"level":{"type":"string","enum":["ERROR","WARN","INFO"],"description":"Denotes the level of the message","example":"ERROR"},"localizations":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}},"totalCertifications":{"type":"integer","description":"The total number of certifications in this campaign.","readOnly":true,"example":100},"completedCertifications":{"type":"integer","description":"The number of completed certifications in this campaign.","readOnly":true,"example":10},"sourcesWithOrphanEntitlements":{"type":"array","description":"A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented).","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the source","example":"2c90ad2a70ace7d50170acf22ca90010"},"type":{"type":"string","enum":["SOURCE"],"description":"Type","example":"SOURCE"},"name":{"type":"string","description":"Name of the source","example":"Source with orphan entitlements"}}}},"mandatoryCommentRequirement":{"type":"string","description":"Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.","enum":["ALL_DECISIONS","REVOKE_ONLY_DECISIONS","NO_DECISIONS"],"example":"NO_DECISIONS"}}}]}},"required":["name","description","created","modified","campaign"]},"examples":{"Manager":{"value":{"id":"e7dbec99d49349c8951bd84f58a05120","name":"Manager Review","created":"2022-08-02T19:16:42.632Z","modified":null,"description":"A review of everyone's access by their manager.","deadlineDuration":"P14D","ownerRef":{"email":"support@testmail.identitysoon.com","type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"scheduled":false,"campaign":{"created":null,"modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c","name":"Test Manager Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":null,"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":null,"completedCertifications":null,"sourcesWithOrphanEntitlements":null,"id":null,"name":"Manager Review","description":"Review everyone's access.","deadline":null,"type":"MANAGER","status":null,"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"}}},"Search":{"value":{"id":"b7e6459eed5247ac8b98a5fed81fe27f","name":"Reporting Access Review","created":"2022-07-28T19:19:40.035Z","modified":null,"description":"A review of everyone's access to the reporting system.","deadlineDuration":"P14D","ownerRef":{"email":"support@testmail.identitysoon.com","type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"scheduled":false,"campaign":{"created":null,"modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c","name":"Test Search Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":{"type":"ACCESS","description":"Identities with reporting abilities","reviewerId":null,"reviewer":null,"query":"@access(name: (\"reporter\"))","identityIds":null,"accessConstraints":[]},"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":null,"completedCertifications":null,"sourcesWithOrphanEntitlements":null,"id":null,"name":"Search Campaign Review","description":"Review everyone's access to the reporting system.","deadline":null,"type":"SEARCH","status":null,"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"}}},"Source Owner":{"value":{"id":"b9f41bc69e7a4291b9de0630396d030d","name":"AD Source Review","created":"2022-08-02T13:40:36.857Z","modified":null,"description":"A review of our AD source.","deadlineDuration":"P1M","ownerRef":{"email":"support@testmail.identitysoon.com","type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"scheduled":false,"campaign":{"created":null,"modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c","name":"Test Source Owner Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":{"sourceIds":["2c918084707deba501709d45ce4e5569"]},"searchCampaignInfo":null,"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":null,"completedCertifications":null,"sourcesWithOrphanEntitlements":null,"id":null,"name":"AD Source Review","description":"Review everyone's access.","deadline":null,"type":"SOURCE_OWNER","status":null,"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"}}},"RoleComposition":{"value":{"id":"b9f41bc69e7a4291b9de0630396d030d","name":"Campaign With Admin Role","created":"2022-08-02T13:40:36.857Z","modified":null,"description":"Campaign With Admin Role","deadlineDuration":null,"ownerRef":{"email":"support@testmail.identitysoon.com","type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"scheduled":false,"campaign":{"created":null,"modified":null,"filter":null,"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":null,"roleCompositionCampaignInfo":{"remediatorRef":{"type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"reviewerId":null,"reviewer":null,"roleIds":["b15d609fc5c8434b865fe552315fda8f"],"query":null,"description":null},"alerts":null,"totalCertifications":null,"completedCertifications":null,"sourcesWithOrphanEntitlements":null,"id":null,"name":"Campaign With Admin Role","description":"Campaign With Admin Role","deadline":null,"type":"ROLE_COMPOSITION","status":null,"emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/campaign-templates/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get a Campaign Template","description":{"content":"Fetches a campaign template by ID.","type":"text/plain"},"url":{"path":["campaign-templates",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The desired campaign template's ID.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a Campaign Template' (get-campaign-template)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a Campaign Template + + + +Fetches a campaign template by ID. + +
Path Parameters
+ +The data for the campaign matching the given ID. + +
Schema
    ownerRef object
    + +The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user. + +
    campaign object
    filter object
    + +Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank. + +
    sourceOwnerCampaignInfo object
    + +Must be set only if the campaign type is SOURCE_OWNER. + +
    searchCampaignInfo object
    + +Must be set only if the campaign type is SEARCH. + +
    reviewer object
    + +If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP + +
    accessConstraints object[]
    + +**Possible values:** `<= 1000` + +
    + +Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. + +
    roleCompositionCampaignInfo object
    + +Optional configuration options for role composition campaigns. + +
    reviewer object
    + +If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP + +
    remediatorRef object
    + +This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin. + +
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
    localizations object[]
    sourcesWithOrphanEntitlements object[]
    + +A list of sources in the campaign that contain \"orphan entitlements\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-campaign.api.mdx b/products/idn/api/beta/get-campaign.api.mdx new file mode 100644 index 000000000..28a489097 --- /dev/null +++ b/products/idn/api/beta/get-campaign.api.mdx @@ -0,0 +1,91 @@ +--- +id: get-campaign +sidebar_label: Get a campaign +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getCampaign","tags":["Certification Campaigns"],"description":"Retrieves information for an existing campaign using the campaign's ID. Authorized callers must be a reviewer for this campaign, an ORG_ADMIN, or a CERT_ADMIN.","deprecated":true,"security":[{"oauth2":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the campaign to be retrieved","example":"2c91808571bcfcf80171c23e4b4221fc"}],"responses":{"200":{"description":"A campaign object","content":{"application/json":{"schema":{"type":"object","title":"Slim Campaign","required":["name","description","type"],"properties":{"id":{"type":"string","readOnly":true,"description":"Id of the campaign","example":"2c9079b270a266a60170a2779fcb0007"},"name":{"description":"The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","type":"string","example":"Manager Campaign"},"description":{"type":"string","description":"The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","example":"Everyone needs to be reviewed by their manager"},"deadline":{"type":"string","format":"date-time","description":"The campaign's completion deadline.","example":"2020-03-15T10:00:01.456Z"},"type":{"type":"string","description":"The type of campaign. Could be extended in the future.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"},"emailNotificationEnabled":{"type":"boolean","description":"Enables email notification for this campaign","default":false,"example":false},"autoRevokeAllowed":{"type":"boolean","description":"Allows auto revoke for this campaign","default":false,"example":false},"recommendationsEnabled":{"type":"boolean","description":"Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.","default":false,"example":true},"status":{"type":"string","description":"The campaign's current status.","readOnly":true,"enum":["PENDING","STAGED","CANCELING","ACTIVATING","ACTIVE","COMPLETING","COMPLETED","ERROR","ARCHIVED"],"example":"ACTIVE"},"correlatedStatus":{"type":"string","description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"}}},"examples":{"Manager":{"value":{"id":"2c918086719eec070171a7e3355a360a","name":"Manager Review","description":"A review of everyone's access by their manager.","deadline":"2020-12-25T06:00:00.123Z","type":"MANAGER","status":"ACTIVE","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false}},"Search":{"value":{"id":"7e1a731e3fb845cfbe58112ba4673ee4","name":"Search Campaign","description":"Search Campaign Info","deadline":"2022-07-26T15:42:44Z","type":"SEARCH","status":"ACTIVE","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false}},"Source Owner":{"value":{"id":"2c918086719eec070171a7e3355a412b","name":"AD Source Review","description":"A review of our AD source.","deadline":"2020-12-25T06:00:00.123Z","type":"SOURCE_OWNER","status":"STAGED","emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"correlatedStatus":"CORRELATED"}},"RoleComposition":{"value":{"id":"3b2e2e5821e84127b6d693d41c40623b","name":"Role Composition Campaign","description":"A review done by a role owner.","deadline":"2020-12-25T06:00:00.468Z","type":"ROLE_COMPOSITION","status":"ACTIVE","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/campaigns/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get a campaign","description":{"content":"Retrieves information for an existing campaign using the campaign's ID. Authorized callers must be a reviewer for this campaign, an ORG_ADMIN, or a CERT_ADMIN.","type":"text/plain"},"url":{"path":["campaigns",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the campaign to be retrieved","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a campaign' (get-campaign)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a campaign + +:::caution deprecated + +This endpoint has been deprecated and may be removed in future versions of the API. + +::: + +Retrieves information for an existing campaign using the campaign's ID. Authorized callers must be a reviewer for this campaign, an ORG_ADMIN, or a CERT_ADMIN. + +
Path Parameters
+ +A campaign object + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-client-log-configuration.api.mdx b/products/idn/api/beta/get-client-log-configuration.api.mdx new file mode 100644 index 000000000..11069141b --- /dev/null +++ b/products/idn/api/beta/get-client-log-configuration.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-client-log-configuration +sidebar_label: Get managed cluster's log configuration +hide_title: true +hide_table_of_contents: true +api: {"tags":["Managed Clusters"],"description":"Get managed cluster's log configuration.","operationId":"getClientLogConfiguration","parameters":[{"name":"id","in":"path","description":"ID of ManagedCluster to get log configuration for","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"aClusterId"}}],"responses":{"200":{"description":"Log configuration of ManagedCluster matching given cluster ID","content":{"application/json":{"schema":{"description":"Client Runtime Logging Configuration","nullable":true,"type":"object","required":["durationMinutes","rootLevel"],"properties":{"clientId":{"description":"Log configuration's client ID","type":"string","example":"aClientId"},"durationMinutes":{"description":"Duration in minutes for log configuration to remain in effect before resetting to defaults","type":"integer","format":"int32","example":120,"minimum":5,"maximum":1440},"expiration":{"description":"Expiration date-time of the log configuration request","example":"2020-12-15T19:13:36.079Z","type":"string","format":"date-time"},"rootLevel":{"description":"Root log level to apply, the default level for all logs. For more information about logging levels, refer to the \"Logging Levels\" table in [Enabling Connector Logging in IdentityNow](https://community.sailpoint.com/t5/IdentityNow-Articles/Enabling-Connector-Logging-in-IdentityNow/ta-p/188107).","default":"INFO","example":"TRACE","type":"string","enum":["OFF","FATAL","ERROR","WARN","INFO","DEBUG","TRACE"]},"logLevels":{"description":"Map of log level by key. The keys are logging classes, and the values are logging levels. To see the available connectors and their logging classes, refer to the \"Logging Classes\" table in [Enabling Connector Logging in IdentityNow](https://community.sailpoint.com/t5/IdentityNow-Articles/Enabling-Connector-Logging-in-IdentityNow/ta-p/188107).","example":{"sailpoint.connector.ADLDAPConnector":"TRACE"},"type":"object","additionalProperties":{"default":"INFO","example":"TRACE","description":"Standard Log4j log level","type":"string","enum":["OFF","FATAL","ERROR","WARN","INFO","DEBUG","TRACE"]}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:remote-client:read","idn:remote-client:manage"]}],"method":"get","path":"/managed-clusters/{id}/log-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get managed cluster's log configuration","description":{"content":"Get managed cluster's log configuration.","type":"text/plain"},"url":{"path":["managed-clusters",":id","log-config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of ManagedCluster to get log configuration for","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get managed cluster's log configuration' (get-client-log-configuration)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get managed cluster's log configuration + + + +Get managed cluster's log configuration. + +
Path Parameters
+ +Log configuration of ManagedCluster matching given cluster ID + +
Schema
    = 5` and `<= 1440`"} defaultValue={undefined}>
    logLevels object
    + +Map of log level by key. The keys are logging classes, and the values are logging levels. To see the available connectors and their logging classes, refer to the "Logging Classes" table in [Enabling Connector Logging in IdentityNow](https://community.sailpoint.com/t5/IdentityNow-Articles/Enabling-Connector-Logging-in-IdentityNow/ta-p/188107). + +
  • property name* string
    + +**Possible values:** [`OFF`, `FATAL`, `ERROR`, `WARN`, `INFO`, `DEBUG`, `TRACE`] + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-common-access.api.mdx b/products/idn/api/beta/get-common-access.api.mdx new file mode 100644 index 000000000..6b293fab2 --- /dev/null +++ b/products/idn/api/beta/get-common-access.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-common-access +sidebar_label: Get a paginated list of common access +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getCommonAccess","tags":["IAI Common Access"],"description":"This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read","parameters":[{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407)\n\nFiltering is supported for the following fields and operators:\n\n**status**: *eq* \"CONFIRMED\" or \"DENIED\" **reviewedByUser** *eq* true or false **access.id**: *eq* \"id\" **access.type**: *eq* \"ROLE\" or \"ACCESS_PROFILE\" **access.name**: *sw* \"Administrator\" **access.description**: *sw* \"admin\"","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407)\n\nSorting is supported for the following fields: **access.name,status**\n\nBy default the common access items are sorted by name, ascending."}],"responses":{"200":{"description":"Succeeded. Returns a list of common access for a customer.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"access":{"description":"common access item","type":"object","properties":{"id":{"type":"string","description":"Common access ID"},"type":{"description":"Common access type (ROLE or ACCESS_PROFILE)","type":"string","enum":["ACCESS_PROFILE","ROLE"]},"name":{"type":"string","description":"Common access name"},"description":{"type":"string","description":"Common access description"},"ownerName":{"type":"string","description":"Common access owner name"},"ownerId":{"type":"string","description":"Common access owner ID"}}},"status":{"type":"string","description":"CONFIRMED or DENIED"},"lastUpdated":{"type":"string","readOnly":true,"format":"date-time"},"reviewedByUser":{"type":"boolean","description":"true if user has confirmed or denied status"},"lastReviewed":{"type":"string","readOnly":true,"format":"date-time"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/common-access","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get a paginated list of common access","description":{"content":"This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read","type":"text/plain"},"url":{"path":["common-access"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407)\n\nFiltering is supported for the following fields and operators:\n\n**status**: *eq* \"CONFIRMED\" or \"DENIED\" **reviewedByUser** *eq* true or false **access.id**: *eq* \"id\" **access.type**: *eq* \"ROLE\" or \"ACCESS_PROFILE\" **access.name**: *sw* \"Administrator\" **access.description**: *sw* \"admin\"","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407)\n\nSorting is supported for the following fields: **access.name,status**\n\nBy default the common access items are sorted by name, ascending.","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a paginated list of common access' (get-common-access)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a paginated list of common access + + + +This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read + +
Query Parameters
+ +Succeeded. Returns a list of common access for a customer. + +
Schema array
    access object
    + +common access item + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-completed-work-items.api.mdx b/products/idn/api/beta/get-completed-work-items.api.mdx new file mode 100644 index 000000000..2cbe1acc7 --- /dev/null +++ b/products/idn/api/beta/get-completed-work-items.api.mdx @@ -0,0 +1,67 @@ +--- +id: get-completed-work-items +sidebar_label: Completed Work Items +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getCompletedWorkItems","tags":["Work Items"],"description":"This gets a collection of completed work items belonging to either the specified user(admin required), or the current user.","parameters":[{"in":"query","name":"ownerId","schema":{"type":"string"},"description":"The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request.","required":false},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"List of completed work items.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the work item","example":"2c9180835d2e5168015d32f890ca1581"},"requesterId":{"type":"string","description":"ID of the requester","example":"2c9180835d2e5168015d32f890ca1581"},"requesterDisplayName":{"type":"string","description":"The displayname of the requester","example":"John Smith"},"ownerId":{"type":"string","description":"The ID of the owner","example":"2c9180835d2e5168015d32f890ca1581"},"ownerName":{"type":"string","description":"The name of the owner","example":"Jason Smith"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z"},"description":{"type":"string","description":"The description of the work item","example":"Create account on source 'AD'"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"},"type":{"type":"string","enum":["UNKNOWN","GENERIC","CERTIFICATION","REMEDIATION","DELEGATION","APPROVAL","VIOLATIONREVIEW","FORM","POLICYVIOLATION","CHALLENGE","IMPACTANALYSIS","SIGNOFF","EVENT","MANUALACTION","TEST"],"example":"GENERIC","description":"The type of the work item"},"remediationItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the certification","example":"2c9180835d2e5168015d32f890ca1581"},"targetId":{"type":"string","description":"The ID of the certification target","example":"2c9180835d2e5168015d32f890ca1581"},"targetName":{"type":"string","description":"The name of the certification target","example":"john.smith"},"targetDisplayName":{"type":"string","description":"The display name of the certification target","example":"emailAddress"},"applicationName":{"type":"string","description":"The name of the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute being certified","example":"phoneNumber"},"attributeOperation":{"type":"string","description":"The operation of the certification on the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute being certified","example":"512-555-1212"},"nativeIdentity":{"type":"string","description":"The native identity of the target","example":"jason.smith2"}}},"approvalItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the approval item","example":"2c9180835d2e5168015d32f890ca1581"},"account":{"type":"string","description":"The account referenced by the approval item","example":"john.smith"},"application":{"type":"string","description":"The name the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute","example":"emailAddress"},"attributeOperation":{"type":"string","description":"The operation of the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute","example":"a@b.com"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"}}},"name":{"type":"string","description":"The work item name","example":"Account Create"},"completed":{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z"},"numItems":{"type":"integer","description":"The number of items in the work item","example":19},"errors":{"type":"array","items":{"type":"string"},"example":["The work item ID that was specified was not found."]}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}}},"method":"get","path":"/work-items/completed","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Completed Work Items","description":{"content":"This gets a collection of completed work items belonging to either the specified user(admin required), or the current user.","type":"text/plain"},"url":{"path":["work-items","completed"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request.","type":"text/plain"},"key":"ownerId","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Completed Work Items' (get-completed-work-items)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Completed Work Items + + + +This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. + +
Query Parameters
+ +List of completed work items. + +
Schema array
    remediationItems object
    approvalItems object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-connector-list.api.mdx b/products/idn/api/beta/get-connector-list.api.mdx new file mode 100644 index 000000000..3ed8cc4df --- /dev/null +++ b/products/idn/api/beta/get-connector-list.api.mdx @@ -0,0 +1,88 @@ +--- +id: get-connector-list +sidebar_label: Gets connector list +hide_title: true +hide_table_of_contents: true +api: {"tags":["Connectors"],"operationId":"getConnectorList","description":"Fetches list of connectors that have 'RELEASED' status using filtering and pagination.\nA token with ORG_ADMIN authority is required to call this API.","parameters":[{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n\n**name**: *sw*\n\n**type**: *eq*\n\n**directConnect**: *eq*\n\n**category**: *eq*\n\n**features**: *ca*","example":"directConnect eq \"true\""},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"locale","schema":{"type":"string","enum":["de","no","fi","sv","ru","pt","ko","zh-TW","en","it","fr","zh-CN","hu","es","cs","ja","pl","da","nl"],"example":"de"},"description":"The locale to apply to the config. If no viable locale is given, it will default to \"en\""}],"responses":{"200":{"description":"A Connector Dto object","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The connector name","example":"name"},"type":{"type":"string","description":"The connector type","example":"ServiceNow"},"scriptName":{"type":"string","description":"The connector script name","example":"servicenow"},"features":{"type":"array","description":"The list of features supported by the connector","nullable":true,"items":{"type":"string"},"example":["PROVISIONING","SYNC_PROVISIONING","SEARCH","UNSTRUCTURED_TARGETS"]},"directConnect":{"type":"boolean","description":"true if the source is a direct connect source","example":true,"default":false},"connectorMetadata":{"type":"object","description":"Object containing metadata pertinent to the UI to be used","example":{"supportedUI":"EXTJS","platform":"ccg","shortDesc":"connector description"}},"status":{"type":"string","description":"The connector status","example":"RELEASED"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:connector-source-config:read"]}],"method":"get","path":"/connectors","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Gets connector list","description":{"content":"Fetches list of connectors that have 'RELEASED' status using filtering and pagination.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["connectors"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n\n**name**: *sw*\n\n**type**: *eq*\n\n**directConnect**: *eq*\n\n**category**: *eq*\n\n**features**: *ca*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"The locale to apply to the config. If no viable locale is given, it will default to \"en\"","type":"text/plain"},"key":"locale","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Gets connector list' (get-connector-list)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Gets connector list + + + +Fetches list of connectors that have 'RELEASED' status using filtering and pagination. +A token with ORG_ADMIN authority is required to call this API. + +
Query Parameters
+ +A Connector Dto object + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-connector-rule-list.api.mdx b/products/idn/api/beta/get-connector-rule-list.api.mdx new file mode 100644 index 000000000..d2fb38ba7 --- /dev/null +++ b/products/idn/api/beta/get-connector-rule-list.api.mdx @@ -0,0 +1,84 @@ +--- +id: get-connector-rule-list +sidebar_label: List Connector Rules +hide_title: true +hide_table_of_contents: true +api: {"tags":["Connector Rule Management"],"operationId":"getConnectorRuleList","description":"Returns the list of connector rules.\nA token with ORG_ADMIN authority is required to call this API.","responses":{"200":{"description":"A list of connector rules","content":{"application/json":{"schema":{"type":"array","items":{"description":"ConnectorRuleResponse","allOf":[{"description":"ConnectorRuleCreateRequest","type":"object","required":["name","type","sourceCode"],"properties":{"name":{"type":"string","description":"the name of the rule","example":"WebServiceBeforeOperationRule","minLength":1,"maxLength":128},"description":{"type":"string","description":"a description of the rule's purpose","example":"This rule does that"},"type":{"type":"string","enum":["BuildMap","ConnectorAfterCreate","ConnectorAfterDelete","ConnectorAfterModify","ConnectorBeforeCreate","ConnectorBeforeDelete","ConnectorBeforeModify","JDBCBuildMap","JDBCOperationProvisioning","JDBCProvision","PeopleSoftHRMSBuildMap","PeopleSoftHRMSOperationProvisioning","PeopleSoftHRMSProvision","RACFPermissionCustomization","SAPBuildMap","SapHrManagerRule","SapHrOperationProvisioning","SapHrProvision","SuccessFactorsOperationProvisioning","WebServiceAfterOperationRule","WebServiceBeforeOperationRule"],"description":"the type of rule","example":"BuildMap"},"signature":{"description":"The rule's function signature. Describes the rule's input arguments and output (if any)","type":"object","required":["input"],"properties":{"input":{"type":"array","items":{"type":"object","nullable":true,"properties":{"name":{"type":"string","description":"the name of the argument","example":"firstName"},"description":{"type":"string","description":"the description of the argument","example":"the first name of the identity"},"type":{"type":"string","nullable":true,"description":"the programmatic type of the argument","example":"String"}},"required":["name"]}},"output":{"type":"object","nullable":true,"properties":{"name":{"type":"string","description":"the name of the argument","example":"firstName"},"description":{"type":"string","description":"the description of the argument","example":"the first name of the identity"},"type":{"type":"string","nullable":true,"description":"the programmatic type of the argument","example":"String"}},"required":["name"]}}},"sourceCode":{"description":"SourceCode","type":"object","required":["version","script"],"properties":{"version":{"type":"string","description":"the version of the code","example":"1.0"},"script":{"type":"string","description":"The code","example":"return \"Mr. \" + firstName;"}}},"attributes":{"type":"object","nullable":true,"description":"a map of string to objects","example":{}}}},{"type":"object","nullable":true,"required":["id","created"],"properties":{"id":{"type":"string","description":"the ID of the rule","example":"8113d48c0b914f17b4c6072d4dcb9dfe"},"created":{"type":"string","description":"an ISO 8601 UTC timestamp when this rule was created","example":"021-07-22T15:59:23Z"},"modified":{"type":"string","nullable":true,"description":"an ISO 8601 UTC timestamp when this rule was last modified","example":"021-07-22T15:59:23Z"}}}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:rule-management-connector:read","idn:rule-management-connector:manage"]}],"method":"get","path":"/connector-rules","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Connector Rules","description":{"content":"Returns the list of connector rules.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["connector-rules"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Connector Rules' (get-connector-rule-list)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Connector Rules + + + +Returns the list of connector rules. +A token with ORG_ADMIN authority is required to call this API. + +
+ +A list of connector rules + +
Schema array
    signature object
    + +The rule's function signature. Describes the rule's input arguments and output (if any) + +
    input object[]
    output object
    sourceCode object
    + +SourceCode + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-connector-rule.api.mdx b/products/idn/api/beta/get-connector-rule.api.mdx new file mode 100644 index 000000000..25a4bc28a --- /dev/null +++ b/products/idn/api/beta/get-connector-rule.api.mdx @@ -0,0 +1,96 @@ +--- +id: get-connector-rule +sidebar_label: Connector-Rule by ID +hide_title: true +hide_table_of_contents: true +api: {"tags":["Connector Rule Management"],"operationId":"getConnectorRule","description":"Returns the connector rule specified by ID.\nA token with ORG_ADMIN authority is required to call this API.","parameters":[{"name":"id","in":"path","description":"ID of the connector rule to retrieve","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"8c190e6787aa4ed9a90bd9d5344523fb"}],"responses":{"200":{"description":"Connector rule with the given ID","content":{"application/json":{"schema":{"description":"ConnectorRuleResponse","allOf":[{"description":"ConnectorRuleCreateRequest","type":"object","required":["name","type","sourceCode"],"properties":{"name":{"type":"string","description":"the name of the rule","example":"WebServiceBeforeOperationRule","minLength":1,"maxLength":128},"description":{"type":"string","description":"a description of the rule's purpose","example":"This rule does that"},"type":{"type":"string","enum":["BuildMap","ConnectorAfterCreate","ConnectorAfterDelete","ConnectorAfterModify","ConnectorBeforeCreate","ConnectorBeforeDelete","ConnectorBeforeModify","JDBCBuildMap","JDBCOperationProvisioning","JDBCProvision","PeopleSoftHRMSBuildMap","PeopleSoftHRMSOperationProvisioning","PeopleSoftHRMSProvision","RACFPermissionCustomization","SAPBuildMap","SapHrManagerRule","SapHrOperationProvisioning","SapHrProvision","SuccessFactorsOperationProvisioning","WebServiceAfterOperationRule","WebServiceBeforeOperationRule"],"description":"the type of rule","example":"BuildMap"},"signature":{"description":"The rule's function signature. Describes the rule's input arguments and output (if any)","type":"object","required":["input"],"properties":{"input":{"type":"array","items":{"type":"object","nullable":true,"properties":{"name":{"type":"string","description":"the name of the argument","example":"firstName"},"description":{"type":"string","description":"the description of the argument","example":"the first name of the identity"},"type":{"type":"string","nullable":true,"description":"the programmatic type of the argument","example":"String"}},"required":["name"]}},"output":{"type":"object","nullable":true,"properties":{"name":{"type":"string","description":"the name of the argument","example":"firstName"},"description":{"type":"string","description":"the description of the argument","example":"the first name of the identity"},"type":{"type":"string","nullable":true,"description":"the programmatic type of the argument","example":"String"}},"required":["name"]}}},"sourceCode":{"description":"SourceCode","type":"object","required":["version","script"],"properties":{"version":{"type":"string","description":"the version of the code","example":"1.0"},"script":{"type":"string","description":"The code","example":"return \"Mr. \" + firstName;"}}},"attributes":{"type":"object","nullable":true,"description":"a map of string to objects","example":{}}}},{"type":"object","nullable":true,"required":["id","created"],"properties":{"id":{"type":"string","description":"the ID of the rule","example":"8113d48c0b914f17b4c6072d4dcb9dfe"},"created":{"type":"string","description":"an ISO 8601 UTC timestamp when this rule was created","example":"021-07-22T15:59:23Z"},"modified":{"type":"string","nullable":true,"description":"an ISO 8601 UTC timestamp when this rule was last modified","example":"021-07-22T15:59:23Z"}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:rule-management-connector:read","idn:rule-management-connector:manage"]}],"method":"get","path":"/connector-rules/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Connector-Rule by ID","description":{"content":"Returns the connector rule specified by ID.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["connector-rules",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the connector rule to retrieve","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Connector-Rule by ID' (get-connector-rule)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Connector-Rule by ID + + + +Returns the connector rule specified by ID. +A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
+ +Connector rule with the given ID + +
Schema
    signature object
    + +The rule's function signature. Describes the rule's input arguments and output (if any) + +
    input object[]
    output object
    sourceCode object
    + +SourceCode + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-count-completed-work-items.api.mdx b/products/idn/api/beta/get-count-completed-work-items.api.mdx new file mode 100644 index 000000000..21a5eb178 --- /dev/null +++ b/products/idn/api/beta/get-count-completed-work-items.api.mdx @@ -0,0 +1,67 @@ +--- +id: get-count-completed-work-items +sidebar_label: Count Completed Work Items +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getCountCompletedWorkItems","tags":["Work Items"],"description":"This gets a count of completed work items belonging to either the specified user(admin required), or the current user.","parameters":[{"in":"query","name":"ownerId","schema":{"type":"string"},"description":"ID of the work item owner.","required":false}],"responses":{"200":{"description":"List of work items","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"count":{"type":"integer","description":"The count of work items","example":29}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}}},"method":"get","path":"/work-items/count/completed","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Count Completed Work Items","description":{"content":"This gets a count of completed work items belonging to either the specified user(admin required), or the current user.","type":"text/plain"},"url":{"path":["work-items","count","completed"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"ID of the work item owner.","type":"text/plain"},"key":"ownerId","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Count Completed Work Items' (get-count-completed-work-items)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Count Completed Work Items + + + +This gets a count of completed work items belonging to either the specified user(admin required), or the current user. + +
Query Parameters
+ +List of work items + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-count-work-items.api.mdx b/products/idn/api/beta/get-count-work-items.api.mdx new file mode 100644 index 000000000..47ddf7c98 --- /dev/null +++ b/products/idn/api/beta/get-count-work-items.api.mdx @@ -0,0 +1,67 @@ +--- +id: get-count-work-items +sidebar_label: Count Work Items +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getCountWorkItems","tags":["Work Items"],"description":"This gets a count of work items belonging to either the specified user(admin required), or the current user.","parameters":[{"in":"query","name":"ownerId","schema":{"type":"string"},"description":"ID of the work item owner.","required":false}],"responses":{"200":{"description":"List of work items","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"count":{"type":"integer","description":"The count of work items","example":29}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}}},"method":"get","path":"/work-items/count","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Count Work Items","description":{"content":"This gets a count of work items belonging to either the specified user(admin required), or the current user.","type":"text/plain"},"url":{"path":["work-items","count"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"ID of the work item owner.","type":"text/plain"},"key":"ownerId","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Count Work Items' (get-count-work-items)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Count Work Items + + + +This gets a count of work items belonging to either the specified user(admin required), or the current user. + +
Query Parameters
+ +List of work items + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-custom-password-instructions.api.mdx b/products/idn/api/beta/get-custom-password-instructions.api.mdx new file mode 100644 index 000000000..e780fc278 --- /dev/null +++ b/products/idn/api/beta/get-custom-password-instructions.api.mdx @@ -0,0 +1,79 @@ +--- +id: get-custom-password-instructions +sidebar_label: Get Custom Password Instructions by Page ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getCustomPasswordInstructions","tags":["Custom Password Instructions"],"description":"This API returns the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.","parameters":[{"in":"path","name":"pageId","schema":{"type":"string","enum":["change-password:enter-password","change-password:finish","flow-selection:select","forget-username:user-email","mfa:enter-code","mfa:enter-kba","mfa:select","reset-password:enter-password","reset-password:enter-username","reset-password:finish","unlock-account:enter-username","unlock-account:finish"]},"required":true,"description":"The page ID of custom password instructions to query.","example":"mfa:select"},{"in":"query","name":"locale","schema":{"type":"string"},"description":"The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\"."}],"responses":{"200":{"description":"Reference to the custom password instructions.","content":{"application/json":{"schema":{"type":"object","properties":{"pageId":{"type":"string","description":"The page ID that represents the page for forget user name, reset password and unlock account flow.","enum":["change-password:enter-password","change-password:finish","flow-selection:select","forget-username:user-email","mfa:enter-code","mfa:enter-kba","mfa:select","reset-password:enter-password","reset-password:enter-username","reset-password:finish","unlock-account:enter-username","unlock-account:finish"]},"pageContent":{"type":"string","description":"The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like ... clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to \"_blank\" like this: link. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target."},"locale":{"type":"string","example":"en","description":"The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\"."}}},"example":{"pageId":"reset-password:enter-password","locale":"default","pageContent":"See company password policies for details by clicking here"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/custom-password-instructions/{pageId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Custom Password Instructions by Page ID","description":{"content":"This API returns the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["custom-password-instructions",":pageId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\".","type":"text/plain"},"key":"locale","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The page ID of custom password instructions to query.","type":"text/plain"},"type":"any","value":"","key":"pageId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Custom Password Instructions by Page ID' (get-custom-password-instructions)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Custom Password Instructions by Page ID + + + +This API returns the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
Query Parameters
+ +Reference to the custom password instructions. + +
Schema
    ... clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to \"_blank\" like this: link. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}>
here\"\n}"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-default-identity-attribute-config.api.mdx b/products/idn/api/beta/get-default-identity-attribute-config.api.mdx new file mode 100644 index 000000000..98ff99caf --- /dev/null +++ b/products/idn/api/beta/get-default-identity-attribute-config.api.mdx @@ -0,0 +1,96 @@ +--- +id: get-default-identity-attribute-config +sidebar_label: Default identity attribute config +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getDefaultIdentityAttributeConfig","tags":["Identity Profiles"],"description":"This returns the default identity attribute config\nA token with ORG_ADMIN authority is required to call this API to get the default identity attribute config.","parameters":[{"in":"path","name":"identity-profile-id","schema":{"type":"string","format":"uuid"},"required":true,"description":"The Identity Profile ID","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"An Identity Attribute Config object","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If the profile or mapping is enabled","example":true,"default":true},"attributeTransforms":{"type":"array","items":{"type":"object","properties":{"identityAttributeName":{"type":"string","description":"Name of the identity attribute","example":"email"},"transformDefinition":{"description":"The seaspray transformation definition","type":"object","properties":{"type":{"type":"string","description":"The type of the transform definition.","example":"accountAttribute"},"attributes":{"type":"object","nullable":true,"additionalProperties":true,"description":"Arbitrary key-value pairs to store any metadata for the object","example":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}}}}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:identity-profile:manage"]}],"method":"get","path":"/identity-profiles/{identity-profile-id}/default-identity-attribute-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Default identity attribute config","description":{"content":"This returns the default identity attribute config\nA token with ORG_ADMIN authority is required to call this API to get the default identity attribute config.","type":"text/plain"},"url":{"path":["identity-profiles",":identity-profile-id","default-identity-attribute-config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Identity Profile ID","type":"text/plain"},"type":"any","value":"","key":"identity-profile-id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Default identity attribute config' (get-default-identity-attribute-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Default identity attribute config + + + +This returns the default identity attribute config +A token with ORG_ADMIN authority is required to call this API to get the default identity attribute config. + +
Path Parameters
+ +An Identity Attribute Config object + +
Schema
    attributeTransforms object[]
    transformDefinition object
    + +The seaspray transformation definition + +
    attributes object
    + +Arbitrary key-value pairs to store any metadata for the object + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-dkim-attributes.api.mdx b/products/idn/api/beta/get-dkim-attributes.api.mdx new file mode 100644 index 000000000..bd03d1728 --- /dev/null +++ b/products/idn/api/beta/get-dkim-attributes.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-dkim-attributes +sidebar_label: Get DKIM Attributes +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["sp:notification-dkim-attributes:read"]}],"operationId":"getDkimAttributes","tags":["Notifications"],"description":"Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call.","responses":{"200":{"description":"List of DKIM Attributes","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"123b45b0-aaaa-bbbb-a7db-123456a56abc","description":"UUID associated with domain to be verified"},"address":{"type":"string","example":"BobSmith@sailpoint.com","description":"The identity or domain address"},"dkimEnabled":{"type":"boolean","default":false,"example":true,"description":"Whether or not DKIM has been enabled for this domain / identity"},"dkimTokens":{"type":"array","items":{"type":"string"},"example":["uq1m3jjk25ckd3whl4n7y46c56r5l6aq","u7pm38jky9ckdawhlsn7y4dcj6f5lpgq","uhpm3jjkjjckdkwhlqn7yw6cjer5tpay"],"description":"The tokens to be added to a DNS for verification"},"dkimVerificationStatus":{"type":"string","example":"Success","description":"The current status if the domain /identity has been verified. Ie Success, Failed, Pending"}},"description":"DKIM attributes for a domain or identity"}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/verified-domains","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get DKIM Attributes","description":{"content":"Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call.","type":"text/plain"},"url":{"path":["verified-domains"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get DKIM Attributes' (get-dkim-attributes)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get DKIM Attributes + + + +Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call. + +
+ +List of DKIM Attributes + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-entitlement-changes-identities.api.mdx b/products/idn/api/beta/get-entitlement-changes-identities.api.mdx new file mode 100644 index 000000000..a2c19a942 --- /dev/null +++ b/products/idn/api/beta/get-entitlement-changes-identities.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-entitlement-changes-identities +sidebar_label: Get identities for a suggested entitlement (for a role) +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getEntitlementChangesIdentities","tags":["Role Insights"],"description":"Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role.","parameters":[{"in":"path","name":"insightId","schema":{"type":"string"},"required":true,"description":"The role insight id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"path","name":"entitlementId","schema":{"type":"string"},"required":true,"description":"The entitlement id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"query","name":"hasEntitlement","description":"Identity has this entitlement or not","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"sorters","description":"sort by name","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"in":"query","name":"filters","description":"Filter parameter by \"starts with\" for the name.","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Succeeded. Returns a list of identities with or without the entitlement.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id for identity"},"name":{"type":"string","description":"Name for identity"},"attributes":{"type":"object","additionalProperties":{"type":"string"}}},"example":{"id":"8c190e67-87aa-4ed9-a90b-d9d5344523fb","name":"Adam Smith","attributes":{"department":"Human Resources-tah-mgb-dnd","firstName":"Adam","jobTitle":"Sales Analyst","location":"Mexico"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/role-insights/{insightId}/entitlement-changes/{entitlementId}/identities","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get identities for a suggested entitlement (for a role)","description":{"content":"Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role.","type":"text/plain"},"url":{"path":["role-insights",":insightId","entitlement-changes",":entitlementId","identities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Identity has this entitlement or not","type":"text/plain"},"key":"hasEntitlement","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"sort by name","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"Filter parameter by \"starts with\" for the name.","type":"text/plain"},"key":"filters","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The role insight id","type":"text/plain"},"type":"any","value":"","key":"insightId"},{"disabled":false,"description":{"content":"(Required) The entitlement id","type":"text/plain"},"type":"any","value":"","key":"entitlementId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get identities for a suggested entitlement (for a role)' (get-entitlement-changes-identities)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get identities for a suggested entitlement (for a role) + + + +Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. + +
Path Parameters
Query Parameters
+ +Succeeded. Returns a list of identities with or without the entitlement. + +
Schema array
    attributes object
  • property name* string
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-entitlement-distribution-potential-role.api.mdx b/products/idn/api/beta/get-entitlement-distribution-potential-role.api.mdx new file mode 100644 index 000000000..b989851cc --- /dev/null +++ b/products/idn/api/beta/get-entitlement-distribution-potential-role.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-entitlement-distribution-potential-role +sidebar_label: Retrieves entitlement popularity distribution for a potential role in a role mining session +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getEntitlementDistributionPotentialRole","tags":["IAI Role Mining"],"description":"This method returns entitlement popularity distribution for a potential role in a role mining session.","parameters":[{"in":"path","name":"sessionId","schema":{"type":"string"},"required":true,"description":"The role mining session id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"path","name":"potentialRoleId","schema":{"type":"string"},"required":true,"description":"A potential role id in a role mining session","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"query","name":"includeCommonAccess","description":"Boolean determining whether common access entitlements will be included or not","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Succeeded. Returns a map containing entitlement popularity distribution for a potential role.","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"integer"}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Retrieves entitlement popularity distribution for a potential role in a role mining session","description":{"content":"This method returns entitlement popularity distribution for a potential role in a role mining session.","type":"text/plain"},"url":{"path":["role-mining-sessions",":sessionId","potential-roles",":potentialRoleId","entitlement-popularity-distribution"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Boolean determining whether common access entitlements will be included or not","type":"text/plain"},"key":"includeCommonAccess","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The role mining session id","type":"text/plain"},"type":"any","value":"","key":"sessionId"},{"disabled":false,"description":{"content":"(Required) A potential role id in a role mining session","type":"text/plain"},"type":"any","value":"","key":"potentialRoleId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Retrieves entitlement popularity distribution for a potential role in a role mining session' (get-entitlement-distribution-potential-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieves entitlement popularity distribution for a potential role in a role mining session + + + +This method returns entitlement popularity distribution for a potential role in a role mining session. + +
Path Parameters
Query Parameters
+ +Succeeded. Returns a map containing entitlement popularity distribution for a potential role. + +
Schema
  • property name* integer
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-entitlement-request-config.api.mdx b/products/idn/api/beta/get-entitlement-request-config.api.mdx new file mode 100644 index 000000000..68fbc573a --- /dev/null +++ b/products/idn/api/beta/get-entitlement-request-config.api.mdx @@ -0,0 +1,91 @@ +--- +id: get-entitlement-request-config +sidebar_label: Get Entitlement Request Config +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getEntitlementRequestConfig","tags":["Entitlements"],"description":"This API returns the entitlement request config for a specified entitlement.","security":[{"oauth2":["idn:entitlement:read","idn:entitlement:manage"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Entitlement Id","example":"2c91808874ff91550175097daaec161c"}],"responses":{"200":{"description":"An Entitlement Request Config","content":{"application/json":{"schema":{"type":"object","properties":{"accessRequestConfig":{"type":"object","properties":{"approvalSchemes":{"type":"array","description":"Ordered list of approval steps for the access request. Empty when no approval is required.","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["ENTITLEMENT_OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n\n**ENTITLEMENT_OWNER**: Owner of the associated Entitlement\n\n**SOURCE_OWNER**: Owner of the associated Source\n\n**MANAGER**: Manager of the Identity for whom the request is being made\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"e3eab852-8315-467f-9de7-70eda97f63c8"}}}},"requestCommentRequired":{"type":"boolean","description":"If the requester must provide a comment during access request.","default":false,"example":true},"denialCommentRequired":{"type":"boolean","description":"If the reviewer must provide a comment when denying the access request.","default":false,"example":false}}}}},"example":{"accessRequestConfig":{"requestCommentRequired":true,"denialCommentRequired":true,"approvalSchemes":[{"approverType":"ENTITLEMENT_OWNER","approverId":null},{"approverType":"SOURCE_OWNER","approverId":null},{"approverType":"MANAGER","approverId":null},{"approverType":"GOVERNANCE_GROUP","approverId":"46c79819-a69f-49a2-becb-12c971ae66c6"}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/entitlements/{id}/entitlement-request-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Entitlement Request Config","description":{"content":"This API returns the entitlement request config for a specified entitlement.","type":"text/plain"},"url":{"path":["entitlements",":id","entitlement-request-config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Entitlement Id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Entitlement Request Config' (get-entitlement-request-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Entitlement Request Config + + + +This API returns the entitlement request config for a specified entitlement. + +
Path Parameters
+ +An Entitlement Request Config + +
Schema
    accessRequestConfig object
    approvalSchemes object[]
    + +Ordered list of approval steps for the access request. Empty when no approval is required. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-entitlement.api.mdx b/products/idn/api/beta/get-entitlement.api.mdx new file mode 100644 index 000000000..7ba6f4070 --- /dev/null +++ b/products/idn/api/beta/get-entitlement.api.mdx @@ -0,0 +1,99 @@ +--- +id: get-entitlement +sidebar_label: Get an entitlement +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getEntitlement","tags":["Entitlements"],"description":"This API returns an entitlement by its ID.","security":[{"oauth2":["idn:entitlement:read","idn:entitlement:manage"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The entitlement ID","example":"2c91808874ff91550175097daaec161c"}],"responses":{"200":{"description":"An entitlement","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The entitlement id","example":"2c91808874ff91550175097daaec161c"},"name":{"type":"string","description":"The entitlement name","example":"LauncherTest2"},"created":{"type":"string","description":"Time when the entitlement was created","format":"date-time","example":"2020-10-08T18:33:52.029Z"},"modified":{"type":"string","description":"Time when the entitlement was last modified","format":"date-time","example":"2020-10-08T18:33:52.029Z"},"attribute":{"type":"string","description":"The entitlement attribute name","example":"memberOf"},"value":{"type":"string","description":"The value of the entitlement","example":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local"},"sourceSchemaObjectType":{"type":"string","description":"The object type of the entitlement from the source schema","example":"group"},"privileged":{"type":"boolean","default":false,"description":"True if the entitlement is privileged","example":true},"cloudGoverned":{"type":"boolean","default":false,"description":"True if the entitlement is cloud governed","example":true},"description":{"type":"string","description":"The description of the entitlement","example":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local"},"requestable":{"type":"boolean","default":false,"description":"True if the entitlement is requestable","example":true},"attributes":{"type":"object","description":"A map of free-form key-value pairs from the source system","example":{"fieldName":"fieldValue"},"additionalProperties":true},"source":{"type":"object","properties":{"id":{"type":"string","description":"The source ID","example":"2c9180827ca885d7017ca8ce28a000eb"},"type":{"type":"string","description":"The source type, will always be \"SOURCE\"","example":"SOURCE"},"name":{"type":"string","description":"The source name","example":"ODS-AD-Source"}}},"owner":{"type":"object","description":"Simplified DTO for the owner object of the entitlement","properties":{"id":{"type":"string","description":"The owner id for the entitlement","example":"2a2fdacca5e345f18bf7970cfbb8fec2"},"name":{"type":"string","description":"The owner name for the entitlement","example":"identity 1"},"type":{"type":"string","enum":["IDENTITY"],"description":"The type of the owner. Initially only type IDENTITY is supported","example":"IDENTITY"}}},"directPermissions":{"type":"array","items":{"type":"object","description":"Simplified DTO for the Permission objects stored in SailPoint's database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers.","properties":{"rights":{"type":"array","description":"All the rights (e.g. actions) that this permission allows on the target","readOnly":true,"items":{"type":"string","example":"SELECT"}},"target":{"type":"string","description":"The target the permission would grants rights on.","readOnly":true,"example":"SYS.GV_$TRANSACTION"}}}},"segments":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of IDs of segments, if any, to which this Entitlement is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]},"manuallyUpdatedFields":{"description":"Object contains entitlement manually updated fields. Field value is true if is was updated manually via entitlement import csv or patch endpoint. Field value is false if that property value has not been changed after first entitlement aggregation. Values for all manually updatable fields must be specified. For now only two entitlement fields support this: DISPLAY_NAME and DESCRIPTION.","example":{"DISPLAY_NAME":true,"DESCRIPTION":true},"type":"object","properties":{"DISPLAY_NAME":{"type":"boolean","default":false,"description":"True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation.\nField refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property.","example":true},"DESCRIPTION":{"type":"boolean","default":false,"description":"True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation.\nField refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property.","example":true}}}}},"example":{"sourceSchemaObjectType":"group","attribute":"memberOf","attributes":{"GroupType":"Security","sAMAccountName":"LauncherTest1","GroupScope":"Global","objectguid":"{01a6e70b-9705-4155-a5c6-492a9bcc8c64}","objectSid":"S-1-5-21-3585869415-1648031554-2909195034-1633","cn":"LauncherTest1","msDS-PrincipalName":"AUTOMATIONAD\\LauncherTest1"},"value":"CN=LauncherTest1,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local","description":"some description","privileged":false,"cloudGoverned":false,"source":{"type":"SOURCE","id":"2c9180877504c40e0175097d5ce707c8","name":"EndToEnd-ADSource"},"owner":{"id":"2c9180858315595501831958427e5424","name":"Addie Smith","type":"IDENTITY"},"segments":["1d126fe0-45e2-4aea-bc64-a07e9344ef26"],"manuallyUpdatedFields":{"DISPLAY_NAME":true,"DESCRIPTION":true},"id":"2c91808c74ff913f0175097daa9d59cd","name":"LauncherTest1","created":"2020-10-08T18:33:52.029Z","modified":"2021-01-19T16:53:35.707Z"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/entitlements/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get an entitlement","description":{"content":"This API returns an entitlement by its ID.","type":"text/plain"},"url":{"path":["entitlements",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The entitlement ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get an entitlement' (get-entitlement)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get an entitlement + + + +This API returns an entitlement by its ID. + +
Path Parameters
+ +An entitlement + +
Schema
    attributes object
    + +A map of free-form key-value pairs from the source system + +
    source object
    owner object
    + +Simplified DTO for the owner object of the entitlement + +
    directPermissions object[]
    manuallyUpdatedFields object
    + +Object contains entitlement manually updated fields. Field value is true if is was updated manually via entitlement import csv or patch endpoint. Field value is false if that property value has not been changed after first entitlement aggregation. Values for all manually updatable fields must be specified. For now only two entitlement fields support this: DISPLAY_NAME and DESCRIPTION. + +
    `name` property."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}> `description` property."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-entitlements-potential-role.api.mdx b/products/idn/api/beta/get-entitlements-potential-role.api.mdx new file mode 100644 index 000000000..e1fcd8ce0 --- /dev/null +++ b/products/idn/api/beta/get-entitlements-potential-role.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-entitlements-potential-role +sidebar_label: Retrieves entitlements for a potential role in a role mining session +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getEntitlementsPotentialRole","tags":["IAI Role Mining"],"description":"This method returns entitlements for a potential role in a role mining session.","parameters":[{"in":"path","name":"sessionId","schema":{"type":"string"},"required":true,"description":"The role mining session id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"path","name":"potentialRoleId","schema":{"type":"string"},"required":true,"description":"A potential role id in a role mining session","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"query","name":"includeCommonAccess","description":"Boolean determining whether common access entitlements will be included or not","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}},{"in":"query","name":"sorters","description":"sort by popularity, default order descending","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"in":"query","name":"filters","description":"Filter parameter by \"starts with\" for the applicationName and entitlementRef.name.","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Succeeded. Returns a list of entitlements for a potential role.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"entitlementRef":{"description":"Details about the entitlement","type":"object","properties":{"id":{"type":"string","description":"Id of the entitlement"},"name":{"type":"string","description":"Name of the entitlement"},"description":{"type":"string","description":"Description forthe entitlement"}}},"name":{"type":"string","description":"Name of the entitlement"},"applicationName":{"type":"string","description":"Application name of the entitlement"},"identityCount":{"type":"integer","description":"The number of identities with this entitlement in a role.","example":45},"popularity":{"type":"integer","description":"The % popularity of this entitlement in a role.","example":65},"popularityInOrg":{"type":"integer","description":"TThe % popularity of this entitlement in the org.","example":35}},"example":{"entitlementRef":{"id":"2c9180877212632a017228d5a796292b","name":"entitlement.10","description":"Read access"},"name":"Administrator","applicationName":"Slack","identityCount":"8","popularity":"65","popularityInOrg":"35"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Retrieves entitlements for a potential role in a role mining session","description":{"content":"This method returns entitlements for a potential role in a role mining session.","type":"text/plain"},"url":{"path":["role-mining-sessions",":sessionId","potential-roles",":potentialRoleId","entitlement-popularities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Boolean determining whether common access entitlements will be included or not","type":"text/plain"},"key":"includeCommonAccess","value":""},{"disabled":false,"description":{"content":"sort by popularity, default order descending","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"Filter parameter by \"starts with\" for the applicationName and entitlementRef.name.","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The role mining session id","type":"text/plain"},"type":"any","value":"","key":"sessionId"},{"disabled":false,"description":{"content":"(Required) A potential role id in a role mining session","type":"text/plain"},"type":"any","value":"","key":"potentialRoleId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Retrieves entitlements for a potential role in a role mining session' (get-entitlements-potential-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieves entitlements for a potential role in a role mining session + + + +This method returns entitlements for a potential role in a role mining session. + +
Path Parameters
Query Parameters
+ +Succeeded. Returns a list of entitlements for a potential role. + +
Schema array
    entitlementRef object
    + +Details about the entitlement + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-evaluate-reassignment-configuration.api.mdx b/products/idn/api/beta/get-evaluate-reassignment-configuration.api.mdx new file mode 100644 index 000000000..aa4043b73 --- /dev/null +++ b/products/idn/api/beta/get-evaluate-reassignment-configuration.api.mdx @@ -0,0 +1,79 @@ +--- +id: get-evaluate-reassignment-configuration +sidebar_label: Evaluate Reassignment Configuration +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getEvaluateReassignmentConfiguration","tags":["Work Reassignment"],"description":"Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty.","security":[{"oauth2":["idn:reassignment-configuration:evaluate"]}],"parameters":[{"in":"path","name":"identityId","required":true,"schema":{"type":"string"},"description":"unique identity id","example":"2c91808781a71ddb0181b9090b5c504e"},{"in":"path","name":"configType","required":true,"schema":{"type":"string","description":"Enum list of valid work types that can be selected for a Reassignment Configuration","enum":["ACCESS_REQUESTS","CERTIFICATIONS","MANUAL_TASKS"],"example":"ACCESS_REQUESTS"},"description":"Reassignment work type","example":"accessRequests"},{"in":"query","name":"exclusionFilters","required":false,"schema":{"type":"array","items":{"type":"string"}},"description":"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","example":"SELF_REVIEW_DELEGATION"}],"responses":{"200":{"description":"Evaluated Reassignment Configuration","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"The response body for Evaluate Reassignment Configuration","properties":{"reassignToId":{"type":"string","description":"The Identity ID which should be the recipient of any work items sent to a specific identity & work type","example":"869320b6b6f34a169b6178b1a865e66f"},"lookupTrail":{"type":"array","description":"List of Reassignments found by looking up the next `TargetIdentity` in a ReassignmentConfiguration","items":{"type":"object","description":"The definition of an Identity according to the Reassignment Configuration service","properties":{"reassignedToId":{"type":"string","description":"The ID of the Identity who work is reassigned to","example":"869320b6b6f34a169b6178b1a865e66f"},"reassignedFromId":{"type":"string","description":"The ID of the Identity who work is reassigned from","example":"51948a8f306a4e7a9a6f8f5d032fa59e"},"reassignmentType":{"description":"Reassignment type","type":"string","enum":["MANUAL_REASSIGNMENT,","AUTOMATIC_REASSIGNMENT,","AUTO_ESCALATION,","SELF_REVIEW_DELEGATION"],"example":"AUTOMATIC_REASSIGNMENT"}}}}}}},"examples":{"empty":{"summary":"Evaluate response when no Reassignment Configuration is found","value":{"reassignToId":"2c9180825a6c1adc015a71c9023f0818","lookupTrail":[]}},"longTrail":{"summary":"Evaluate response when a long Reassignment trail is found","value":{"reassignToId":"2c9180825a6c1adc015a71c9023f0818","lookupTrail":[{"reassignedToId":"2c918084575812550157589064f33b89","reassignedFromId":"2c9180825a6c1adc015a71c9023f0818","reassignmentType":"AUTOMATIC_REASSIGNMENT"},{"reassignedToId":"073204941f3f49c0b3a3c49d1c17ef0e","reassignedFromId":"2c918084575812550157589064f33b89","reassignmentType":"AUTOMATIC_REASSIGNMENT"},{"reassignedToId":"31d9c631f5574571a935aaa48a6255df","reassignedFromId":"073204941f3f49c0b3a3c49d1c17ef0e","reassignmentType":"AUTOMATIC_REASSIGNMENT"},{"reassignedToId":"279de502e5dc43f4854e1b96f57c578f","reassignedFromId":"31d9c631f5574571a935aaa48a6255df","reassignmentType":"AUTOMATIC_REASSIGNMENT"}]}},"selfReview":{"summary":"Evaluate response when a self-review is found and manager or org admin escalation is applied","value":{"reassignToId":"2c9180825a6c1adc015a71c9023f0818","lookupTrail":[{"reassignedToId":"2c918084575812550157589064f33b89","reassignedFromId":"2c9180825a6c1adc015a71c9023f0818","reassignmentType":"AUTOMATIC_REASSIGNMENT"},{"reassignedToId":"073204941f3f49c0b3a3c49d1c17ef0e","reassignedFromId":"2c918084575812550157589064f33b89","reassignmentType":"AUTOMATIC_REASSIGNMENT"},{"reassignedToId":"31d9c631f5574571a935aaa48a6255df","reassignedFromId":"073204941f3f49c0b3a3c49d1c17ef0e","reassignmentType":"SELF_REVIEW_DELEGATION"},{"reassignedToId":"279de502e5dc43f4854e1b96f57c578f","reassignedFromId":"31d9c631f5574571a935aaa48a6255df","reassignmentType":"AUTOMATIC_REASSIGNMENT"}]}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/reassignment-configurations/{identityId}/evaluate/{configType}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Evaluate Reassignment Configuration","description":{"content":"Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty.","type":"text/plain"},"url":{"path":["reassignment-configurations",":identityId","evaluate",":configType"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"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","type":"text/plain"},"key":"exclusionFilters","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) unique identity id","type":"text/plain"},"type":"any","value":"","key":"identityId"},{"disabled":false,"description":{"content":"(Required) Reassignment work type","type":"text/plain"},"type":"any","value":"","key":"configType"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Evaluate Reassignment Configuration' (get-evaluate-reassignment-configuration)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Evaluate Reassignment Configuration + + + +Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. + +
Path Parameters
Query Parameters
+ +Evaluated Reassignment Configuration + +
Schema array
    lookupTrail object[]
    + +List of Reassignments found by looking up the next `TargetIdentity` in a ReassignmentConfiguration + +

Evaluate response when no Reassignment Configuration is found

Evaluate response when a long Reassignment trail is found

Evaluate response when a self-review is found and manager or org admin escalation is applied

+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-excluded-entitlements-potential-role.api.mdx b/products/idn/api/beta/get-excluded-entitlements-potential-role.api.mdx new file mode 100644 index 000000000..6d6304259 --- /dev/null +++ b/products/idn/api/beta/get-excluded-entitlements-potential-role.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-excluded-entitlements-potential-role +sidebar_label: Retrieves excluded entitlements for a potential role in a role mining session +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getExcludedEntitlementsPotentialRole","tags":["IAI Role Mining"],"description":"This method returns excluded entitlements for a potential role in a role mining session.","parameters":[{"in":"path","name":"sessionId","schema":{"type":"string"},"required":true,"description":"The role mining session id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"path","name":"potentialRoleId","schema":{"type":"string"},"required":true,"description":"A potential role id in a role mining session","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"query","name":"sorters","description":"sort by popularity, default order descending","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"in":"query","name":"filters","description":"Filter parameter by \"starts with\" for the applicationName and entitlementRef.name.","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Succeeded. Returns a list of excluded entitlements for a potential roles.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"entitlementRef":{"description":"Details about the entitlement","type":"object","properties":{"id":{"type":"string","description":"Id of the entitlement"},"name":{"type":"string","description":"Name of the entitlement"},"description":{"type":"string","description":"Description forthe entitlement"}}},"name":{"type":"string","description":"Name of the entitlement"},"applicationName":{"type":"string","description":"Application name of the entitlement"},"identityCount":{"type":"integer","description":"The number of identities with this entitlement in a role.","example":45},"popularity":{"type":"integer","description":"The % popularity of this entitlement in a role.","example":65},"popularityInOrg":{"type":"integer","description":"TThe % popularity of this entitlement in the org.","example":35}},"example":{"entitlementRef":{"id":"2c9180877212632a017228d5a796292b","name":"entitlement.10","description":"Read access"},"name":"Administrator","applicationName":"Slack","identityCount":"8","popularity":"65","popularityInOrg":"35"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Retrieves excluded entitlements for a potential role in a role mining session","description":{"content":"This method returns excluded entitlements for a potential role in a role mining session.","type":"text/plain"},"url":{"path":["role-mining-sessions",":sessionId","potential-roles",":potentialRoleId","excluded-entitlements"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"sort by popularity, default order descending","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"Filter parameter by \"starts with\" for the applicationName and entitlementRef.name.","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The role mining session id","type":"text/plain"},"type":"any","value":"","key":"sessionId"},{"disabled":false,"description":{"content":"(Required) A potential role id in a role mining session","type":"text/plain"},"type":"any","value":"","key":"potentialRoleId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Retrieves excluded entitlements for a potential role in a role mining session' (get-excluded-entitlements-potential-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieves excluded entitlements for a potential role in a role mining session + + + +This method returns excluded entitlements for a potential role in a role mining session. + +
Path Parameters
Query Parameters
+ +Succeeded. Returns a list of excluded entitlements for a potential roles. + +
Schema array
    entitlementRef object
    + +Details about the entitlement + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-form-definition-by-key.api.mdx b/products/idn/api/beta/get-form-definition-by-key.api.mdx new file mode 100644 index 000000000..c261d336f --- /dev/null +++ b/products/idn/api/beta/get-form-definition-by-key.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-form-definition-by-key +sidebar_label: Return a form definition. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Custom Forms"],"description":"Parameter `{formDefinitionID}` should match a form definition ID.","operationId":"getFormDefinitionByKey","parameters":[{"name":"formDefinitionID","in":"path","description":"Form definition ID","required":true,"schema":{"type":"string","x-go-name":"FormDefinitionID"},"example":"00000000-0000-0000-0000-000000000000","x-go-name":"FormDefinitionID"}],"responses":{"200":{"description":"Returns a form definition","content":{"application/json":{"schema":{"properties":{"created":{"description":"Created is the date the form definition was created","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Created"},"description":{"description":"Description is the form definition description","example":"My form description","type":"string","x-go-name":"Description"},"formConditions":{"description":"FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form","items":{"description":"FormCondition represent a form conditional","properties":{"effects":{"description":"Effects is a list of effects","items":{"description":"ConditionEffect is the effect produced by a condition","properties":{"config":{"additionalProperties":{},"description":"Config is a arbitrary map that holds a configuration based on EffectType","example":{},"type":"object","x-go-name":"Config"},"effectType":{"description":"EffectType is the type of effect to perform when the conditions are evaluated for this logic block\nHIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","enum":["HIDE","SHOW","DISABLE","ENABLE","REQUIRE","OPTIONAL","SUBMIT_MESSAGE","SUBMIT_NOTIFICATION","SET_DEFAULT_VALUE"],"example":"HIDE","type":"string","x-go-enum-desc":"HIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","x-go-name":"EffectType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Effects"},"ruleOperator":{"description":"RuleOperator is a ConditionRuleLogicalOperatorType value\nAND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","enum":["AND","OR"],"example":"AND","type":"string","x-go-enum-desc":"AND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","x-go-name":"RuleOperator"},"rules":{"description":"Rules is a list of rules","items":{"properties":{"operator":{"description":"Operator is a ConditionRuleComparisonOperatorType value\nEQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","enum":["EQ","NE","CO","NOT_CO","IN","NOT_IN","EM","NOT_EM","SW","NOT_SW","EW","NOT_EW"],"example":"EQ","type":"string","x-go-enum-desc":"EQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","x-go-name":"Operator"},"source":{"description":"Source, if the sourceType is ConditionRuleSourceTypeInput then the source type is the name of the form input to accept. While if the sourceType is ConditionRuleSourceTypeElement\nthen source is the name of a technical key of an element to retrieve its value","example":"department","type":"string","x-go-name":"Source"},"sourceType":{"description":"SourceType defines what type of object is being selected. Either a reference to a form input (by input name), or a form element (by technical key)\nINPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","enum":["INPUT","ELEMENT"],"example":"ELEMENT","type":"string","x-go-enum-desc":"INPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","x-go-name":"SourceType"},"value":{"description":"Value is the value based on the ValueType","example":"Engineering","x-go-name":"Value"},"valueType":{"description":"ValueType is a ConditionRuleValueType type\nSTRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","enum":["STRING","STRING_LIST","INPUT","ELEMENT","LIST","BOOLEAN"],"example":"STRING","type":"string","x-go-enum-desc":"STRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","x-go-name":"ValueType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Rules"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormConditions"},"formElements":{"description":"FormElements is a list of nested form elements","items":{"properties":{"config":{"additionalProperties":{},"description":"Config is a config object","example":{"label":"Department"},"type":"object","x-go-name":"Config"},"elementType":{"description":"ElementType is a FormElementType value\nTEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","enum":["TEXT","TOGGLE","TEXTAREA","HIDDEN","PHONE","EMAIL","SELECT","DATE","SECTION","COLUMNS"],"example":"TEXT","type":"string","x-go-enum-desc":"TEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","x-go-name":"ElementType"},"id":{"description":"ID is a form element identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"key":{"description":"Key is the technical key","example":"department","type":"string","x-go-name":"Key"},"validations":{"description":"FormElementValidationsSet is a set of FormElementValidation items","example":[{"validationType":"REQUIRED"}],"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormElements"},"formInput":{"description":"FormInput is a list of form inputs that are required when creating a form-instance object","items":{"properties":{"description":{"description":"Description is the description for this form input value","example":"A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic","type":"string","x-go-name":"Description"},"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"label":{"description":"Label is the name for this form input value","example":"input1","type":"string","x-go-name":"Label"},"type":{"description":"Type is a FormDefinitionInputType value\nSTRING FormDefinitionInputTypeString","enum":["STRING"],"example":"STRING","type":"string","x-go-enum-desc":"STRING FormDefinitionInputTypeString","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormInput"},"id":{"description":"FormDefinitionID is a unique guid identifying this form definition","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"FormDefinitionID"},"modified":{"description":"Modified is the last date the form definition was modified","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Modified"},"name":{"description":"Name is the form definition name","example":"My form","type":"string","x-go-name":"Name"},"owner":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a FormOwnerType value\nIDENTITY FormOwnerTypeIdentity","enum":["IDENTITY"],"example":"IDENTITY","type":"string","x-go-enum-desc":"IDENTITY FormOwnerTypeIdentity","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"usedBy":{"description":"UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used","items":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a FormUsedByType value\nWORKFLOW FormUsedByTypeWorkflow\nSOURCE FormUsedByTypeSource","enum":["WORKFLOW","SOURCE"],"example":"WORKFLOW","type":"string","x-go-enum-desc":"WORKFLOW FormUsedByTypeWorkflow\nSOURCE FormUsedByTypeSource","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"UsedBy"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}}}},"400":{"description":"An error with the request occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"401":{"description":"An error with the authorization occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"403":{"description":"An error with the user permissions occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"404":{"description":"An error with the item not found","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"title":"Error is the standard API error response type.","type":"object","properties":{"detailCode":{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"trackingId":{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"}}}},"500":{"description":"An internal server error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}}},"security":[{"oauth2":["sp:forms:manage"]}],"method":"get","path":"/form-definitions/{formDefinitionID}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Return a form definition.","description":{"content":"Parameter `{formDefinitionID}` should match a form definition ID.","type":"text/plain"},"url":{"path":["form-definitions",":formDefinitionID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Form definition ID","type":"text/plain"},"type":"any","value":"","key":"formDefinitionID"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Return a form definition.' (get-form-definition-by-key)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Return a form definition. + + + +Parameter `{formDefinitionID}` should match a form definition ID. + +
Path Parameters
+ +Returns a form definition + +
Schema
    formConditions object[]
    + +FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form + +
    effects object[]
    + +Effects is a list of effects + +
    config object
    + +Config is a arbitrary map that holds a configuration based on EffectType + +
    rules object[]
    + +Rules is a list of rules + +
    formElements object[]
    + +FormElements is a list of nested form elements + +
    config object
    + +Config is a config object + +
    formInput object[]
    + +FormInput is a list of form inputs that are required when creating a form-instance object + +
    owner object
    usedBy object[]
    + +UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used + +
+ +An error with the request occurred + +
Schema
    messages object[]
+ +An error with the authorization occurred + +
Schema
    messages object[]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
+ +An error with the item not found + +
Schema
    messages object[]
+ +Too many requests + +
Schema
    messages object[]
+ +An internal server error occurred + +
Schema
    messages object[]
\ No newline at end of file diff --git a/products/idn/api/beta/get-form-instance-by-key.api.mdx b/products/idn/api/beta/get-form-instance-by-key.api.mdx new file mode 100644 index 000000000..96e3066d0 --- /dev/null +++ b/products/idn/api/beta/get-form-instance-by-key.api.mdx @@ -0,0 +1,99 @@ +--- +id: get-form-instance-by-key +sidebar_label: Returns a form instance. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Custom Forms"],"description":"Parameter `{formInstanceID}` should match a form instance ID.","operationId":"getFormInstanceByKey","parameters":[{"name":"formInstanceID","in":"path","description":"Form instance ID","required":true,"schema":{"type":"string","x-go-name":"FormInstanceID"},"example":"00000000-0000-0000-0000-000000000000","x-go-name":"FormInstanceID"}],"responses":{"200":{"description":"Returns a form instance by its key","content":{"application/json":{"schema":{"properties":{"created":{"description":"Created is the date the form instance was assigned","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Created"},"createdBy":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a form instance created by type enum value\nWORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution\nSOURCE FormInstanceCreatedByTypeSource","enum":["WORKFLOW_EXECUTION","SOURCE"],"example":"WORKFLOW_EXECUTION","type":"string","x-go-enum-desc":"WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution\nSOURCE FormInstanceCreatedByTypeSource","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"expire":{"description":"Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record","example":"2023-08-12T20:14:57.74486Z","type":"string","x-go-name":"Expire"},"formConditions":{"description":"FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form","items":{"description":"FormCondition represent a form conditional","properties":{"effects":{"description":"Effects is a list of effects","items":{"description":"ConditionEffect is the effect produced by a condition","properties":{"config":{"additionalProperties":{},"description":"Config is a arbitrary map that holds a configuration based on EffectType","example":{},"type":"object","x-go-name":"Config"},"effectType":{"description":"EffectType is the type of effect to perform when the conditions are evaluated for this logic block\nHIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","enum":["HIDE","SHOW","DISABLE","ENABLE","REQUIRE","OPTIONAL","SUBMIT_MESSAGE","SUBMIT_NOTIFICATION","SET_DEFAULT_VALUE"],"example":"HIDE","type":"string","x-go-enum-desc":"HIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","x-go-name":"EffectType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Effects"},"ruleOperator":{"description":"RuleOperator is a ConditionRuleLogicalOperatorType value\nAND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","enum":["AND","OR"],"example":"AND","type":"string","x-go-enum-desc":"AND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","x-go-name":"RuleOperator"},"rules":{"description":"Rules is a list of rules","items":{"properties":{"operator":{"description":"Operator is a ConditionRuleComparisonOperatorType value\nEQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","enum":["EQ","NE","CO","NOT_CO","IN","NOT_IN","EM","NOT_EM","SW","NOT_SW","EW","NOT_EW"],"example":"EQ","type":"string","x-go-enum-desc":"EQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","x-go-name":"Operator"},"source":{"description":"Source, if the sourceType is ConditionRuleSourceTypeInput then the source type is the name of the form input to accept. While if the sourceType is ConditionRuleSourceTypeElement\nthen source is the name of a technical key of an element to retrieve its value","example":"department","type":"string","x-go-name":"Source"},"sourceType":{"description":"SourceType defines what type of object is being selected. Either a reference to a form input (by input name), or a form element (by technical key)\nINPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","enum":["INPUT","ELEMENT"],"example":"ELEMENT","type":"string","x-go-enum-desc":"INPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","x-go-name":"SourceType"},"value":{"description":"Value is the value based on the ValueType","example":"Engineering","x-go-name":"Value"},"valueType":{"description":"ValueType is a ConditionRuleValueType type\nSTRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","enum":["STRING","STRING_LIST","INPUT","ELEMENT","LIST","BOOLEAN"],"example":"STRING","type":"string","x-go-enum-desc":"STRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","x-go-name":"ValueType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Rules"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormConditions"},"formData":{"additionalProperties":{},"description":"FormData is the data provided by the form on submit. The data is in a key -> value map","example":{"department":"Engineering"},"type":"object","x-go-name":"FormData"},"formDefinitionId":{"description":"FormDefinitionID is the id of the form definition that created this form","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"FormDefinitionID"},"formElements":{"description":"FormElements is the configuration of the form, this would be a repeat of the fields from the form-config","items":{"properties":{"config":{"additionalProperties":{},"description":"Config is a config object","example":{"label":"Department"},"type":"object","x-go-name":"Config"},"elementType":{"description":"ElementType is a FormElementType value\nTEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","enum":["TEXT","TOGGLE","TEXTAREA","HIDDEN","PHONE","EMAIL","SELECT","DATE","SECTION","COLUMNS"],"example":"TEXT","type":"string","x-go-enum-desc":"TEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","x-go-name":"ElementType"},"id":{"description":"ID is a form element identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"key":{"description":"Key is the technical key","example":"department","type":"string","x-go-name":"Key"},"validations":{"description":"FormElementValidationsSet is a set of FormElementValidation items","example":[{"validationType":"REQUIRED"}],"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormElements"},"formErrors":{"description":"FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors","items":{"properties":{"key":{"description":"Key is the technical key","example":"department","type":"string","x-go-name":"Key"},"messages":{"description":"Messages is a list of web.ErrorMessage items","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"type":"array","x-go-name":"Messages"},"value":{"description":"Value is the value associated with a Key","example":"Engineering","x-go-name":"Value"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormErrors"},"formInput":{"additionalProperties":{},"description":"FormInput is an object of form input labels to value","example":{"input1":"Sales"},"type":"object","x-go-name":"FormInput"},"id":{"description":"FormInstanceID is a unique guid identifying this form instance","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"FormInstanceID"},"modified":{"description":"Modified is the last date the form instance was modified","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Modified"},"recipients":{"description":"Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it","items":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a FormInstanceRecipientType value\nIDENTITY FormInstanceRecipientIdentity","enum":["IDENTITY"],"example":"IDENTITY","type":"string","x-go-enum-desc":"IDENTITY FormInstanceRecipientIdentity","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Recipients"},"standAloneForm":{"default":false,"description":"StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form","example":false,"type":"boolean","x-go-name":"StandAloneForm"},"standAloneFormUrl":{"description":"StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI","example":"https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"StandAloneFormURL"},"state":{"description":"State the state of the form instance\nASSIGNED FormInstanceStateAssigned\nIN_PROGRESS FormInstanceStateInProgress\nSUBMITTED FormInstanceStateSubmitted\nCOMPLETED FormInstanceStateCompleted\nCANCELLED FormInstanceStateCancelled","enum":["ASSIGNED","IN_PROGRESS","SUBMITTED","COMPLETED","CANCELLED"],"example":"ASSIGNED","type":"string","x-go-enum-desc":"ASSIGNED FormInstanceStateAssigned\nIN_PROGRESS FormInstanceStateInProgress\nSUBMITTED FormInstanceStateSubmitted\nCOMPLETED FormInstanceStateCompleted\nCANCELLED FormInstanceStateCancelled","x-go-name":"State"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}}}},"400":{"description":"An error with the request occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"401":{"description":"An error with the authorization occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"403":{"description":"An error with the user permissions occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"404":{"description":"An error with the item not found","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"title":"Error is the standard API error response type.","type":"object","properties":{"detailCode":{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"trackingId":{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"}}}},"500":{"description":"An internal server error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}}},"security":[{"oauth2":[]}],"method":"get","path":"/form-instances/{formInstanceID}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Returns a form instance.","description":{"content":"Parameter `{formInstanceID}` should match a form instance ID.","type":"text/plain"},"url":{"path":["form-instances",":formInstanceID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Form instance ID","type":"text/plain"},"type":"any","value":"","key":"formInstanceID"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns a form instance.' (get-form-instance-by-key)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns a form instance. + + + +Parameter `{formInstanceID}` should match a form instance ID. + +
Path Parameters
+ +Returns a form instance by its key + +
Schema
    createdBy object
    formConditions object[]
    + +FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form + +
    effects object[]
    + +Effects is a list of effects + +
    config object
    + +Config is a arbitrary map that holds a configuration based on EffectType + +
    rules object[]
    + +Rules is a list of rules + +
    formData object
    + +FormData is the data provided by the form on submit. The data is in a key -\> value map + +
    formElements object[]
    + +FormElements is the configuration of the form, this would be a repeat of the fields from the form-config + +
    config object
    + +Config is a config object + +
    formErrors object[]
    + +FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors + +
    messages object[]
    + +Messages is a list of web.ErrorMessage items + +
    formInput object
    + +FormInput is an object of form input labels to value + +
    recipients object[]
    + +Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it + +
+ +An error with the request occurred + +
Schema
    messages object[]
+ +An error with the authorization occurred + +
Schema
    messages object[]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
+ +An error with the item not found + +
Schema
    messages object[]
+ +Too many requests + +
Schema
    messages object[]
+ +An internal server error occurred + +
Schema
    messages object[]
\ No newline at end of file diff --git a/products/idn/api/beta/get-historical-identity-events.api.mdx b/products/idn/api/beta/get-historical-identity-events.api.mdx new file mode 100644 index 000000000..849ee623a --- /dev/null +++ b/products/idn/api/beta/get-historical-identity-events.api.mdx @@ -0,0 +1,127 @@ +--- +id: get-historical-identity-events +sidebar_label: Lists all events for the given identity +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getHistoricalIdentityEvents","tags":["Identity History"],"description":"This method retrieves all access events for the identity Requires authorization scope of 'idn:identity-history:read' ","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity id","example":"8c190e6787aa4ed9a90bd9d5344523fb"},{"in":"query","name":"from","schema":{"type":"string"},"description":"The optional instant from which to return the access events","example":"2007-03-01T13:00:00Z"},{"in":"query","name":"eventTypes","schema":{"type":"array","items":{"type":"string"}},"description":"An optional list of event types to return. If null or empty, all events are returned","example":["AccessAddedEvent","AccessRemovedEvent"]},{"in":"query","name":"accessItemTypes","schema":{"type":"array","items":{"type":"string"}},"description":"An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned","example":["entitlement","account"]},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The list of events for the identity","content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"accessItem":{"type":"object","oneOf":[{"type":"object","properties":{"accessType":{"type":"string","example":"accessProfile","description":"the access item type. accessProfile in this case"},"id":{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"},"name":{"type":"string","example":"sample","description":"the access profile name"},"sourceName":{"type":"string","example":"DataScienceDataset","description":"the name of the source"},"sourceId":{"type":"string","example":"2793o32dwd","description":"the id of the source"},"description":{"type":"string","example":"AccessProfile - Workday/Citizenship access","description":"the description for the access profile"},"displayName":{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"},"entitlementCount":{"type":"string","example":12,"description":"the number of entitlements the access profile will create"},"appDisplayName":{"type":"string","example":"AppName","description":"the name of app"}}},{"type":"object","properties":{"accessType":{"type":"string","example":"account","description":"the access item type. account in this case"},"id":{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"},"nativeIdentity":{"type":"string","example":"dr.arden.ogahn.d","description":"the native identifier used to uniquely identify an acccount"},"sourceName":{"type":"string","example":"DataScienceDataset","description":"the name of the source"},"sourceId":{"type":"string","example":"2793o32dwd","description":"the id of the source"},"entitlementCount":{"type":"string","example":12,"description":"the number of entitlements the account will create"},"displayName":{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"}}},{"type":"object","properties":{"accessType":{"type":"string","example":"app","description":"the access item type. entitlement in this case"},"id":{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"},"displayName":{"type":"string","example":"Display Name","description":"the access profile display name"},"sourceName":{"type":"string","example":"appName","description":"the associated source name if it exists"}}},{"type":"object","properties":{"accessType":{"type":"string","example":"entitlement","description":"the access item type. entitlement in this case"},"id":{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"},"attribute":{"type":"string","example":"groups","description":"the entitlement attribute"},"value":{"type":"string","example":"Upward mobility access","description":"the associated value"},"entitlementType":{"type":"string","example":"entitlement","description":"the type of entitlement"},"sourceName":{"type":"string","example":"DataScienceDataset","description":"the name of the source"},"sourceId":{"type":"string","example":"2793o32dwd","description":"the id of the source"},"description":{"type":"string","example":"Entitlement - Workday/Citizenship access","description":"the description for the entitlment"},"displayName":{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"}}},{"type":"object","properties":{"accessType":{"type":"string","example":"role","description":"the access item type. role in this case"},"id":{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"},"displayName":{"type":"string","example":"sample","description":"the role display name"},"description":{"type":"string","example":"Role - Workday/Citizenship access","description":"the description for the role"},"sourceName":{"type":"string","example":"Source Name","description":"the associated source name if it exists"}}}],"example":{"id":"8c190e6787aa4ed9a90bd9d5344523fb","accessType":"account","nativeIdentity":127999,"sourceName":"JDBC Entitlements Source","entitlementCount":0,"displayName":"Sample Name"}},"identityId":{"type":"string","description":"the identity id","example":"8c190e6787aa4ed9a90bd9d5344523fb"},"eventType":{"type":"string","description":"the event type","example":"AccessItemAssociated"},"dt":{"type":"string","description":"the date of event","example":"2019-03-08T22:37:33.901Z"},"governanceEvent":{"example":{"name":"Manager Certification for Jon Snow","dt":"2019-03-08T22:37:33.901Z","type":"certification","governanceId":"2c91808a77ff216301782327a50f09bf","owners":[{"id":"bc693f07e7b645539626c25954c58554","displayName":"Jon Snow"}],"reviewers":[{"id":"bc693f07e7b645539626c25954c58554","displayName":"Jon Snow"}],"decisionMaker":{"id":"bc693f07e7b645539626c25954c58554","displayName":"Jon Snow"}},"type":"object","properties":{"name":{"type":"string","description":"The name of the governance event, such as the certification name or access request ID.","example":"Manager Certification for Jon Snow"},"dt":{"type":"string","description":"The date that the certification or access request was completed.","example":"2019-03-08T22:37:33.901Z"},"type":{"type":"string","enum":["certification","accessRequest"],"description":"The type of governance event.","example":"certification"},"governanceId":{"type":"string","description":"The ID of the instance that caused the event - either the certification ID or access request ID.","example":"2c91808a77ff216301782327a50f09bf"},"owners":{"type":"array","description":"The owners of the governance event (the certifiers or approvers)","items":{"type":"object","properties":{"id":{"type":"string","description":"the id of the certifier","example":"8a80828f643d484f01643e14202e206f"},"displayName":{"type":"string","description":"the name of the certifier","example":"John Snow"}}},"example":[{"id":"8a80828f643d484f01643e14202e206f","displayName":"John Snow"}]},"reviewers":{"type":"array","description":"The owners of the governance event (the certifiers or approvers), this field should be preferred over owners","items":{"type":"object","properties":{"id":{"type":"string","description":"the id of the certifier","example":"8a80828f643d484f01643e14202e206f"},"displayName":{"type":"string","description":"the name of the certifier","example":"John Snow"}}},"example":[{"id":"8a80828f643d484f01643e14202e206f","displayName":"John Snow"}]},"decisionMaker":{"type":"object","properties":{"id":{"type":"string","description":"the id of the certifier","example":"8a80828f643d484f01643e14202e206f"},"displayName":{"type":"string","description":"the name of the certifier","example":"John Snow"}},"description":"The decision maker","example":{"id":"8a80828f643d484f01643e14202e206f","displayName":"John Snow"}}}}}},{"type":"object","properties":{"accessItem":{"type":"object","oneOf":[{"type":"object","properties":{"accessType":{"type":"string","example":"accessProfile","description":"the access item type. accessProfile in this case"},"id":{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"},"name":{"type":"string","example":"sample","description":"the access profile name"},"sourceName":{"type":"string","example":"DataScienceDataset","description":"the name of the source"},"sourceId":{"type":"string","example":"2793o32dwd","description":"the id of the source"},"description":{"type":"string","example":"AccessProfile - Workday/Citizenship access","description":"the description for the access profile"},"displayName":{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"},"entitlementCount":{"type":"string","example":12,"description":"the number of entitlements the access profile will create"},"appDisplayName":{"type":"string","example":"AppName","description":"the name of app"}}},{"type":"object","properties":{"accessType":{"type":"string","example":"account","description":"the access item type. account in this case"},"id":{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"},"nativeIdentity":{"type":"string","example":"dr.arden.ogahn.d","description":"the native identifier used to uniquely identify an acccount"},"sourceName":{"type":"string","example":"DataScienceDataset","description":"the name of the source"},"sourceId":{"type":"string","example":"2793o32dwd","description":"the id of the source"},"entitlementCount":{"type":"string","example":12,"description":"the number of entitlements the account will create"},"displayName":{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"}}},{"type":"object","properties":{"accessType":{"type":"string","example":"app","description":"the access item type. entitlement in this case"},"id":{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"},"displayName":{"type":"string","example":"Display Name","description":"the access profile display name"},"sourceName":{"type":"string","example":"appName","description":"the associated source name if it exists"}}},{"type":"object","properties":{"accessType":{"type":"string","example":"entitlement","description":"the access item type. entitlement in this case"},"id":{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"},"attribute":{"type":"string","example":"groups","description":"the entitlement attribute"},"value":{"type":"string","example":"Upward mobility access","description":"the associated value"},"entitlementType":{"type":"string","example":"entitlement","description":"the type of entitlement"},"sourceName":{"type":"string","example":"DataScienceDataset","description":"the name of the source"},"sourceId":{"type":"string","example":"2793o32dwd","description":"the id of the source"},"description":{"type":"string","example":"Entitlement - Workday/Citizenship access","description":"the description for the entitlment"},"displayName":{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"}}},{"type":"object","properties":{"accessType":{"type":"string","example":"role","description":"the access item type. role in this case"},"id":{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"},"displayName":{"type":"string","example":"sample","description":"the role display name"},"description":{"type":"string","example":"Role - Workday/Citizenship access","description":"the description for the role"},"sourceName":{"type":"string","example":"Source Name","description":"the associated source name if it exists"}}}],"example":{"id":"8c190e6787aa4ed9a90bd9d5344523fb","accessType":"account","nativeIdentity":127999,"sourceName":"JDBC Entitlements Source","entitlementCount":0,"displayName":"Sample Name"}},"identityId":{"type":"string","description":"the identity id","example":"8c190e6787aa4ed9a90bd9d5344523fb"},"eventType":{"type":"string","description":"the event type","example":"AccessItemRemoved"},"dt":{"type":"string","description":"the date of event","example":"2019-03-08T22:37:33.901Z"},"governanceEvent":{"example":{"name":"Manager Certification for Jon Snow","dt":"2019-03-08T22:37:33.901Z","type":"certification","governanceId":"2c91808a77ff216301782327a50f09bf","owners":[{"id":"bc693f07e7b645539626c25954c58554","displayName":"Jon Snow"}],"reviewers":[{"id":"bc693f07e7b645539626c25954c58554","displayName":"Jon Snow"}],"decisionMaker":{"id":"bc693f07e7b645539626c25954c58554","displayName":"Jon Snow"}},"type":"object","properties":{"name":{"type":"string","description":"The name of the governance event, such as the certification name or access request ID.","example":"Manager Certification for Jon Snow"},"dt":{"type":"string","description":"The date that the certification or access request was completed.","example":"2019-03-08T22:37:33.901Z"},"type":{"type":"string","enum":["certification","accessRequest"],"description":"The type of governance event.","example":"certification"},"governanceId":{"type":"string","description":"The ID of the instance that caused the event - either the certification ID or access request ID.","example":"2c91808a77ff216301782327a50f09bf"},"owners":{"type":"array","description":"The owners of the governance event (the certifiers or approvers)","items":{"type":"object","properties":{"id":{"type":"string","description":"the id of the certifier","example":"8a80828f643d484f01643e14202e206f"},"displayName":{"type":"string","description":"the name of the certifier","example":"John Snow"}}},"example":[{"id":"8a80828f643d484f01643e14202e206f","displayName":"John Snow"}]},"reviewers":{"type":"array","description":"The owners of the governance event (the certifiers or approvers), this field should be preferred over owners","items":{"type":"object","properties":{"id":{"type":"string","description":"the id of the certifier","example":"8a80828f643d484f01643e14202e206f"},"displayName":{"type":"string","description":"the name of the certifier","example":"John Snow"}}},"example":[{"id":"8a80828f643d484f01643e14202e206f","displayName":"John Snow"}]},"decisionMaker":{"type":"object","properties":{"id":{"type":"string","description":"the id of the certifier","example":"8a80828f643d484f01643e14202e206f"},"displayName":{"type":"string","description":"the name of the certifier","example":"John Snow"}},"description":"The decision maker","example":{"id":"8a80828f643d484f01643e14202e206f","displayName":"John Snow"}}}}}},{"type":"object","properties":{"changes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"the attribute name"},"previousValue":{"type":"string","description":"the old value of attribute"},"newValue":{"type":"string","description":"the new value of attribute"}},"example":{"name":"firstname","previousValue":"adam","newValue":"zampa"}}},"eventType":{"type":"string","description":"the event type"},"identityId":{"type":"string","description":"the identity id"},"dt":{"type":"string","description":"the date of event"}},"example":{"attributeChanges":{"name":"firstname","previousValue":"adam","newValue":"zampa"},"eventType":"AttributesChanged","identityId":"8a80828f643d484f01643e14202e206f","dt":"2019-03-08T22:37:33.901Z"}},{"type":"object","properties":{"accessRequest":{"description":"the access request details","type":"object","properties":{"requesterId":{"type":"string","example":"2c91808a77ff216301782327a50f09bf","description":"the requester Id"},"requesterName":{"type":"string","example":"Bing C","description":"the requesterName"},"items":{"type":"array","example":[{"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":{"type":"object","properties":{"operation":{"type":"string","example":"Add","description":"the access request item operation"},"accessItemType":{"type":"string","example":"role","description":"the access item type"},"name":{"type":"string","example":"Role-1","description":"the name of access request item"},"decision":{"type":"string","example":"APPROVED","enum":["APPROVED","REJECTED"],"description":"the final decision for the access request"},"description":{"type":"string","example":"The role descrition","description":"the description of access request item"},"sourceId":{"type":"string","example":"8a80828f643d484f01643e14202e206f","description":"the source id"},"sourceName":{"type":"string","example":"Source1","description":"the source Name"},"approvalInfos":{"type":"array","example":[{"name":"John Snow","id":"8a80828f643d484f01643e14202e2000","status":"Approved"}],"items":{"type":"object","properties":{"id":{"type":"string","example":"8a80828f643d484f01643e14202e2000","description":"the id of approver"},"name":{"type":"string","example":"John Snow","description":"the name of approver"},"status":{"type":"string","example":"Approved","description":"the status of the approval request"}}}}}}}}},"identityId":{"type":"string","example":"8a80828f643d484f01643e14202e206f","description":"the identity id"},"eventType":{"type":"string","example":"AccessRequested","description":"the event type"},"dt":{"type":"string","example":"2019-03-08T22:37:33.901Z","description":"the date of event"}}},{"type":"object","properties":{"certificationId":{"type":"string","description":"the id of the certification item","example":"2c91808a77ff216301782327a50f09bf"},"certificationName":{"type":"string","description":"the certification item name","example":"Cert name"},"signedDate":{"type":"string","description":"the date ceritification was signed","example":"2019-03-08T22:37:33.901Z"},"certifiers":{"type":"array","description":"this field is deprecated and may go away","items":{"type":"object","properties":{"id":{"type":"string","description":"the id of the certifier","example":"8a80828f643d484f01643e14202e206f"},"displayName":{"type":"string","description":"the name of the certifier","example":"John Snow"}}},"example":[{"id":"8a80828f643d484f01643e14202e206f","displayName":"John Snow"}]},"reviewers":{"type":"array","description":"The list of identities who review this certification","items":{"type":"object","properties":{"id":{"type":"string","description":"the id of the certifier","example":"8a80828f643d484f01643e14202e206f"},"displayName":{"type":"string","description":"the name of the certifier","example":"John Snow"}}},"example":[{"id":"8a80828f643d484f01643e14202e206f","displayName":"John Snow"}]},"signer":{"type":"object","properties":{"id":{"type":"string","description":"the id of the certifier","example":"8a80828f643d484f01643e14202e206f"},"displayName":{"type":"string","description":"the name of the certifier","example":"John Snow"}},"description":"Identity who signed off on the certification","example":{"id":"8a80828f643d484f01643e14202e206f","displayName":"John Snow"}},"eventType":{"type":"string","description":"the event type","example":"IdentityCertified"},"dt":{"type":"string","description":"the date of event","example":"2019-03-08T22:37:33.901Z"}}},{"type":"object","properties":{"eventType":{"type":"string","description":"the event type"},"identityId":{"type":"string","description":"the identity id"},"dt":{"type":"string","description":"the date of event"},"account":{"type":"object","properties":{"id":{"type":"string","description":"the ID of the account in the database"},"nativeIdentity":{"type":"string","description":"the native identifier of the account"},"displayName":{"type":"string","description":"the display name of the account"},"sourceId":{"type":"string","description":"the ID of the source for this account"},"sourceName":{"type":"string","description":"the name of the source for this account"},"entitlementCount":{"type":"integer","description":"the number of entitlements on this account"},"accessType":{"type":"string","description":"this value is always \"account\""}}},"statusChange":{"type":"object","properties":{"previousStatus":{"type":"string","description":"the previous status of the account","enum":["enabled","disabled","locked"]},"newStatus":{"type":"string","description":"the new status of the account","enum":["enabled","disabled","locked"]}}}},"example":{"account":{"id":"2c91808a77ff216301782327a50f09bf","nativeIdentity":127999,"displayName":"Sample Name","sourceId":"8a80828f643d484f01643e14202e206f","sourceName":"JDBC Entitlements Source","entitlementCount":0,"accessType":"account"},"statusChange":{"previousStatus":"enabled","newStatus":"disabled"},"eventType":"AccountStatusChanged","identityId":"8a80828f643d484f01643e14202e206f","date":"2019-03-08T22:37:33.901Z"}}]}},"examples":{"AccessItemAssociated":{"description":"An Access item associated event","value":[{"accessItem":{"id":"8c190e6787aa4ed9a90bd9d5344523fb","accessType":"account","nativeIdentity":127999,"sourceName":"JDBC Entitlements Source","entitlementCount":0,"displayName":"Sample Name"},"eventType":"AccessItemAssociated","identityId":"8a80828f643d484f01643e14202e206f","dt":"2019-03-08T22:37:33.901Z","governanceEvent":{"name":"Access Request 58","dt":"2019-03-08T22:37:33.901Z","type":"accessRequest","governanceId":"2c91808a77ff216301782327a50f09e1","owners":[{"id":"bc693f07e7b645539626c25954c58554","displayName":"Jon Snow"}],"reviewers":[{"id":"bc693f07e7b645539626c25954c58554","displayName":"Jon Snow"}],"decisionMaker":{"id":"bc693f07e7b645539626c25954c58554","displayName":"Jon Snow"}}}]},"AccessItemRemoved":{"description":"An Access item removed event","value":[{"accessItem":{"id":"8c190e6787aa4ed9a90bd9d5344523fb","accessType":"account","nativeIdentity":127999,"sourceName":"JDBC Entitlements Source","entitlementCount":0,"displayName":"Sample Name"},"eventType":"AccessItemRemoved","identityId":"8a80828f643d484f01643e14202e206f","dt":"2019-03-08T22:37:33.901Z","governanceEvent":{"name":"Manager Certification for Jon Snow","dt":"2019-03-08T22:37:33.901Z","type":"certification","governanceId":"2c91808a77ff216301782327a50f09bf","owners":[{"id":"bc693f07e7b645539626c25954c58554","displayName":"Jon Snow"}],"reviewers":[{"id":"bc693f07e7b645539626c25954c58554","displayName":"Jon Snow"}],"decisionMaker":{"id":"bc693f07e7b645539626c25954c58554","displayName":"Jon Snow"}}}]},"AttributesChanged":{"description":"An attribute changed event","value":[{"attributeChanges":[{"name":"firstname","previousValue":"adam","newValue":"zampa"}],"eventType":"AttributesChanged","identityId":"8a80828f643d484f01643e14202e206f","dt":"2019-03-08T22:37:33.901Z"}]},"AccessRequested":{"description":"An access requested event","value":{"accessRequest":{"requesterId":"2c91808a77ff216301782327a50f09bf","requestName":"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"}]}]},"eventType":"AccessRequested","identityId":"8a80828f643d484f01643e14202e206f","dt":"2019-03-08T22:37:33.901Z"}},"IdentityCertified":{"description":"An identity certified event","value":[{"certification":{"id":"2c91808a77ff216301782327a50f09bf","name":"Cert name","signedDate":"2019-03-08T22:37:33.901Z","certifiers":[{"id":"8a80828f643d484f01643e14202e206f","displayName":"John Snow"}],"reviewers":[{"id":"8a80828f643d484f01643e14202e206f","displayName":"Daenerys Targaryen"}],"signer":{"id":"8a80828f643d484f01643e14202e206f","displayName":"Tyrion Lannister"}},"eventType":"IdentityCertified","identityId":"8a80828f643d484f01643e14202e206f","dt":"2019-03-08T22:37:33.901Z"}]},"AccountStatusChanged":{"description":"An account status changed event","value":[{"account":{"id":"2c91808a77ff216301782327a50f09bf","nativeIdentity":127999,"displayName":"Sample Name","sourceId":"8a80828f643d484f01643e14202e206f","sourceName":"JDBC Entitlements Source","entitlementCount":0,"accessType":"account"},"statusChange":{"previousStatus":"ENABLED","newStatus":"DISABLED"},"eventType":"AccountStatusChanged","identityId":"8a80828f643d484f01643e14202e206f","dt":"2019-03-08T22:37:33.901Z"}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/historical-identities/{id}/events","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Lists all events for the given identity","description":{"content":"This method retrieves all access events for the identity Requires authorization scope of 'idn:identity-history:read' ","type":"text/plain"},"url":{"path":["historical-identities",":id","events"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The optional instant from which to return the access events","type":"text/plain"},"key":"from","value":""},{"disabled":false,"description":{"content":"An optional list of event types to return. If null or empty, all events are returned","type":"text/plain"},"key":"eventTypes","value":""},{"disabled":false,"description":{"content":"An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned","type":"text/plain"},"key":"accessItemTypes","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identity id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Lists all events for the given identity' (get-historical-identity-events)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Lists all events for the given identity + + + +This method retrieves all access events for the identity Requires authorization scope of 'idn:identity-history:read' + +
Path Parameters
Query Parameters
+ +The list of events for the identity + +
Schema array
    anyOf
    accessItem object
    oneOf
    governanceEvent object
    owners object[]
    + +The owners of the governance event (the certifiers or approvers) + +
    reviewers object[]
    + +The owners of the governance event (the certifiers or approvers), this field should be preferred over owners + +
    decisionMaker object
    + +The decision maker + +
    accessItem object
    oneOf
    governanceEvent object
    owners object[]
    + +The owners of the governance event (the certifiers or approvers) + +
    reviewers object[]
    + +The owners of the governance event (the certifiers or approvers), this field should be preferred over owners + +
    decisionMaker object
    + +The decision maker + +
    changes object[]
    accessRequest object
    + +the access request details + +
    items object[]
    approvalInfos object[]
    certifiers object[]
    + +this field is deprecated and may go away + +
    reviewers object[]
    + +The list of identities who review this certification + +
    signer object
    + +Identity who signed off on the certification + +
    account object
    statusChange object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-historical-identity.api.mdx b/products/idn/api/beta/get-historical-identity.api.mdx new file mode 100644 index 000000000..81746b598 --- /dev/null +++ b/products/idn/api/beta/get-historical-identity.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-historical-identity +sidebar_label: Get latest snapshot of identity +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getHistoricalIdentity","tags":["Identity History"],"description":"This method retrieves a specified identity Requires authorization scope of 'idn:identity-history:read'","security":[{"oauth2":["idn:identity-history:read"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity id","example":"8c190e6787aa4ed9a90bd9d5344523fb"}],"responses":{"200":{"description":"The identity object.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"the identity ID","example":"bc693f07e7b645539626c25954c58554"},"displayName":{"type":"string","description":"the display name of the identity","example":"Adam Zampa"},"snapshot":{"type":"string","description":"the date when the identity record was created","example":"2007-03-01T13:00:00.000Z"},"deletedDate":{"type":"string","description":"the date when the identity was deleted","example":"2007-03-01T13:00:00.000Z"},"accessItemCount":{"type":"object","description":"A map containing the count of each access item","additionalProperties":{"type":"string"}},"attributes":{"type":"object","description":"A map containing the identity attributes","additionalProperties":{"type":"string"}}},"example":{"id":"2c9079b270a266a60170a2779fcb0007","displayName":"Lahoma Wuckert","deletedDate":null,"snapshot":"2007-03-01T13:00:00.000Z","attributes":{"jobTitle":"HR Manager","location":"NYC","firstname":"Lahoma","lastname":"Wuckert","department":"HR"},"accessItemCount":{"role":2,"accessProfile":2,"entitlement":28,"account":3}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/historical-identities/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get latest snapshot of identity","description":{"content":"This method retrieves a specified identity Requires authorization scope of 'idn:identity-history:read'","type":"text/plain"},"url":{"path":["historical-identities",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identity id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get latest snapshot of identity' (get-historical-identity)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get latest snapshot of identity + + + +This method retrieves a specified identity Requires authorization scope of 'idn:identity-history:read' + +
Path Parameters
+ +The identity object. + +
Schema
    accessItemCount object
    + +A map containing the count of each access item + +
  • property name* string
    • attributes object
    + +A map containing the identity attributes + +
  • property name* string
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-identities-potential-role.api.mdx b/products/idn/api/beta/get-identities-potential-role.api.mdx new file mode 100644 index 000000000..e041ac101 --- /dev/null +++ b/products/idn/api/beta/get-identities-potential-role.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-identities-potential-role +sidebar_label: Retrieves identities for a potential role in a role mining session +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getIdentitiesPotentialRole","tags":["IAI Role Mining"],"description":"This method returns identities for a potential role in a role mining session.","parameters":[{"in":"path","name":"sessionId","schema":{"type":"string"},"required":true,"description":"The role mining session id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"path","name":"potentialRoleId","schema":{"type":"string"},"required":true,"description":"A potential role id in a role mining session","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"query","name":"sorters","description":"sort by name, default order ascending","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"in":"query","name":"filters","description":"Filter parameter by \"starts with\" for the name.","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Succeeded. Returns a list of identities for a potential role.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the identity"},"name":{"type":"string","description":"Name of the identity"},"attributes":{"type":"object","additionalProperties":{"type":"string"}}},"example":{"id":"2c9180877212632a017228d5934525e6","name":"Allene Abernathy-Welch","attributes":{"jobTitle":"SQL Developer","department":"IT","location":"NYC","firstName":"Allene"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Retrieves identities for a potential role in a role mining session","description":{"content":"This method returns identities for a potential role in a role mining session.","type":"text/plain"},"url":{"path":["role-mining-sessions",":sessionId","potential-roles",":potentialRoleId","identities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"sort by name, default order ascending","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"Filter parameter by \"starts with\" for the name.","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The role mining session id","type":"text/plain"},"type":"any","value":"","key":"sessionId"},{"disabled":false,"description":{"content":"(Required) A potential role id in a role mining session","type":"text/plain"},"type":"any","value":"","key":"potentialRoleId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Retrieves identities for a potential role in a role mining session' (get-identities-potential-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieves identities for a potential role in a role mining session + + + +This method returns identities for a potential role in a role mining session. + +
Path Parameters
Query Parameters
+ +Succeeded. Returns a list of identities for a potential role. + +
Schema array
    attributes object
  • property name* string
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-identity-certification-item-permissions.api.mdx b/products/idn/api/beta/get-identity-certification-item-permissions.api.mdx new file mode 100644 index 000000000..b97648e92 --- /dev/null +++ b/products/idn/api/beta/get-identity-certification-item-permissions.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-identity-certification-item-permissions +sidebar_label: Permissions for Entitlement Certification Item +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getIdentityCertificationItemPermissions","tags":["Certifications"],"description":"This API returns the permissions associated with an entitlement certification item based on the certification item's ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.","parameters":[{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nSupported fields and primitive operators:\n\n**target**: *eq, sw*\n\n**rights**: *ca*\n\nSupported composite operators:\n\n*and, or*\n\nAll field values (second filter operands) are case-insensitive for this API.\n\nOnly a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field.\nFor example,\n\nThe following is valid:\n*?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22*\n\nThe following is invalid:\n*?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)*"},{"in":"path","name":"certificationId","schema":{"type":"string"},"required":true,"description":"The certification ID","example":"ef38f94347e94562b5bb8424a56397d8"},{"in":"path","name":"itemId","schema":{"type":"string"},"required":true,"description":"The certification item ID","example":"2c91808671bcbab40171bd945d961227"},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"A list of permissions associated with the given itemId","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Simplified DTO for the Permission objects stored in SailPoint's database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers.","properties":{"rights":{"type":"array","description":"All the rights (e.g. actions) that this permission allows on the target","readOnly":true,"items":{"type":"string","example":"SELECT"}},"target":{"type":"string","description":"The target the permission would grants rights on.","readOnly":true,"example":"SYS.GV_$TRANSACTION"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/certifications/{certificationId}/access-review-items/{itemId}/permissions","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Permissions for Entitlement Certification Item","description":{"content":"This API returns the permissions associated with an entitlement certification item based on the certification item's ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.","type":"text/plain"},"url":{"path":["certifications",":certificationId","access-review-items",":itemId","permissions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nSupported fields and primitive operators:\n\n**target**: *eq, sw*\n\n**rights**: *ca*\n\nSupported composite operators:\n\n*and, or*\n\nAll field values (second filter operands) are case-insensitive for this API.\n\nOnly a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field.\nFor example,\n\nThe following is valid:\n*?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22*\n\nThe following is invalid:\n*?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The certification ID","type":"text/plain"},"type":"any","value":"","key":"certificationId"},{"disabled":false,"description":{"content":"(Required) The certification item ID","type":"text/plain"},"type":"any","value":"","key":"itemId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Permissions for Entitlement Certification Item' (get-identity-certification-item-permissions)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Permissions for Entitlement Certification Item + + + +This API returns the permissions associated with an entitlement certification item based on the certification item's ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +
Path Parameters
Query Parameters
+ +A list of permissions associated with the given itemId + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-identity-certification-pending-tasks.api.mdx b/products/idn/api/beta/get-identity-certification-pending-tasks.api.mdx new file mode 100644 index 000000000..59c4e90ca --- /dev/null +++ b/products/idn/api/beta/get-identity-certification-pending-tasks.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-identity-certification-pending-tasks +sidebar_label: Pending Certification Tasks +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getIdentityCertificationPendingTasks","tags":["Certifications"],"description":"This API returns the status of all pending (`QUEUED` or `IN_PROGRESS`) tasks for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity campaign certification ID"}],"responses":{"200":{"description":"A list of pending (`QUEUED` or `IN_PROGRESS`) certification task objects.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The task id","example":"abcd-ef12-3456"},"certificationId":{"type":"string","description":"The certification id","example":"ef38f94347e94562b5bb8424a56397d8"},"type":{"type":"string","enum":["REASSIGN"]},"status":{"type":"string","enum":["QUEUED","IN_PROGRESS","SUCCESS","ERROR"]},"errors":{"type":"array","items":{"type":"string"},"description":"Any errors executing the task (Optional).","example":[]}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/certifications/{id}/tasks-pending","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Pending Certification Tasks","description":{"content":"This API returns the status of all pending (`QUEUED` or `IN_PROGRESS`) tasks for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.","type":"text/plain"},"url":{"path":["certifications",":id","tasks-pending"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identity campaign certification ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Pending Certification Tasks' (get-identity-certification-pending-tasks)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Pending Certification Tasks + + + +This API returns the status of all pending (`QUEUED` or `IN_PROGRESS`) tasks for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +
Path Parameters
+ +A list of pending (`QUEUED` or `IN_PROGRESS`) certification task objects. + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-identity-certification-task-status.api.mdx b/products/idn/api/beta/get-identity-certification-task-status.api.mdx new file mode 100644 index 000000000..555fd1a57 --- /dev/null +++ b/products/idn/api/beta/get-identity-certification-task-status.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-identity-certification-task-status +sidebar_label: Certification Task Status +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getIdentityCertificationTaskStatus","tags":["Certifications"],"description":"This API returns the status of a certification task. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity campaign certification ID"},{"in":"path","name":"taskId","schema":{"type":"string"},"required":true,"description":"The certification task ID"}],"responses":{"200":{"description":"A certification task object.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The task id","example":"abcd-ef12-3456"},"certificationId":{"type":"string","description":"The certification id","example":"ef38f94347e94562b5bb8424a56397d8"},"type":{"type":"string","enum":["REASSIGN"]},"status":{"type":"string","enum":["QUEUED","IN_PROGRESS","SUCCESS","ERROR"]},"errors":{"type":"array","items":{"type":"string"},"description":"Any errors executing the task (Optional).","example":[]}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/certifications/{id}/tasks/{taskId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Certification Task Status","description":{"content":"This API returns the status of a certification task. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.","type":"text/plain"},"url":{"path":["certifications",":id","tasks",":taskId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identity campaign certification ID","type":"text/plain"},"type":"any","value":"","key":"id"},{"disabled":false,"description":{"content":"(Required) The certification task ID","type":"text/plain"},"type":"any","value":"","key":"taskId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Certification Task Status' (get-identity-certification-task-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Certification Task Status + + + +This API returns the status of a certification task. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +
Path Parameters
+ +A certification task object. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-identity-outlier-snapshots.api.mdx b/products/idn/api/beta/get-identity-outlier-snapshots.api.mdx new file mode 100644 index 000000000..360bd9d01 --- /dev/null +++ b/products/idn/api/beta/get-identity-outlier-snapshots.api.mdx @@ -0,0 +1,84 @@ +--- +id: get-identity-outlier-snapshots +sidebar_label: IAI Identity Outliers Summary +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getIdentityOutlierSnapshots","tags":["IAI Outliers"],"description":"This API receives a summary containing: the number of identities that customer has, the number of outliers, and the type of outlier\nRequires authorization scope of 'iai:outliers-management:read'","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"name":"type","in":"query","description":"Type of the identity outliers snapshot to filter on","required":false,"schema":{"type":"string","enum":["LOW_SIMILARITY","STRUCTURAL"]}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following field and operators: \n**snapshotDate**: *ge, le*"},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\nSorting is supported for the following field: **snapshotDate**","example":"snapshotDate","required":false}],"responses":{"200":{"description":"Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers","headers":{"X-Total-Count":{"description":"The total result count.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["LOW_SIMILARITY","STRUCTURAL"],"description":"The type of outlier summary","example":"LOW_SIMILARITY"},"snapshotDate":{"type":"string","format":"date-time","description":"The date the bulk outlier detection ran/snapshot was created","example":"2021-05-01T18:40:35.772Z"},"totalOutliers":{"type":"integer","description":"Total number of outliers for the customer making the request","example":50},"totalIdentities":{"type":"integer","description":"Total number of identities for the customer making the request","example":5000}}}}}}},"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/outlier-summaries","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"IAI Identity Outliers Summary","description":{"content":"This API receives a summary containing: the number of identities that customer has, the number of outliers, and the type of outlier\nRequires authorization scope of 'iai:outliers-management:read'","type":"text/plain"},"url":{"path":["outlier-summaries"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Type of the identity outliers snapshot to filter on","type":"text/plain"},"key":"type","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following field and operators: \n**snapshotDate**: *ge, le*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\nSorting is supported for the following field: **snapshotDate**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'IAI Identity Outliers Summary' (get-identity-outlier-snapshots)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## IAI Identity Outliers Summary + + + +This API receives a summary containing: the number of identities that customer has, the number of outliers, and the type of outlier +Requires authorization scope of 'iai:outliers-management:read' + +
Query Parameters
+ +Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers + +
Response Headers
  • X-Total-Count integer
    + +The total result count. + +
Schema array
+ +Accepted - Returned if the request was successfully accepted into the system. + +
Schema
  • object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-identity-outliers.api.mdx b/products/idn/api/beta/get-identity-outliers.api.mdx new file mode 100644 index 000000000..8e91e42e5 --- /dev/null +++ b/products/idn/api/beta/get-identity-outliers.api.mdx @@ -0,0 +1,80 @@ +--- +id: get-identity-outliers +sidebar_label: IAI Get Identity Outliers +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getIdentityOutliers","tags":["IAI Outliers"],"description":"This API receives a list of outliers, containing data such as: identityId, outlier type, detection dates, identity attributes, if identity is ignore, and certification information\nRequires authorization scope of 'iai:outliers-management:read'","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"name":"type","in":"query","description":"Type of the identity outliers snapshot to filter on","required":false,"schema":{"type":"string","enum":["LOW_SIMILARITY","STRUCTURAL"],"example":"LOW_SIMILARITY"}},{"in":"query","name":"filters","required":false,"schema":{"type":"string","example":"attributes.displayName sw \"John\" and certStatus eq \"false\""},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following Entitlement fields and operators:\n**attributes**: *eq, sw, co, in*\n\n**firstDetectionDate**: *ge, le*\n\n**certStatus**: *eq*\n\n**ignored**: *eq*\n\n**score**: *ge, le*"},{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated","example":"attributes.displayName,firstDetectionDate,-score"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\nSorting is supported for the following fields: **firstDetectionDate, attributes, score**"}],"responses":{"200":{"description":"Succeeded. Returns list of objects. Each object contains information about outliers","headers":{"X-Total-Count":{"description":"The total result count.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The identity's unique identifier for the outlier record","example":"5be33d3e-c54d-4ed7-af73-2380543e8283"},"identityId":{"type":"string","description":"The ID of the identity that is detected as an outlier","example":"5be33d3e-c54d-4ed7-af73-2380543e8283"},"type":{"type":"string","enum":["LOW_SIMILARITY","STRUCTURAL"],"description":"The type of outlier summary","example":"LOW_SIMILARITY"},"firstDetectionDate":{"type":"string","format":"date-time","description":"The first date the outlier was detected","example":"2021-05-01T18:40:35.772Z"},"latestDetectionDate":{"type":"string","format":"date-time","description":"The most recent date the outlier was detected","example":"2021-05-03T18:40:35.772Z"},"ignored":{"type":"boolean","description":"Flag whether or not the outlier has been ignored","example":false},"attributes":{"type":"object","description":"Object containing mapped identity attributes","example":{"displayName":"John Smith","jobTitle":"Software Engineer","department":"Engineering"}},"score":{"type":"number","format":"float","description":"The outlier score determined by the detection engine ranging from 0..1","example":0.92},"unignoreType":{"type":"string","enum":["MANUAL","AUTOMATIC"],"description":"Enum value of if the outlier manually or automatically un-ignored. Will be NULL if outlier is not ignored","example":"MANUAL"},"unignoreDate":{"type":"string","format":"date-time","description":"shows date when last time has been unignored outlier","example":"2021-06-01T18:40:35.772Z"},"ignoreDate":{"type":"string","format":"date-time","description":"shows date when last time has been ignored outlier","example":"2021-06-01T18:40:35.772Z"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/outliers","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"IAI Get Identity Outliers","description":{"content":"This API receives a list of outliers, containing data such as: identityId, outlier type, detection dates, identity attributes, if identity is ignore, and certification information\nRequires authorization scope of 'iai:outliers-management:read'","type":"text/plain"},"url":{"path":["outliers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Type of the identity outliers snapshot to filter on","type":"text/plain"},"key":"type","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following Entitlement fields and operators:\n**attributes**: *eq, sw, co, in*\n\n**firstDetectionDate**: *ge, le*\n\n**certStatus**: *eq*\n\n**ignored**: *eq*\n\n**score**: *ge, le*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\nSorting is supported for the following fields: **firstDetectionDate, attributes, score**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'IAI Get Identity Outliers' (get-identity-outliers)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## IAI Get Identity Outliers + + + +This API receives a list of outliers, containing data such as: identityId, outlier type, detection dates, identity attributes, if identity is ignore, and certification information +Requires authorization scope of 'iai:outliers-management:read' + +
Query Parameters
+ +Succeeded. Returns list of objects. Each object contains information about outliers + +
Response Headers
  • X-Total-Count integer
    + +The total result count. + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-identity-password-change-status.api.mdx b/products/idn/api/beta/get-identity-password-change-status.api.mdx new file mode 100644 index 000000000..0aa419c64 --- /dev/null +++ b/products/idn/api/beta/get-identity-password-change-status.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-identity-password-change-status +sidebar_label: Get Password Change Request Status +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getIdentityPasswordChangeStatus","tags":["Password Management"],"description":"This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Status of the password change request","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","nullable":true,"description":"The password change request ID","example":"089899f13a8f4da7824996191587bab9"},"state":{"type":"string","enum":["IN_PROGRESS","FINISHED","FAILED"],"description":"Password change state"},"errors":{"type":"array","items":{"type":"string"},"description":"The errors during the password change request"},"sourceIds":{"type":"array","items":{"type":"string"},"description":"List of source IDs in the password change request"}}},"example":{"status":"IN_PROCESS","reqeustId":"089899f13a8f4da7824996191587bab9","error":null}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/password-change-status/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Password Change Request Status","description":{"content":"This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API.","type":"text/plain"},"url":{"path":["password-change-status",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Password Change Request Status' (get-identity-password-change-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Password Change Request Status + + + +This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API. + +
Path Parameters
+ +Status of the password change request + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-identity-profile.api.mdx b/products/idn/api/beta/get-identity-profile.api.mdx new file mode 100644 index 000000000..3be9e8e42 --- /dev/null +++ b/products/idn/api/beta/get-identity-profile.api.mdx @@ -0,0 +1,104 @@ +--- +id: get-identity-profile +sidebar_label: Gets a single Identity Profile +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getIdentityProfile","tags":["Identity Profiles"],"description":"This returns a single Identity Profile based on ID.\nA token with ORG_ADMIN or API authority is required to call this API.","parameters":[{"in":"path","name":"identity-profile-id","schema":{"type":"string","format":"uuid"},"required":true,"description":"The Identity Profile ID","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"An Identity Profile object","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"},"modified":{"description":"Last modification date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}},{"type":"object","required":["authoritativeSource"],"properties":{"description":{"type":"string","nullable":true,"description":"The description of the Identity Profile.","example":"My custom flat file profile"},"owner":{"type":"object","description":"The owner of the Identity Profile.","nullable":true,"properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Type of the object to which this reference applies","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"priority":{"type":"integer","format":"int64","description":"The priority for an Identity Profile.","example":10},"authoritativeSource":{"type":"object","properties":{"type":{"type":"string","enum":["SOURCE"],"description":"Type of the object to which this reference applies","example":"SOURCE"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"HR Active Directory"}},"description":"The authoritative source for this Identity Profile."},"identityRefreshRequired":{"type":"boolean","default":false,"description":"True if a identity refresh is needed. Typically triggered when a change on the source has been made","example":true},"identityCount":{"type":"integer","description":"The number of identities that belong to the Identity Profile.","format":"int32","example":8},"identityAttributeConfig":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If the profile or mapping is enabled","example":true,"default":true},"attributeTransforms":{"type":"array","items":{"type":"object","properties":{"identityAttributeName":{"type":"string","description":"Name of the identity attribute","example":"email"},"transformDefinition":{"description":"The seaspray transformation definition","type":"object","properties":{"type":{"type":"string","description":"The type of the transform definition.","example":"accountAttribute"},"attributes":{"type":"object","nullable":true,"additionalProperties":true,"description":"Arbitrary key-value pairs to store any metadata for the object","example":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}}}}}}}}},"identityExceptionReportReference":{"type":"object","nullable":true,"properties":{"taskResultId":{"type":"string","format":"uuid","description":"The id of the task result","example":"2c918086795cd09201795d5f7d7533df"},"reportName":{"type":"string","example":"My annual report","description":"The name of the report"}}},"hasTimeBasedAttr":{"description":"Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile.","type":"boolean","default":true,"example":true}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:identity-profile:read","idn:identity-profile:manage"]}],"method":"get","path":"/identity-profiles/{identity-profile-id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Gets a single Identity Profile","description":{"content":"This returns a single Identity Profile based on ID.\nA token with ORG_ADMIN or API authority is required to call this API.","type":"text/plain"},"url":{"path":["identity-profiles",":identity-profile-id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Identity Profile ID","type":"text/plain"},"type":"any","value":"","key":"identity-profile-id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Gets a single Identity Profile' (get-identity-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Gets a single Identity Profile + + + +This returns a single Identity Profile based on ID. +A token with ORG_ADMIN or API authority is required to call this API. + +
Path Parameters
+ +An Identity Profile object + +
Schema
    owner object
    + +The owner of the Identity Profile. + +
    authoritativeSource object
    + +The authoritative source for this Identity Profile. + +
    identityAttributeConfig object
    attributeTransforms object[]
    transformDefinition object
    + +The seaspray transformation definition + +
    attributes object
    + +Arbitrary key-value pairs to store any metadata for the object + +
    identityExceptionReportReference object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-identity-snapshot-summary.api.mdx b/products/idn/api/beta/get-identity-snapshot-summary.api.mdx new file mode 100644 index 000000000..f4203a761 --- /dev/null +++ b/products/idn/api/beta/get-identity-snapshot-summary.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-identity-snapshot-summary +sidebar_label: Gets the summary for the event count for a specific identity +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getIdentitySnapshotSummary","tags":["Identity History"],"description":"This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of 'idn:identity-history:read' ","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity id","example":"8c190e6787aa4ed9a90bd9d5344523fb"},{"in":"query","name":"before","schema":{"type":"string"},"description":"The date before which snapshot summary is required","example":"2007-03-01T13:00:00Z"},{"in":"query","name":"interval","schema":{"type":"string","enum":["day","month"]},"description":"The interval indicating day or month. Defaults to month if not specified"},{"in":"query","name":"time-zone","schema":{"type":"string"},"description":"The time zone. Defaults to UTC if not provided","example":"UTC"},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"A summary list of identity changes in date histogram format.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"the name of metric"},"value":{"type":"number","description":"the value associated to the metric"}},"example":{"name":"2021-04-01T00:00:00.000Z","value":2}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/historical-identities/{id}/snapshot-summary","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Gets the summary for the event count for a specific identity","description":{"content":"This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of 'idn:identity-history:read' ","type":"text/plain"},"url":{"path":["historical-identities",":id","snapshot-summary"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The date before which snapshot summary is required","type":"text/plain"},"key":"before","value":""},{"disabled":false,"description":{"content":"The interval indicating day or month. Defaults to month if not specified","type":"text/plain"},"key":"interval","value":""},{"disabled":false,"description":{"content":"The time zone. Defaults to UTC if not provided","type":"text/plain"},"key":"time-zone","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identity id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Gets the summary for the event count for a specific identity' (get-identity-snapshot-summary)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Gets the summary for the event count for a specific identity + + + +This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of 'idn:identity-history:read' + +
Path Parameters
Query Parameters
+ +A summary list of identity changes in date histogram format. + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-identity-snapshot.api.mdx b/products/idn/api/beta/get-identity-snapshot.api.mdx new file mode 100644 index 000000000..5d04f85f3 --- /dev/null +++ b/products/idn/api/beta/get-identity-snapshot.api.mdx @@ -0,0 +1,91 @@ +--- +id: get-identity-snapshot +sidebar_label: Gets an identity snapshot at a given date +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getIdentitySnapshot","tags":["Identity History"],"description":"This method retrieves a specified identity snapshot at a given date Requires authorization scope of 'idn:identity-history:read' ","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity id","example":"8c190e6787aa4ed9a90bd9d5344523fb"},{"in":"path","name":"date","schema":{"type":"string"},"description":"The specified date","example":"2007-03-01T13:00:00Z","required":true}],"responses":{"200":{"description":"The identity object.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"the identity ID","example":"bc693f07e7b645539626c25954c58554"},"displayName":{"type":"string","description":"the display name of the identity","example":"Adam Zampa"},"snapshot":{"type":"string","description":"the date when the identity record was created","example":"2007-03-01T13:00:00.000Z"},"deletedDate":{"type":"string","description":"the date when the identity was deleted","example":"2007-03-01T13:00:00.000Z"},"accessItemCount":{"type":"object","description":"A map containing the count of each access item","additionalProperties":{"type":"string"}},"attributes":{"type":"object","description":"A map containing the identity attributes","additionalProperties":{"type":"string"}}},"example":{"id":"2c9079b270a266a60170a2779fcb0007","displayName":"Lahoma Wuckert","deletedDate":null,"snapshot":"2007-03-01T13:00:00.000Z","attributes":{"jobTitle":"HR Manager","location":"NYC","firstname":"Lahoma","lastname":"Wuckert","department":"HR"},"accessItemCount":{"role":2,"accessProfile":2,"entitlement":28,"account":3}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/historical-identities/{id}/snapshots/{date}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Gets an identity snapshot at a given date","description":{"content":"This method retrieves a specified identity snapshot at a given date Requires authorization scope of 'idn:identity-history:read' ","type":"text/plain"},"url":{"path":["historical-identities",":id","snapshots",":date"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identity id","type":"text/plain"},"type":"any","value":"","key":"id"},{"disabled":false,"description":{"content":"(Required) The specified date","type":"text/plain"},"type":"any","value":"","key":"date"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Gets an identity snapshot at a given date' (get-identity-snapshot)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Gets an identity snapshot at a given date + + + +This method retrieves a specified identity snapshot at a given date Requires authorization scope of 'idn:identity-history:read' + +
Path Parameters
+ +The identity object. + +
Schema
    accessItemCount object
    + +A map containing the count of each access item + +
  • property name* string
    • attributes object
    + +A map containing the identity attributes + +
  • property name* string
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-identity-start-date.api.mdx b/products/idn/api/beta/get-identity-start-date.api.mdx new file mode 100644 index 000000000..1ce3fd925 --- /dev/null +++ b/products/idn/api/beta/get-identity-start-date.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-identity-start-date +sidebar_label: Gets the start date of the identity +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getIdentityStartDate","tags":["Identity History"],"description":"This method retrieves start date of the identity Requires authorization scope of 'idn:identity-history:read' ","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity id","example":"8c190e6787aa4ed9a90bd9d5344523fb"}],"responses":{"200":{"description":"The start date of the identity","content":{"application/json":{"schema":{"type":"string","example":"2017-03-01T13:00:00.000Z"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/historical-identities/{id}/start-date","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Gets the start date of the identity","description":{"content":"This method retrieves start date of the identity Requires authorization scope of 'idn:identity-history:read' ","type":"text/plain"},"url":{"path":["historical-identities",":id","start-date"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identity id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Gets the start date of the identity' (get-identity-start-date)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Gets the start date of the identity + + + +This method retrieves start date of the identity Requires authorization scope of 'idn:identity-history:read' + +
Path Parameters
+ +The start date of the identity + +
Schema
  • string
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-identity.api.mdx b/products/idn/api/beta/get-identity.api.mdx new file mode 100644 index 000000000..624573a91 --- /dev/null +++ b/products/idn/api/beta/get-identity.api.mdx @@ -0,0 +1,91 @@ +--- +id: get-identity +sidebar_label: Identity Details +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getIdentity","tags":["Identities"],"description":"This API returns a single identity using the Identity ID.","security":[{"oauth2":["idn:identity:read"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Identity Id","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"An identity object","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"},"modified":{"description":"Last modification date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}},{"type":"object","title":"IdentityDto","properties":{"alias":{"type":"string","description":"Alternate unique identifier for the identity","example":"walter.white"},"emailAddress":{"type":"string","description":"The email address of the identity","example":"sender@example.com"},"processingState":{"type":"string","nullable":true,"description":"The processing state of the identity","enum":["ERROR","OK"],"example":"ERROR"},"identityStatus":{"type":"string","description":"The identity's status in the system","enum":["UNREGISTERED","REGISTERED","PENDING","WARNING","DISABLED","ACTIVE","DEACTIVATED","TERMINATED","ERROR","LOCKED"],"example":"LOCKED"},"managerRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"isManager":{"type":"boolean","description":"Whether this identity is a manager of another identity","default":false,"example":true},"lastRefresh":{"type":"string","format":"date-time","description":"The last time the identity was refreshed by the system","example":"2020-11-22T15:42:31.123Z"},"attributes":{"type":"object","description":"A map with the identity attributes for the identity","example":"{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}"},"lifecycleState":{"description":"Lifecycle state details that include lifecycle state name and whether this lifecycle state has been set manually","type":"object","properties":{"stateName":{"type":"string","description":"The name of the lifecycle state","example":"active"},"manuallyUpdated":{"type":"boolean","description":"Whether the lifecycle state has been manually or automatically set","example":true}},"required":["stateName","manuallyUpdated"]}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/identities/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Identity Details","description":{"content":"This API returns a single identity using the Identity ID.","type":"text/plain"},"url":{"path":["identities",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Identity Id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Identity Details' (get-identity)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Identity Details + + + +This API returns a single identity using the Identity ID. + +
Path Parameters
+ +An identity object + +
Schema
    managerRef object
    lifecycleState object
    + +Lifecycle state details that include lifecycle state name and whether this lifecycle state has been set manually + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-latest-identity-outlier-snapshots.api.mdx b/products/idn/api/beta/get-latest-identity-outlier-snapshots.api.mdx new file mode 100644 index 000000000..45b37b3d7 --- /dev/null +++ b/products/idn/api/beta/get-latest-identity-outlier-snapshots.api.mdx @@ -0,0 +1,80 @@ +--- +id: get-latest-identity-outlier-snapshots +sidebar_label: IAI Identity Outliers Latest Summary +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getLatestIdentityOutlierSnapshots","tags":["IAI Outliers"],"description":"This API returns a most recent snapshot of each outlier type, each containing: the number of identities that customer has, the number of outliers, and the type of outlier\nRequires authorization scope of 'iai:outliers-management:read'","parameters":[{"name":"type","in":"query","description":"Type of the identity outliers snapshot to filter on","required":false,"schema":{"type":"string","enum":["LOW_SIMILARITY","STRUCTURAL"]}}],"responses":{"200":{"description":"Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["LOW_SIMILARITY","STRUCTURAL"],"description":"The type of outlier summary","example":"LOW_SIMILARITY"},"snapshotDate":{"type":"string","format":"date-time","description":"The date the bulk outlier detection ran/snapshot was created","example":"2021-05-01T18:40:35.772Z"},"totalOutliers":{"type":"integer","description":"Total number of outliers for the customer making the request","example":50},"totalIdentities":{"type":"integer","description":"Total number of identities for the customer making the request","example":5000},"totalIgnored":{"type":"integer","description":"Total number of ignored outliers","example":10}}}}}}},"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/outlier-summaries/latest","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"IAI Identity Outliers Latest Summary","description":{"content":"This API returns a most recent snapshot of each outlier type, each containing: the number of identities that customer has, the number of outliers, and the type of outlier\nRequires authorization scope of 'iai:outliers-management:read'","type":"text/plain"},"url":{"path":["outlier-summaries","latest"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Type of the identity outliers snapshot to filter on","type":"text/plain"},"key":"type","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'IAI Identity Outliers Latest Summary' (get-latest-identity-outlier-snapshots)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## IAI Identity Outliers Latest Summary + + + +This API returns a most recent snapshot of each outlier type, each containing: the number of identities that customer has, the number of outliers, and the type of outlier +Requires authorization scope of 'iai:outliers-management:read' + +
Query Parameters
+ +Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers + +
Schema array
+ +Accepted - Returned if the request was successfully accepted into the system. + +
Schema
  • object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-mail-from-attributes.api.mdx b/products/idn/api/beta/get-mail-from-attributes.api.mdx new file mode 100644 index 000000000..09bc88009 --- /dev/null +++ b/products/idn/api/beta/get-mail-from-attributes.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-mail-from-attributes +sidebar_label: Get MAIL FROM Attributes +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["sp:notification-mail-from-attributes:read"]}],"operationId":"getMailFromAttributes","tags":["Notifications"],"description":"Retrieve MAIL FROM attributes for a given AWS SES identity.","parameters":[{"in":"query","name":"id","required":true,"schema":{"type":"string"},"description":"Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status","example":"bobsmith@sailpoint.com"}],"responses":{"200":{"description":"MAIL FROM Attributes object","content":{"application/json":{"schema":{"type":"object","properties":{"identity":{"type":"string","example":"bob.smith@sailpoint.com","description":"The email identity"},"mailFromDomain":{"type":"string","example":"foo.sailpoint.com","description":"The name of a domain that an email identity uses as a custom MAIL FROM domain"},"mxRecord":{"type":"string","example":"10 feedback-smtp.us-east-1.amazonses.com","description":"MX record that is required in customer's DNS to allow the domain to receive bounce and complaint notifications that email providers send you"},"txtRecord":{"type":"string","example":"v=spf1 include:amazonses.com ~all","description":"TXT record that is required in customer's DNS in order to prove that Amazon SES is authorized to send email from your domain"},"mailFromDomainStatus":{"type":"string","enum":["PENDING","SUCCESS","FAILED"],"example":"PENDING","description":"The current status of the MAIL FROM verification"}},"description":"MAIL FROM attributes for a domain / identity"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/mail-from-attributes/{identity}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get MAIL FROM Attributes","description":{"content":"Retrieve MAIL FROM attributes for a given AWS SES identity.","type":"text/plain"},"url":{"path":["mail-from-attributes",":identity"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status","type":"text/plain"},"key":"id","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get MAIL FROM Attributes' (get-mail-from-attributes)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get MAIL FROM Attributes + + + +Retrieve MAIL FROM attributes for a given AWS SES identity. + +
Query Parameters
+ +MAIL FROM Attributes object + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-managed-client-status.api.mdx b/products/idn/api/beta/get-managed-client-status.api.mdx new file mode 100644 index 000000000..105afcd14 --- /dev/null +++ b/products/idn/api/beta/get-managed-client-status.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-managed-client-status +sidebar_label: Specified Managed Client Status. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Managed Clients"],"description":"Retrieve Managed Client Status by ID.","operationId":"getManagedClientStatus","parameters":[{"name":"id","in":"path","description":"ID of the Managed Client Status to get","required":true,"schema":{"type":"string","example":"aClientId"}},{"name":"type","in":"query","description":"Type of the Managed Client Status to get","required":true,"schema":{"example":"VA","description":"Managed Client type","type":"string","nullable":true,"enum":["CCG","VA","INTERNAL","IIQ_HARVESTER",null]}}],"responses":{"200":{"description":"Responds with Managed Client Status having the given ID and Type.","content":{"application/json":{"schema":{"description":"Managed Client Status","type":"object","required":["body","status","type","timestamp"],"properties":{"body":{"description":"ManagedClientStatus body information","type":"object","example":{"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":{"type":"string","enum":["NORMAL","UNDEFINED","NOT_CONFIGURED","CONFIGURING","WARNING","ERROR","FAILED"],"description":"status of the Managed Client"},"type":{"description":"type of the Managed Client","type":"string","example":"CCG","nullable":true,"enum":["CCG","VA","INTERNAL","IIQ_HARVESTER",null]},"timestamp":{"description":"timestamp on the Client Status update","type":"string","format":"date-time","example":"2020-01-01T00:00:00.000000Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:managed-client-status:read"]}],"method":"get","path":"/managed-clients/{id}/status","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Specified Managed Client Status.","description":{"content":"Retrieve Managed Client Status by ID.","type":"text/plain"},"url":{"path":["managed-clients",":id","status"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) Type of the Managed Client Status to get","type":"text/plain"},"key":"type","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Managed Client Status to get","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Specified Managed Client Status.' (get-managed-client-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Specified Managed Client Status. + + + +Retrieve Managed Client Status by ID. + +
Path Parameters
Query Parameters
+ +Responds with Managed Client Status having the given ID and Type. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-managed-cluster.api.mdx b/products/idn/api/beta/get-managed-cluster.api.mdx new file mode 100644 index 000000000..b59913d29 --- /dev/null +++ b/products/idn/api/beta/get-managed-cluster.api.mdx @@ -0,0 +1,119 @@ +--- +id: get-managed-cluster +sidebar_label: Get a specified ManagedCluster. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Managed Clusters"],"description":"Retrieve a ManagedCluster by ID.","operationId":"getManagedCluster","parameters":[{"name":"id","in":"path","description":"ID of the ManagedCluster to get","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"aClusterId"}}],"responses":{"200":{"description":"Responds with ManagedCluster having the given ID.","content":{"application/json":{"schema":{"description":"Managed Cluster","type":"object","required":["id","clientType","ccgVersion"],"properties":{"id":{"description":"ManagedCluster ID","type":"string","example":"aClusterId"},"name":{"description":"ManagedCluster name","type":"string","example":"Managed Cluster Name"},"pod":{"description":"ManagedCluster pod","type":"string","example":"megapod-useast1"},"org":{"description":"ManagedCluster org","type":"string","example":"denali"},"type":{"description":"The Type of Cluster","example":"idn","nullable":false,"type":"string","enum":["idn","iai"]},"configuration":{"description":"ManagedProcess configuration map","type":"object","additionalProperties":{"type":"string"},"example":{"clusterExternalId":"externalId","ccgVersion":"77.0.0"}},"keyPair":{"description":"key pair for the ManagedCluster","type":"object","properties":{"publicKey":{"nullable":true,"description":"ManagedCluster publicKey","type":"string","example":"-----BEGIN PUBLIC KEY-----******-----END PUBLIC KEY-----"},"publicKeyThumbprint":{"nullable":true,"description":"ManagedCluster publicKeyThumbprint","type":"string","example":"6CMlaJIV44-xJxcB3CJBjDUUn54"},"publicKeyCertificate":{"nullable":true,"description":"ManagedCluster publicKeyCertificate","type":"string","example":"-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----"}}},"attributes":{"description":"Specific Attributes for Configuring a ManagedCluster by Type","type":"object","properties":{"queue":{"description":"ManagedCluster keystore for sqsCluster type","type":"object","properties":{"name":{"description":"ManagedCluster queue name","type":"string","example":"megapod-useast1-denali-lwt-cluster-1533"},"region":{"description":"ManagedCluster queue aws region","type":"string","example":"us-east-1"}}},"keystore":{"nullable":true,"description":"ManagedCluster keystore for spConnectCluster type","type":"string","example":"/u3+7QAAAAIAAAABAAAAAQAvL3Byb3h5LWNsdXN0ZXIvMmM5MTgwODc3Yjg3MW"}}},"description":{"description":"ManagedCluster description","type":"string","example":"A short description of the managed cluster."},"redis":{"description":"Redis configuration for the ManagedCluster","type":"object","properties":{"redisHost":{"description":"ManagedCluster redisHost","type":"string","example":"megapod-useast1-shared-redis.cloud.sailpoint.com"},"redisPort":{"description":"ManagedCluster redisPort","type":"integer","format":"int32","example":6379}}},"clientType":{"description":"type of client for the ManagedCluster","type":"string","example":"CCG","nullable":true,"enum":["CCG","VA","INTERNAL","IIQ_HARVESTER",null]},"ccgVersion":{"description":"CCG version used by the ManagedCluster","type":"string","example":"v01"},"pinnedConfig":{"description":"boolean flag indiacting whether or not the cluster configuration is pinned","type":"boolean","default":false,"example":false},"logConfiguration":{"description":"client log configuration for the cluster","example":"{ \"rootLevel\": \"WARN\", \"logLevels\": { \"foobar\": \"WARN\" } }","nullable":true,"type":"object","required":["durationMinutes","rootLevel"],"properties":{"clientId":{"description":"Log configuration's client ID","type":"string","example":"aClientId"},"durationMinutes":{"description":"Duration in minutes for log configuration to remain in effect before resetting to defaults","type":"integer","format":"int32","example":120,"minimum":5,"maximum":1440},"expiration":{"description":"Expiration date-time of the log configuration request","example":"2020-12-15T19:13:36.079Z","type":"string","format":"date-time"},"rootLevel":{"description":"Root log level to apply, the default level for all logs. For more information about logging levels, refer to the \"Logging Levels\" table in [Enabling Connector Logging in IdentityNow](https://community.sailpoint.com/t5/IdentityNow-Articles/Enabling-Connector-Logging-in-IdentityNow/ta-p/188107).","default":"INFO","example":"TRACE","type":"string","enum":["OFF","FATAL","ERROR","WARN","INFO","DEBUG","TRACE"]},"logLevels":{"description":"Map of log level by key. The keys are logging classes, and the values are logging levels. To see the available connectors and their logging classes, refer to the \"Logging Classes\" table in [Enabling Connector Logging in IdentityNow](https://community.sailpoint.com/t5/IdentityNow-Articles/Enabling-Connector-Logging-in-IdentityNow/ta-p/188107).","example":{"sailpoint.connector.ADLDAPConnector":"TRACE"},"type":"object","additionalProperties":{"default":"INFO","example":"TRACE","description":"Standard Log4j log level","type":"string","enum":["OFF","FATAL","ERROR","WARN","INFO","DEBUG","TRACE"]}}}},"operational":{"description":"Whether or not the cluster is operational or not","type":"boolean","default":false,"example":false},"status":{"description":"Cluster status","type":"string","example":"NORMAL"},"publicKeyCertificate":{"nullable":true,"description":"Public key certificate","type":"string","example":"-----BEGIN CERTIFICATE-----TCCAb2gAwIBAgIBADANBgkqhkiG9w0BAQsFADAuMQ0wCwYDVQQD-----END CERTIFICATE-----"},"publicKeyThumbprint":{"nullable":true,"description":"Public key thumbprint","type":"string","example":"obc6pLiulGbtZ"},"publicKey":{"nullable":true,"description":"Public key","type":"string","example":"-----BEGIN PUBLIC KEY-----jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3WgnsxP52MDgBTfHR+5n4-----END PUBLIC KEY-----"},"alertKey":{"description":"Key describing any immediate cluster alerts","type":"string","example":"LIMITED_RESOURCES"},"clientIds":{"type":"array","description":"List of clients in a cluster","items":{"type":"string"},"example":["1244","1245"]},"serviceCount":{"description":"Number of services bound to a cluster","type":"integer","format":"int32","default":0,"example":6},"ccId":{"description":"CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished","type":"string","default":"0","example":"1533"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:remote-client:read","idn:remote-client:manage"]}],"method":"get","path":"/managed-clusters/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get a specified ManagedCluster.","description":{"content":"Retrieve a ManagedCluster by ID.","type":"text/plain"},"url":{"path":["managed-clusters",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the ManagedCluster to get","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a specified ManagedCluster.' (get-managed-cluster)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a specified ManagedCluster. + + + +Retrieve a ManagedCluster by ID. + +
Path Parameters
+ +Responds with ManagedCluster having the given ID. + +
Schema
    configuration object
    + +ManagedProcess configuration map + +
  • property name* string
    • keyPair object
    + +key pair for the ManagedCluster + +
    attributes object
    + +Specific Attributes for Configuring a ManagedCluster by Type + +
    queue object
    + +ManagedCluster keystore for sqsCluster type + +
    redis object
    + +Redis configuration for the ManagedCluster + +
    logConfiguration object
    + +client log configuration for the cluster + +
    = 5` and `<= 1440`"} defaultValue={undefined}>
    logLevels object
    + +Map of log level by key. The keys are logging classes, and the values are logging levels. To see the available connectors and their logging classes, refer to the "Logging Classes" table in [Enabling Connector Logging in IdentityNow](https://community.sailpoint.com/t5/IdentityNow-Articles/Enabling-Connector-Logging-in-IdentityNow/ta-p/188107). + +
  • property name* string
    + +**Possible values:** [`OFF`, `FATAL`, `ERROR`, `WARN`, `INFO`, `DEBUG`, `TRACE`] + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-managed-clusters.api.mdx b/products/idn/api/beta/get-managed-clusters.api.mdx new file mode 100644 index 000000000..69da4d5be --- /dev/null +++ b/products/idn/api/beta/get-managed-clusters.api.mdx @@ -0,0 +1,107 @@ +--- +id: get-managed-clusters +sidebar_label: Retrieve all Managed Clusters. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Managed Clusters"],"description":"Retrieve all Managed Clusters for the current Org, based on request context.","operationId":"getManagedClusters","parameters":[{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filtering is supported for the following fields and operators:\n\n**operational**: *eq*","example":"operational eq operation"}],"responses":{"200":{"description":"Responds with a list of ManagedCluster.","content":{"application/json":{"schema":{"type":"array","items":{"description":"Managed Cluster","type":"object","required":["id","clientType","ccgVersion"],"properties":{"id":{"description":"ManagedCluster ID","type":"string","example":"aClusterId"},"name":{"description":"ManagedCluster name","type":"string","example":"Managed Cluster Name"},"pod":{"description":"ManagedCluster pod","type":"string","example":"megapod-useast1"},"org":{"description":"ManagedCluster org","type":"string","example":"denali"},"type":{"description":"The Type of Cluster","example":"idn","nullable":false,"type":"string","enum":["idn","iai"]},"configuration":{"description":"ManagedProcess configuration map","type":"object","additionalProperties":{"type":"string"},"example":{"clusterExternalId":"externalId","ccgVersion":"77.0.0"}},"keyPair":{"description":"key pair for the ManagedCluster","type":"object","properties":{"publicKey":{"nullable":true,"description":"ManagedCluster publicKey","type":"string","example":"-----BEGIN PUBLIC KEY-----******-----END PUBLIC KEY-----"},"publicKeyThumbprint":{"nullable":true,"description":"ManagedCluster publicKeyThumbprint","type":"string","example":"6CMlaJIV44-xJxcB3CJBjDUUn54"},"publicKeyCertificate":{"nullable":true,"description":"ManagedCluster publicKeyCertificate","type":"string","example":"-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----"}}},"attributes":{"description":"Specific Attributes for Configuring a ManagedCluster by Type","type":"object","properties":{"queue":{"description":"ManagedCluster keystore for sqsCluster type","type":"object","properties":{"name":{"description":"ManagedCluster queue name","type":"string","example":"megapod-useast1-denali-lwt-cluster-1533"},"region":{"description":"ManagedCluster queue aws region","type":"string","example":"us-east-1"}}},"keystore":{"nullable":true,"description":"ManagedCluster keystore for spConnectCluster type","type":"string","example":"/u3+7QAAAAIAAAABAAAAAQAvL3Byb3h5LWNsdXN0ZXIvMmM5MTgwODc3Yjg3MW"}}},"description":{"description":"ManagedCluster description","type":"string","example":"A short description of the managed cluster."},"redis":{"description":"Redis configuration for the ManagedCluster","type":"object","properties":{"redisHost":{"description":"ManagedCluster redisHost","type":"string","example":"megapod-useast1-shared-redis.cloud.sailpoint.com"},"redisPort":{"description":"ManagedCluster redisPort","type":"integer","format":"int32","example":6379}}},"clientType":{"description":"type of client for the ManagedCluster","type":"string","example":"CCG","nullable":true,"enum":["CCG","VA","INTERNAL","IIQ_HARVESTER",null]},"ccgVersion":{"description":"CCG version used by the ManagedCluster","type":"string","example":"v01"},"pinnedConfig":{"description":"boolean flag indiacting whether or not the cluster configuration is pinned","type":"boolean","default":false,"example":false},"logConfiguration":{"description":"client log configuration for the cluster","example":"{ \"rootLevel\": \"WARN\", \"logLevels\": { \"foobar\": \"WARN\" } }","nullable":true,"type":"object","required":["durationMinutes","rootLevel"],"properties":{"clientId":{"description":"Log configuration's client ID","type":"string","example":"aClientId"},"durationMinutes":{"description":"Duration in minutes for log configuration to remain in effect before resetting to defaults","type":"integer","format":"int32","example":120,"minimum":5,"maximum":1440},"expiration":{"description":"Expiration date-time of the log configuration request","example":"2020-12-15T19:13:36.079Z","type":"string","format":"date-time"},"rootLevel":{"description":"Root log level to apply, the default level for all logs. For more information about logging levels, refer to the \"Logging Levels\" table in [Enabling Connector Logging in IdentityNow](https://community.sailpoint.com/t5/IdentityNow-Articles/Enabling-Connector-Logging-in-IdentityNow/ta-p/188107).","default":"INFO","example":"TRACE","type":"string","enum":["OFF","FATAL","ERROR","WARN","INFO","DEBUG","TRACE"]},"logLevels":{"description":"Map of log level by key. The keys are logging classes, and the values are logging levels. To see the available connectors and their logging classes, refer to the \"Logging Classes\" table in [Enabling Connector Logging in IdentityNow](https://community.sailpoint.com/t5/IdentityNow-Articles/Enabling-Connector-Logging-in-IdentityNow/ta-p/188107).","example":{"sailpoint.connector.ADLDAPConnector":"TRACE"},"type":"object","additionalProperties":{"default":"INFO","example":"TRACE","description":"Standard Log4j log level","type":"string","enum":["OFF","FATAL","ERROR","WARN","INFO","DEBUG","TRACE"]}}}},"operational":{"description":"Whether or not the cluster is operational or not","type":"boolean","default":false,"example":false},"status":{"description":"Cluster status","type":"string","example":"NORMAL"},"publicKeyCertificate":{"nullable":true,"description":"Public key certificate","type":"string","example":"-----BEGIN CERTIFICATE-----TCCAb2gAwIBAgIBADANBgkqhkiG9w0BAQsFADAuMQ0wCwYDVQQD-----END CERTIFICATE-----"},"publicKeyThumbprint":{"nullable":true,"description":"Public key thumbprint","type":"string","example":"obc6pLiulGbtZ"},"publicKey":{"nullable":true,"description":"Public key","type":"string","example":"-----BEGIN PUBLIC KEY-----jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3WgnsxP52MDgBTfHR+5n4-----END PUBLIC KEY-----"},"alertKey":{"description":"Key describing any immediate cluster alerts","type":"string","example":"LIMITED_RESOURCES"},"clientIds":{"type":"array","description":"List of clients in a cluster","items":{"type":"string"},"example":["1244","1245"]},"serviceCount":{"description":"Number of services bound to a cluster","type":"integer","format":"int32","default":0,"example":6},"ccId":{"description":"CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished","type":"string","default":"0","example":"1533"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:remote-client:read","idn:remote-client:manage"]}],"method":"get","path":"/managed-clusters","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Retrieve all Managed Clusters.","description":{"content":"Retrieve all Managed Clusters for the current Org, based on request context.","type":"text/plain"},"url":{"path":["managed-clusters"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filtering is supported for the following fields and operators:\n\n**operational**: *eq*","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Retrieve all Managed Clusters.' (get-managed-clusters)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieve all Managed Clusters. + + + +Retrieve all Managed Clusters for the current Org, based on request context. + +
Query Parameters
+ +Responds with a list of ManagedCluster. + +
Schema array
    configuration object
    + +ManagedProcess configuration map + +
  • property name* string
    • keyPair object
    + +key pair for the ManagedCluster + +
    attributes object
    + +Specific Attributes for Configuring a ManagedCluster by Type + +
    queue object
    + +ManagedCluster keystore for sqsCluster type + +
    redis object
    + +Redis configuration for the ManagedCluster + +
    logConfiguration object
    + +client log configuration for the cluster + +
    = 5` and `<= 1440`"} defaultValue={undefined}>
    logLevels object
    + +Map of log level by key. The keys are logging classes, and the values are logging levels. To see the available connectors and their logging classes, refer to the "Logging Classes" table in [Enabling Connector Logging in IdentityNow](https://community.sailpoint.com/t5/IdentityNow-Articles/Enabling-Connector-Logging-in-IdentityNow/ta-p/188107). + +
  • property name* string
    + +**Possible values:** [`OFF`, `FATAL`, `ERROR`, `WARN`, `INFO`, `DEBUG`, `TRACE`] + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-message-catalogs.api.mdx b/products/idn/api/beta/get-message-catalogs.api.mdx new file mode 100644 index 000000000..af9a78213 --- /dev/null +++ b/products/idn/api/beta/get-message-catalogs.api.mdx @@ -0,0 +1,79 @@ +--- +id: get-message-catalogs +sidebar_label: Get Message catalogs +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getMessageCatalogs","tags":["IAI Recommendations","IAI Access Request Recommendations"],"description":"The getMessageCatalogs API returns message catalog based on the language headers in the requested object.","parameters":[{"in":"path","name":"catalog-id","schema":{"type":"string","enum":["recommender","access-request-recommender"]},"required":true,"description":"The ID of the message catalog."}],"responses":{"200":{"description":"The message catalogs based on the request headers","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The language in which the messages are returned","example":"en_US"},"messages":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"The key of the message","example":"recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_LOW"},"format":{"type":"string","description":"The format of the message","example":"{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."}}},"description":"The list of message with their keys and formats"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":[]}],"method":"get","path":"/translation-catalogs/{catalog-id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Message catalogs","description":{"content":"The getMessageCatalogs API returns message catalog based on the language headers in the requested object.","type":"text/plain"},"url":{"path":["translation-catalogs",":catalog-id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the message catalog.","type":"text/plain"},"type":"any","value":"","key":"catalog-id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Message catalogs' (get-message-catalogs)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Message catalogs + + + +The getMessageCatalogs API returns message catalog based on the language headers in the requested object. + +
Path Parameters
+ +The message catalogs based on the request headers + +
Schema array
    messages object[]
    + +The list of message with their keys and formats + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-mfa-config.api.mdx b/products/idn/api/beta/get-mfa-config.api.mdx new file mode 100644 index 000000000..c92ac6827 --- /dev/null +++ b/products/idn/api/beta/get-mfa-config.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-mfa-config +sidebar_label: Configuration of a MFA method +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getMFAConfig","tags":["MFA Configuration"],"description":"This API returns the configuration of a given MFA method. A token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:mfa-configuration:read","idn:mfa-configuration:manage"]}],"parameters":[{"in":"path","name":"method","schema":{"type":"string","example":"okta-verify"},"required":true,"description":"The name of the MFA method. The currently supported method name is okta-verify."}],"responses":{"200":{"description":"MFA configuration of a given method.","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If MFA method is enabled."},"host":{"type":"string","description":"The server host name or IP address of the MFA provider.","example":"example.com"},"accessKey":{"type":"string","description":"The secret key for authenticating requests to the MFA provider."},"identityAttribute":{"type":"string","description":"Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider.","example":"email"}}},"example":{"enabled":true,"host":"www.example.com","accessKey":"dk778Y3QlA5UqocYpdU3rEkzrK2D497y","identityAttribute":"email"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/mfa/{method}/config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Configuration of a MFA method","description":{"content":"This API returns the configuration of a given MFA method. A token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["mfa",":method","config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The name of the MFA method. The currently supported method name is okta-verify.","type":"text/plain"},"type":"any","value":"","key":"method"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Configuration of a MFA method' (get-mfa-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Configuration of a MFA method + + + +This API returns the configuration of a given MFA method. A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
+ +MFA configuration of a given method. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-non-employee-approval-summary.api.mdx b/products/idn/api/beta/get-non-employee-approval-summary.api.mdx new file mode 100644 index 000000000..12cd6c852 --- /dev/null +++ b/products/idn/api/beta/get-non-employee-approval-summary.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-non-employee-approval-summary +sidebar_label: Get Summary of Non-Employee Approval Requests +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getNonEmployeeApprovalSummary","security":[{"oauth2":["idn:nelm:read"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her.","parameters":[{"in":"path","example":"ac10d20a-841e-1e7d-8184-32d2e22c0179","name":"requested-for","schema":{"type":"string"},"description":"The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user.","required":true}],"responses":{"200":{"description":"summary of non-employee approval requests","content":{"application/json":{"schema":{"type":"object","properties":{"approved":{"type":"number","description":"The number of approved non-employee approval requests."},"pending":{"type":"number","description":"The number of pending non-employee approval requests."},"rejected":{"type":"number","description":"The number of rejected non-employee approval requests."}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-approvals/summary/{requested-for}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Summary of Non-Employee Approval Requests","description":{"content":"This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her.","type":"text/plain"},"url":{"path":["non-employee-approvals","summary",":requested-for"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user.","type":"text/plain"},"type":"any","value":"","key":"requested-for"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Summary of Non-Employee Approval Requests' (get-non-employee-approval-summary)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Summary of Non-Employee Approval Requests + + + +This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. 2. The current user is an approver, in which case "me" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. + +
Path Parameters
+ +summary of non-employee approval requests + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-non-employee-approval.api.mdx b/products/idn/api/beta/get-non-employee-approval.api.mdx new file mode 100644 index 000000000..c74764300 --- /dev/null +++ b/products/idn/api/beta/get-non-employee-approval.api.mdx @@ -0,0 +1,91 @@ +--- +id: get-non-employee-approval +sidebar_label: Get a non-employee approval item detail +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getNonEmployeeApproval","security":[{"oauth2":["idn:nelm:read"]}],"tags":["Non-Employee Lifecycle Management"],"description":"Approves a non-employee approval request and notifies the next approver.","parameters":[{"in":"path","name":"id","example":"ac10d20a-841e-1e7d-8184-32d2e22c0179","description":"Non-Employee approval item id (UUID)","required":true,"schema":{"type":"string"}},{"in":"query","example":"include-detail=false","name":"include-detail","description":"The object nonEmployeeRequest will not be included detail when set to false. *Default value is true*","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Non-Employee approval item object.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee approval item id","example":"2c1e388b-1e55-4b0a-ab5c-897f1204159c"},"approver":{"description":"Reference to the associated Identity","type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}},"accountName":{"type":"string","description":"Requested identity account name","example":"test.account"},"approvalStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status"},"approvalOrder":{"type":"number","description":"Approval order","example":1},"comment":{"type":"string","description":"comment of approver"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}},{"type":"object","properties":{"nonEmployeeRequest":{"description":"Non-Employee request associated to this approval","allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee request id."},"requester":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}},"example":{"type":"IDENTITY","id":"2c9180866166b5b0016167c32ef31a66","name":"William Smith"}}}},{"type":"object","properties":{"accountName":{"type":"string","description":"Requested identity account name.","example":"william.smith"},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"nonEmployeeSource":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"},"sourceId":{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"},"description":{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}},{"type":"object","properties":{"schemaAttributes":{"description":"List of schema attributes associated with this non-employee source.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"UUID","example":"ac110005-7156-1150-8171-5b292e3e0084","description":"Schema Attribute Id"},"system":{"type":"boolean","description":"True if this schema attribute is mandatory on all non-employees sources.","example":true},"modified":{"type":"string","format":"date-time","description":"When the schema attribute was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the schema attribute was created.","example":"2019-08-23T18:40:35.772Z"},"type":{"type":"string","enum":["TEXT","DATE","IDENTITY"],"description":"Enum representing the type of data a schema attribute accepts."},"label":{"type":"string","description":"Label displayed on the UI for this schema attribute.","example":"Account Name"},"technicalName":{"type":"string","description":"The technical name of the attribute. Must be unique per source.","example":"account.name"},"helpText":{"type":"string","description":"help text displayed by UI.","example":"The unique identifier for the account"},"placeholder":{"type":"string","description":"Hint text that fills UI box.","example":"Enter a unique user name for this account."},"required":{"type":"boolean","description":"If true, the schema attribute is required for all non-employees in the source","example":true}},"required":["type","technicalName","label"]}}}}]},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee."},"approvalStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status"},"comment":{"type":"string","description":"comment of requester"},"completionDate":{"type":"string","format":"date-time","description":"When the request was completely approved.","example":"2020-03-24T11:11:41.139-05:00"},"startDate":{"type":"string","format":"date","description":"Non-Employee employment start date.","example":"2020-03-24"},"endDate":{"type":"string","format":"date","description":"Non-Employee employment end date.","example":"2021-03-25"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2020-03-24T11:11:41.139-05:00"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2020-03-24T11:11:41.139-05:00"}}}]}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-approvals/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get a non-employee approval item detail","description":{"content":"Approves a non-employee approval request and notifies the next approver.","type":"text/plain"},"url":{"path":["non-employee-approvals",":id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The object nonEmployeeRequest will not be included detail when set to false. *Default value is true*","type":"text/plain"},"key":"include-detail","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Non-Employee approval item id (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a non-employee approval item detail' (get-non-employee-approval)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a non-employee approval item detail + + + +Approves a non-employee approval request and notifies the next approver. + +
Path Parameters
Query Parameters
+ +Non-Employee approval item object. + +
Schema
    approver object
    + +Reference to the associated Identity + +
    nonEmployeeRequest object
    + +Non-Employee request associated to this approval + +
    requester object
    nonEmployeeSource object
    schemaAttributes object[]
    + +List of schema attributes associated with this non-employee source. + +
    data object
    + +Attribute blob/bag for a non-employee. + +
  • property name* string
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-non-employee-bulk-upload-status.api.mdx b/products/idn/api/beta/get-non-employee-bulk-upload-status.api.mdx new file mode 100644 index 000000000..6d83bdfb1 --- /dev/null +++ b/products/idn/api/beta/get-non-employee-bulk-upload-status.api.mdx @@ -0,0 +1,76 @@ +--- +id: get-non-employee-bulk-upload-status +sidebar_label: Bulk upload status on source +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getNonEmployeeBulkUploadStatus","security":[{"oauth2":["idn:nelm:read"]}],"tags":["Non-Employee Lifecycle Management"],"description":"The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source.\n","parameters":[{"in":"path","example":"2c918085842e69ae018432d22ccb212f","name":"id","description":"Source ID (UUID)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Status of the newest bulk-upload job, if any.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["PENDING","IN_PROGRESS","COMPLETED","ERROR"],"description":"Returns the following values indicating the progress or result of the bulk upload job.\n\"PENDING\" means the job is queued and waiting to be processed.\n\"IN_PROGRESS\" means the job is currently being processed.\n\"COMPLETED\" means the job has been completed without any errors.\n\"ERROR\" means the job failed to process with errors.\nnull means job has been submitted to the source.\n","example":"PENDING"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-sources/{id}/non-employee-bulk-upload/status","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Bulk upload status on source","description":{"content":"The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source.\n","type":"text/plain"},"url":{"path":["non-employee-sources",":id","non-employee-bulk-upload","status"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Source ID (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Bulk upload status on source' (get-non-employee-bulk-upload-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Bulk upload status on source + + + +The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. + + +
Path Parameters
+ +Status of the newest bulk-upload job, if any. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-non-employee-record.api.mdx b/products/idn/api/beta/get-non-employee-record.api.mdx new file mode 100644 index 000000000..7baba3f48 --- /dev/null +++ b/products/idn/api/beta/get-non-employee-record.api.mdx @@ -0,0 +1,79 @@ +--- +id: get-non-employee-record +sidebar_label: Get a Non-Employee Record +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getNonEmployeeRecord","security":[{"oauth2":["idn:nelm:read"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This gets a non-employee record.","parameters":[{"in":"path","name":"id","description":"Non-Employee record id (UUID)","required":true,"example":"2c91808b6ef1d43e016efba0ce470904","schema":{"type":"string"}}],"responses":{"200":{"description":"Non-Employee record object","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee record id."},"accountName":{"type":"string","description":"Requested identity account name."},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"sourceId":{"type":"string","description":"Non-Employee's source id.","example":"2c91808568c529c60168cca6f90c1313"},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee."},"startDate":{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2019-08-23T18:52:59.162Z"},"endDate":{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2020-08-23T18:52:59.162Z"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-records/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get a Non-Employee Record","description":{"content":"This gets a non-employee record.","type":"text/plain"},"url":{"path":["non-employee-records",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Non-Employee record id (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a Non-Employee Record' (get-non-employee-record)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a Non-Employee Record + + + +This gets a non-employee record. + +
Path Parameters
+ +Non-Employee record object + +
Schema
    data object
    + +Attribute blob/bag for a non-employee. + +
  • property name* string
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-non-employee-request-summary.api.mdx b/products/idn/api/beta/get-non-employee-request-summary.api.mdx new file mode 100644 index 000000000..9d66c6b53 --- /dev/null +++ b/products/idn/api/beta/get-non-employee-request-summary.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-non-employee-request-summary +sidebar_label: Get Summary of Non-Employee Requests +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getNonEmployeeRequestSummary","security":[{"oauth2":["idn:nelm:read"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages.","parameters":[{"in":"path","example":"ac10d20a-841e-1e7d-8184-32d2e22c0179","name":"requested-for","description":"The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user.","required":true,"schema":{"type":"string","format":"uuid (if user is Org Admin)"}}],"responses":{"200":{"description":"Non-Employee request summary object.","content":{"application/json":{"schema":{"type":"object","properties":{"approved":{"type":"number","description":"The number of approved non-employee requests on all sources that *requested-for* user manages."},"rejected":{"type":"number","description":"The number of rejected non-employee requests on all sources that *requested-for* user manages."},"pending":{"type":"number","description":"The number of pending non-employee requests on all sources that *requested-for* user manages."},"nonEmployeeCount":{"type":"number","description":"The number of non-employee records on all sources that *requested-for* user manages."}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-requests/summary/{requested-for}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Summary of Non-Employee Requests","description":{"content":"This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages.","type":"text/plain"},"url":{"path":["non-employee-requests","summary",":requested-for"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user.","type":"text/plain"},"type":"any","value":"","key":"requested-for"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Summary of Non-Employee Requests' (get-non-employee-request-summary)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Summary of Non-Employee Requests + + + +This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. 2. The current user is an account manager, in which case "me" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. + +
Path Parameters
+ +Non-Employee request summary object. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-non-employee-request.api.mdx b/products/idn/api/beta/get-non-employee-request.api.mdx new file mode 100644 index 000000000..eecc2fa3c --- /dev/null +++ b/products/idn/api/beta/get-non-employee-request.api.mdx @@ -0,0 +1,99 @@ +--- +id: get-non-employee-request +sidebar_label: Get a Non-Employee Request +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getNonEmployeeRequest","security":[{"oauth2":["idn:nelm:read"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This gets a non-employee request.","parameters":[{"in":"path","name":"id","example":"2c91808b6ef1d43e016efba0ce470904","description":"Non-Employee request id (UUID)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Non-Employee request object.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"},"sourceId":{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"},"description":{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}},{"type":"object","properties":{"accountName":{"type":"string","description":"Requested identity account name.","example":"william.smith"},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"nonEmployeeSource":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"},"sourceId":{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"},"description":{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee."},"approvalItems":{"description":"List of approval item for the request","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee approval item id","example":"2c1e388b-1e55-4b0a-ab5c-897f1204159c"},"approver":{"description":"Reference to the associated Identity","type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}},"accountName":{"type":"string","description":"Requested identity account name","example":"test.account"},"approvalStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status"},"approvalOrder":{"type":"number","description":"Approval order","example":1},"comment":{"type":"string","description":"comment of approver"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}}},"approvalStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status"},"comment":{"type":"string","description":"comment of requester"},"completionDate":{"type":"string","format":"date-time","description":"When the request was completely approved.","example":"2020-03-24T11:11:41.139-05:00"},"startDate":{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2020-03-24T00:00:00-05:00"},"endDate":{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2021-03-25T00:00:00-05:00"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2020-03-24T11:11:41.139-05:00"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2020-03-24T11:11:41.139-05:00"}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-requests/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get a Non-Employee Request","description":{"content":"This gets a non-employee request.","type":"text/plain"},"url":{"path":["non-employee-requests",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Non-Employee request id (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a Non-Employee Request' (get-non-employee-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a Non-Employee Request + + + +This gets a non-employee request. + +
Path Parameters
+ +Non-Employee request object. + +
Schema
    nonEmployeeSource object
    data object
    + +Attribute blob/bag for a non-employee. + +
  • property name* string
    • approvalItems object[]
    + +List of approval item for the request + +
    approver object
    + +Reference to the associated Identity + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-non-employee-schema-attribute.api.mdx b/products/idn/api/beta/get-non-employee-schema-attribute.api.mdx new file mode 100644 index 000000000..8fdada009 --- /dev/null +++ b/products/idn/api/beta/get-non-employee-schema-attribute.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-non-employee-schema-attribute +sidebar_label: Get Schema Attribute Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getNonEmployeeSchemaAttribute","security":[{"oauth2":["idn:nelm:read"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This API gets a schema attribute by Id for the specified Non-Employee SourceId.","parameters":[{"in":"path","example":"2c918085842e69ae018432d22ccb212f","name":"attributeId","schema":{"type":"string"},"required":true,"description":"The Schema Attribute Id (UUID)"},{"in":"path","example":"2c918085842e69ae018432d22ccb212f","name":"sourceId","schema":{"type":"string"},"required":true,"description":"The Source id"}],"responses":{"200":{"description":"The Schema Attribute","content":{"application/json":{"example":"id,system,modified,created,type,label,technicalName,helpText,placeholder,required\n","schema":{"type":"object","properties":{"id":{"type":"string","format":"UUID","example":"ac110005-7156-1150-8171-5b292e3e0084","description":"Schema Attribute Id"},"system":{"type":"boolean","description":"True if this schema attribute is mandatory on all non-employees sources.","example":true},"modified":{"type":"string","format":"date-time","description":"When the schema attribute was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the schema attribute was created.","example":"2019-08-23T18:40:35.772Z"},"type":{"type":"string","enum":["TEXT","DATE","IDENTITY"],"description":"Enum representing the type of data a schema attribute accepts."},"label":{"type":"string","description":"Label displayed on the UI for this schema attribute.","example":"Account Name"},"technicalName":{"type":"string","description":"The technical name of the attribute. Must be unique per source.","example":"account.name"},"helpText":{"type":"string","description":"help text displayed by UI.","example":"The unique identifier for the account"},"placeholder":{"type":"string","description":"Hint text that fills UI box.","example":"Enter a unique user name for this account."},"required":{"type":"boolean","description":"If true, the schema attribute is required for all non-employees in the source","example":true}},"required":["type","technicalName","label"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-sources/{sourceId}/schema-attributes/{attributeId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Schema Attribute Non-Employee Source","description":{"content":"This API gets a schema attribute by Id for the specified Non-Employee SourceId.","type":"text/plain"},"url":{"path":["non-employee-sources",":sourceId","schema-attributes",":attributeId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Schema Attribute Id (UUID)","type":"text/plain"},"type":"any","value":"","key":"attributeId"},{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Schema Attribute Non-Employee Source' (get-non-employee-schema-attribute)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Schema Attribute Non-Employee Source + + + +This API gets a schema attribute by Id for the specified Non-Employee SourceId. + +
Path Parameters
+ +The Schema Attribute + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-non-employee-source-schema-attributes.api.mdx b/products/idn/api/beta/get-non-employee-source-schema-attributes.api.mdx new file mode 100644 index 000000000..47853dfd2 --- /dev/null +++ b/products/idn/api/beta/get-non-employee-source-schema-attributes.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-non-employee-source-schema-attributes +sidebar_label: List Schema Attributes Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getNonEmployeeSourceSchemaAttributes","security":[{"oauth2":[]}],"tags":["Non-Employee Lifecycle Management"],"description":"This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned.","parameters":[{"in":"path","example":"2c918085842e69ae018432d22ccb212f","name":"sourceId","schema":{"type":"string"},"required":true,"description":"The Source id"}],"responses":{"200":{"description":"A list of Schema Attributes","content":{"application/json":{"schema":{"type":"array","example":[{"type":"TEXT","label":"string","technicalName":"string","helpText":"string","placeholder":"string","required":true}],"items":{"type":"object","properties":{"id":{"type":"string","format":"UUID","example":"ac110005-7156-1150-8171-5b292e3e0084","description":"Schema Attribute Id"},"system":{"type":"boolean","description":"True if this schema attribute is mandatory on all non-employees sources.","example":true},"modified":{"type":"string","format":"date-time","description":"When the schema attribute was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the schema attribute was created.","example":"2019-08-23T18:40:35.772Z"},"type":{"type":"string","enum":["TEXT","DATE","IDENTITY"],"description":"Enum representing the type of data a schema attribute accepts."},"label":{"type":"string","description":"Label displayed on the UI for this schema attribute.","example":"Account Name"},"technicalName":{"type":"string","description":"The technical name of the attribute. Must be unique per source.","example":"account.name"},"helpText":{"type":"string","description":"help text displayed by UI.","example":"The unique identifier for the account"},"placeholder":{"type":"string","description":"Hint text that fills UI box.","example":"Enter a unique user name for this account."},"required":{"type":"boolean","description":"If true, the schema attribute is required for all non-employees in the source","example":true}},"required":["type","technicalName","label"]},"maxItems":18}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-sources/{sourceId}/schema-attributes","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Schema Attributes Non-Employee Source","description":{"content":"This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned.","type":"text/plain"},"url":{"path":["non-employee-sources",":sourceId","schema-attributes"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Schema Attributes Non-Employee Source' (get-non-employee-source-schema-attributes)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Schema Attributes Non-Employee Source + + + +This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. + +
Path Parameters
+ +A list of Schema Attributes + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-non-employee-source.api.mdx b/products/idn/api/beta/get-non-employee-source.api.mdx new file mode 100644 index 000000000..843d85493 --- /dev/null +++ b/products/idn/api/beta/get-non-employee-source.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-non-employee-source +sidebar_label: Get a Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getNonEmployeeSource","security":[{"oauth2":["idn:nelm:read"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This gets a non-employee source.","parameters":[{"in":"path","example":"2c91808b7c28b350017c2a2ec5790aa1","name":"sourceId","description":"Source Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Non-Employee source object.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"},"sourceId":{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"},"description":{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}},{"type":"object","properties":{"approvers":{"description":"List of approvers","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}}},"accountManagers":{"description":"List of account managers","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}}},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"},"nonEmployeeCount":{"nullable":true,"type":"integer","description":"The number of non-employee records on all sources that *requested-for* user manages.","example":2,"format":"int32"}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-sources/{sourceId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get a Non-Employee Source","description":{"content":"This gets a non-employee source.","type":"text/plain"},"url":{"path":["non-employee-sources",":sourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Source Id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a Non-Employee Source' (get-non-employee-source)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a Non-Employee Source + + + +This gets a non-employee source. + +
Path Parameters
+ +Non-Employee source object. + +
Schema
    approvers object[]
    + +List of approvers + +
    accountManagers object[]
    + +List of account managers + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-notification-preference.api.mdx b/products/idn/api/beta/get-notification-preference.api.mdx new file mode 100644 index 000000000..46a005366 --- /dev/null +++ b/products/idn/api/beta/get-notification-preference.api.mdx @@ -0,0 +1,76 @@ +--- +id: get-notification-preference +sidebar_label: Get Notification Preferences for tenant. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getNotificationPreference","tags":["Notifications"],"description":"Returns the notification preferences for tenant. Note that if the key doesn't exist, then a 404 will be returned.\nRequest will require the following legacy roles: ORG_ADMIN and API","parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"},"description":"The notification key."}],"responses":{"200":{"description":"Return preference for the given notification key.","content":{"application/json":{"schema":{"type":"object","description":"Maps an Identity's attribute key to a list of preferred notification mediums.","properties":{"key":{"type":"string","description":"The template notification key.","example":"cloud_manual_work_item_summary"},"mediums":{"type":"array","description":"List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future.","items":{"type":"string","enum":["EMAIL","SMS","PHONE","SLACK","TEAMS"]},"example":["EMAIL"]},"modified":{"type":"string","description":"Modified date of preference","format":"date-time","example":"2020-05-15T14:37:06.909Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}}},"method":"get","path":"/notification-preferences/{key}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Notification Preferences for tenant.","description":{"content":"Returns the notification preferences for tenant. Note that if the key doesn't exist, then a 404 will be returned.\nRequest will require the following legacy roles: ORG_ADMIN and API","type":"text/plain"},"url":{"path":["notification-preferences",":key"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The notification key.","type":"text/plain"},"type":"any","value":"","key":"key"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Notification Preferences for tenant.' (get-notification-preference)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Notification Preferences for tenant. + + + +Returns the notification preferences for tenant. Note that if the key doesn't exist, then a 404 will be returned. +Request will require the following legacy roles: ORG_ADMIN and API + +
Path Parameters
+ +Return preference for the given notification key. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
\ No newline at end of file diff --git a/products/idn/api/beta/get-notification-template.api.mdx b/products/idn/api/beta/get-notification-template.api.mdx new file mode 100644 index 000000000..eb4c031a8 --- /dev/null +++ b/products/idn/api/beta/get-notification-template.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-notification-template +sidebar_label: Get Notification Template By Id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getNotificationTemplate","tags":["Notifications"],"description":"This gets a template that you have modified for your site by Id.","parameters":[{"name":"id","in":"path","description":"Id of the Notification Template","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b"}}],"responses":{"200":{"description":"A template object for your site","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"cloud_manual_work_item_summary"},"name":{"type":"string","example":"Task Manager Subscription"},"medium":{"type":"string","description":"The message medium. More mediums may be added in the future.","enum":["EMAIL","PHONE","SMS","SLACK","TEAMS"],"example":"EMAIL"},"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en"},"subject":{"type":"string","example":"You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}."},"header":{"type":"string","example":"Dear $__recipient.name,"},"body":{"type":"string","example":"Please go to the task manager"},"footer":{"type":"string","example":"Thanks, The $__global.productName Team"},"from":{"type":"string","example":"$__global.emailFromAddress"},"replyTo":{"type":"string","example":"$__global.emailFromAddress"},"description":{"type":"string","example":"Daily digest - sent if number of outstanding tasks for task owner > 0"},"id":{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b","description":"This is auto-generated."},"created":{"type":"string","format":"date-time","description":"The time when this template is created. This is auto-generated.","example":"2020-01-01T00:00:00.000000Z"},"modified":{"type":"string","format":"date-time","description":"The time when this template was last modified. This is auto-generated.","example":"2020-01-01T00:00:00.000000Z"}},"required":["key","medium","locale"]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/notification-templates/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Notification Template By Id","description":{"content":"This gets a template that you have modified for your site by Id.","type":"text/plain"},"url":{"path":["notification-templates",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the Notification Template","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Notification Template By Id' (get-notification-template)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Notification Template By Id + + + +This gets a template that you have modified for your site by Id. + +
Path Parameters
+ +A template object for your site + +
Schema array
 0\",\n \"id\": \"c17bea3a-574d-453c-9e04-4365fbf5af0b\",\n \"created\": \"2020-01-01T00:00:00.000000Z\",\n \"modified\": \"2020-01-01T00:00:00.000000Z\"\n }\n]"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-notifications-template-context.api.mdx b/products/idn/api/beta/get-notifications-template-context.api.mdx new file mode 100644 index 000000000..02fa7c75b --- /dev/null +++ b/products/idn/api/beta/get-notifications-template-context.api.mdx @@ -0,0 +1,79 @@ +--- +id: get-notifications-template-context +sidebar_label: Get Notification Template Context +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getNotificationsTemplateContext","tags":["Notifications"],"description":"The notification service (Hermes) maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes\n that will be available per tenant (organization).\n\nRegarding authorization, the access token contains the tenant and will grant access to the one requested.\nRequires the following security scope: idn:notification-templates:read","responses":{"200":{"description":"Notification template context attributes for a specific tenant.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object that stores the context.","example":{"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":{"type":"string","description":"When the global context was created","format":"date-time","example":"2020-04-15T16:16:47.525Z"},"modified":{"type":"string","description":"When the global context was last modified","format":"date-time","example":"2020-04-15T16:16:47.525Z"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/notification-template-context","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Notification Template Context","description":{"content":"The notification service (Hermes) maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes\n that will be available per tenant (organization).\n\nRegarding authorization, the access token contains the tenant and will grant access to the one requested.\nRequires the following security scope: idn:notification-templates:read","type":"text/plain"},"url":{"path":["notification-template-context"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Notification Template Context' (get-notifications-template-context)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Notification Template Context + + + +The notification service (Hermes) maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes + that will be available per tenant (organization). + +Regarding authorization, the access token contains the tenant and will grant access to the one requested. +Requires the following security scope: idn:notification-templates:read + +
+ +Notification template context attributes for a specific tenant. + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-oauth-client.api.mdx b/products/idn/api/beta/get-oauth-client.api.mdx new file mode 100644 index 000000000..c4bf63710 --- /dev/null +++ b/products/idn/api/beta/get-oauth-client.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-oauth-client +sidebar_label: Get OAuth Client +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getOauthClient","security":[{"oauth2":["sp:oauth-client:manage","sp:oauth-client:read"]}],"tags":["OAuth Clients"],"description":"This gets details of an OAuth client.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The OAuth client id","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"Request succeeded.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the OAuth client","example":"2c9180835d2e5168015d32f890ca1581"},"businessName":{"type":"string","nullable":true,"description":"The name of the business the API Client should belong to","example":"Acme-Solar"},"homepageUrl":{"type":"string","nullable":true,"description":"The homepage URL associated with the owner of the API Client","example":"http://localhost:12345"},"name":{"type":"string","description":"A human-readable name for the API Client","example":"Demo API Client"},"description":{"type":"string","nullable":true,"description":"A description of the API Client","example":"An API client used for the authorization_code, refresh_token, and client_credentials flows"},"accessTokenValiditySeconds":{"type":"integer","format":"int32","description":"The number of seconds an access token generated for this API Client is valid for","example":750},"refreshTokenValiditySeconds":{"type":"integer","format":"int32","description":"The number of seconds a refresh token generated for this API Client is valid for","example":86400},"redirectUris":{"type":"array","nullable":true,"items":{"type":"string"},"description":"A list of the approved redirect URIs used with the authorization_code flow","example":["http://localhost:12345"]},"grantTypes":{"type":"array","items":{"description":"OAuth2 Grant Type","type":"string","example":"CLIENT_CREDENTIALS","enum":["CLIENT_CREDENTIALS","AUTHORIZATION_CODE","REFRESH_TOKEN"]},"description":"A list of OAuth 2.0 grant types this API Client can be used with","example":["AUTHORIZATION_CODE","CLIENT_CREDENTIALS","REFRESH_TOKEN"]},"accessType":{"description":"The access type (online or offline) of this API Client","example":"OFFLINE","type":"string","enum":["ONLINE","OFFLINE"]},"type":{"description":"The type of the API Client (public or confidential)","example":"CONFIDENTIAL","type":"string","enum":["CONFIDENTIAL","PUBLIC"]},"internal":{"type":"boolean","description":"An indicator of whether the API Client can be used for requests internal to IDN","example":false},"enabled":{"type":"boolean","description":"An indicator of whether the API Client is enabled for use","example":true},"strongAuthSupported":{"type":"boolean","description":"An indicator of whether the API Client supports strong authentication","example":false},"claimsSupported":{"type":"boolean","description":"An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow","example":false},"created":{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when the API Client was created","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when the API Client was last updated","example":"2018-06-25T20:22:28.104Z"},"lastUsed":{"type":"string","nullable":true,"format":"date-time","description":"The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed.","example":"2017-07-11T18:45:37.098Z"},"scope":{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the API Client.","example":["demo:api-client-scope:first","demo:api-client-scope:second"]}},"required":["id","businessName","homepageUrl","name","description","accessTokenValiditySeconds","refreshTokenValiditySeconds","redirectUris","grantTypes","accessType","type","internal","enabled","strongAuthSupported","claimsSupported","created","modified","scope"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/oauth-clients/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get OAuth Client","description":{"content":"This gets details of an OAuth client.","type":"text/plain"},"url":{"path":["oauth-clients",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The OAuth client id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get OAuth Client' (get-oauth-client)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get OAuth Client + + + +This gets details of an OAuth client. + +
Path Parameters
+ +Request succeeded. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-org-config.api.mdx b/products/idn/api/beta/get-org-config.api.mdx new file mode 100644 index 000000000..1bf8f2f1e --- /dev/null +++ b/products/idn/api/beta/get-org-config.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-org-config +sidebar_label: Get Org configuration settings +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getOrgConfig","tags":["Org Config"],"security":[{"oauth2":["idn:org-configs:read","idn:org-configs:manage"]}],"description":"Get org configuration with only external (org admin) accessible properties for the current org.","responses":{"200":{"description":"Request succeeded.","content":{"application/json":{"schema":{"type":"object","description":"DTO class for OrgConfig data accessible by customer external org admin (\"ORG_ADMIN\") users","properties":{"orgName":{"type":"string","description":"The name of the org.","example":"acme-solar"},"timeZone":{"type":"string","description":"The selected time zone which is to be used for the org. This directly affects when scheduled tasks are executed. Valid options can be found at /beta/org-config/valid-time-zones","example":"America/Toronto"},"lcsChangeHonorsSourceEnableFeature":{"type":"boolean","description":"Flag to determine whether the LCS_CHANGE_HONORS_SOURCE_ENABLE_FEATURE flag is enabled for the current org.","example":false},"armCustomerId":{"type":"string","description":"ARM Customer ID","nullable":true,"example":"DE38E75A-5FF6-4A65-5DC7-08D64426B09E"},"armSapSystemIdMappings":{"type":"string","description":"A list of IDN::sourceId to ARM::systemId mappings.","nullable":true,"example":[{"sourceId":"2c91808c791a94e501792388b0d62659","systemId":"1556"},{"sourceId":"2_2c91808c791a94e501792388b0d62659","systemId":"2_1556"},{"sourceId":"3_2c91808c791a94e501792388b0d62659","systemId":"3_1556"}]},"armAuth":{"type":"string","description":"ARM authentication string","nullable":true,"example":"epiYNTRYA2S7swisDWk1Zv4VMNgvqEjiBh5_ufuCWsma2m-5XADijqBg0ijXLby5nS6lxZNXabhGnAPGeDGc4V3jQKrhwV-UHypRLs8ZLgOjiQNus9NimS0uPdKomRW6TFWqXyfnYd-znNgbbVuwUy9GyD9ebDVJSntPastxSx7UcyGuWBqfNZYpuxKRWe_7TVY60qL55jUqyz8N4XUbbdcxdbZ0uik6ut-Bv90MKTbZexBW_PR4qcgIkaEs4kIenLyBxnGziYo7AO0tJ8bGHO8FJRkibCpAQIt7PISLo7Gg_Xf9j10dKq2YDgy4pPTvz3fE2ZHYnXCXvXFSA-vVag=="},"armDb":{"type":"string","description":"ARM database name","nullable":true,"example":"EU"},"armSsoUrl":{"type":"string","description":"ARM SSO URL","nullable":true,"example":"https://your-arm-sso-url"},"iaiEnableCertificationRecommendations":{"type":"boolean","description":"Flag to determine whether IAI Certification Recommendations are enabled for the current org","example":true},"sodReportConfigs":{"type":"array","items":{"type":"object","properties":{"columnName":{"type":"string","description":"Name of column in report","example":"SOD Business Name"},"required":{"type":"boolean","description":"If true, column is required in all reports, and this entry is immutable. A 400 error will result from any attempt to modify the column's definition.","example":true,"default":false},"included":{"type":"boolean","description":"If true, column is included in the report. A 400 error will be thrown if an attempt is made to set included=false if required==true.","example":false,"default":false},"order":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"description":"Relative sort order for the column. Columns will be displayed left-to-right in nondecreasing order.","example":2}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/org-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Org configuration settings","description":{"content":"Get org configuration with only external (org admin) accessible properties for the current org.","type":"text/plain"},"url":{"path":["org-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Org configuration settings' (get-org-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Org configuration settings + + + +Get org configuration with only external (org admin) accessible properties for the current org. + +
+ +Request succeeded. + +
Schema
    sodReportConfigs object[]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-password-dictionary.api.mdx b/products/idn/api/beta/get-password-dictionary.api.mdx new file mode 100644 index 000000000..561367a8b --- /dev/null +++ b/products/idn/api/beta/get-password-dictionary.api.mdx @@ -0,0 +1,116 @@ +--- +id: get-password-dictionary +sidebar_label: Get Password Dictionary +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getPasswordDictionary","tags":["Password Dictionary"],"description":"This gets password dictionary for the organization.\nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:password-dictionary-management:read"]}],"responses":{"200":{"description":"\nThe password dictionary file can contain lines that are:\n1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing\n2. empty lines\n3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines\n4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed;\n maximum length of the line is 128 Unicode codepoints\n\n\nPassword dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line).\n Password dict file must contain UTF-8 characters only.\n\n# Sample password text file\n\n```\n\n# Password dictionary small test file\n\nlocale=en_US\n\n# Password dictionary prohibited words\n\nqwerty\nabcd\naaaaa\npassword\nqazxsws\n\n```","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/password-dictionary","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Password Dictionary","description":{"content":"This gets password dictionary for the organization.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["password-dictionary"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"text/plain"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Password Dictionary' (get-password-dictionary)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Password Dictionary + + + +This gets password dictionary for the organization. +A token with ORG_ADMIN authority is required to call this API. + +
+ + +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +
Schema
  • string
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-password-org-config.api.mdx b/products/idn/api/beta/get-password-org-config.api.mdx new file mode 100644 index 000000000..7838ace48 --- /dev/null +++ b/products/idn/api/beta/get-password-org-config.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-password-org-config +sidebar_label: Get Password Org Config +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getPasswordOrgConfig","tags":["Password Configuration"],"description":"This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read'","security":[{"oauth2":["idn:password-org-config:read"]}],"responses":{"200":{"description":"Reference to the password org config.","content":{"application/json":{"schema":{"type":"object","properties":{"customInstructionsEnabled":{"type":"boolean","description":"Indicator whether custom password instructions feature is enabled. The default value is false.","default":false,"example":true},"digitTokenEnabled":{"type":"boolean","description":"Indicator whether \"digit token\" feature is enabled. The default value is false.","default":false,"example":true},"digitTokenDurationMinutes":{"type":"integer","format":"int32","description":"The duration of \"digit token\" in minutes. The default value is 5.","minimum":1,"maximum":60,"default":5,"example":10},"digitTokenLength":{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}},"example":{"customInstructionsEnabled":true,"digitTokenDurationMinutes":9,"digitTokenEnabled":false,"digitTokenLength":6}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/password-org-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Password Org Config","description":{"content":"This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read'","type":"text/plain"},"url":{"path":["password-org-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Password Org Config' (get-password-org-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Password Org Config + + + +This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read' + +
+ +Reference to the password org config. + +
Schema
    = 1` and `<= 60`"} defaultValue={5}>= 6` and `<= 18`"} defaultValue={6}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-password-sync-group.api.mdx b/products/idn/api/beta/get-password-sync-group.api.mdx new file mode 100644 index 000000000..3b661f8f3 --- /dev/null +++ b/products/idn/api/beta/get-password-sync-group.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-password-sync-group +sidebar_label: Get Password Sync Group by ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getPasswordSyncGroup","tags":["Password Sync Groups"],"description":"This API returns the sync group for the specified ID. A token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:password-sync-group-management:read"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of password sync group to retrieve.","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"}],"responses":{"200":{"description":"Reference to the password sync group.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the sync group","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"},"name":{"description":"Name of the sync group","type":"string","example":"Password Sync Group 1"},"passwordPolicyId":{"type":"string","description":"ID of the password policy","example":"2c91808d744ba0ce01746f93b6204501"},"sourceIds":{"type":"array","description":"List of password managed sources IDs","items":{"type":"string"},"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}},"example":{"id":"6881f631-3bd5-4213-9c75-8e05cc3e35dd","name":"Password Sync Group 1","passwordPolicyId":"2c91808d744ba0ce01746f93b6204501","sourceIds":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/password-sync-groups/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Password Sync Group by ID","description":{"content":"This API returns the sync group for the specified ID. A token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["password-sync-groups",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of password sync group to retrieve.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Password Sync Group by ID' (get-password-sync-group)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Password Sync Group by ID + + + +This API returns the sync group for the specified ID. A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
+ +Reference to the password sync group. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-password-sync-groups.api.mdx b/products/idn/api/beta/get-password-sync-groups.api.mdx new file mode 100644 index 000000000..701b7e035 --- /dev/null +++ b/products/idn/api/beta/get-password-sync-groups.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-password-sync-groups +sidebar_label: Get Password Sync Group List +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getPasswordSyncGroups","tags":["Password Sync Groups"],"description":"This API returns a list of password sync groups. A token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:password-sync-group-management:read"]}],"parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"A list of password sync groups.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the sync group","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"},"name":{"description":"Name of the sync group","type":"string","example":"Password Sync Group 1"},"passwordPolicyId":{"type":"string","description":"ID of the password policy","example":"2c91808d744ba0ce01746f93b6204501"},"sourceIds":{"type":"array","description":"List of password managed sources IDs","items":{"type":"string"},"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/password-sync-groups","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Password Sync Group List","description":{"content":"This API returns a list of password sync groups. A token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["password-sync-groups"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Password Sync Group List' (get-password-sync-groups)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Password Sync Group List + + + +This API returns a list of password sync groups. A token with ORG_ADMIN authority is required to call this API. + +
Query Parameters
+ +A list of password sync groups. + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-peer-group-outliers-contributing-features.api.mdx b/products/idn/api/beta/get-peer-group-outliers-contributing-features.api.mdx new file mode 100644 index 000000000..8f9674151 --- /dev/null +++ b/products/idn/api/beta/get-peer-group-outliers-contributing-features.api.mdx @@ -0,0 +1,104 @@ +--- +id: get-peer-group-outliers-contributing-features +sidebar_label: Get identity outlier's contibuting features +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getPeerGroupOutliersContributingFeatures","tags":["IAI Outliers"],"description":"This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object\nRequires authorization scope of 'iai:outliers-management:read'","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"name":"include-translation-messages","in":"query","description":"Whether or not to include translation messages object in returned response","required":false,"schema":{"type":"string","example":"include-translation-messages="}},{"in":"path","example":"2c918085842e69ae018432d22ccb212f","name":"outlierId","schema":{"type":"string"},"required":true,"description":"The outlier id"},{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated","example":"importance"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\nSorting is supported for the following fields: **importance**"}],"responses":{"200":{"description":"Succeeded. Returns list of objects. Each object contains a feature and metadata about that feature","headers":{"X-Total-Count":{"description":"The total result count.","schema":{"type":"integer"}},"accept-language":{"description":"The locale to use for translations for displayName and description text","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the feature","example":"entitlement_count"},"valueType":{"type":"string","enum":["INTEGER","FLOAT"],"description":"The data type of the value field","example":"INTEGER"},"value":{"oneOf":[{"type":"number","format":"float","minimum":0,"maximum":1},{"type":"integer","format":"int64"}],"description":"The feature value","example":0.92},"importance":{"type":"number","format":"float","description":"The importance of the feature. This can also be a negative value","minimum":-1,"maximum":1,"example":-0.15},"displayName":{"type":"string","description":"The (translated if header is passed) displayName for the feature","example":"Number of entitlements"},"description":{"type":"string","description":"The (translated if header is passed) description for the feature","example":"The total number of entitlements belonging to an identity"},"translationMessages":{"type":"object","properties":{"displayName":{"properties":{"key":{"type":"string","description":"The key of the translation message","example":"recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH"},"values":{"type":"array","description":"The values corresponding to the translation messages","items":{"type":"string"},"example":["75","department"]}}},"description":{"properties":{"key":{"type":"string","description":"The key of the translation message","example":"recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH"},"values":{"type":"array","description":"The values corresponding to the translation messages","items":{"type":"string"},"example":["75","department"]}}}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/outliers/{outlierId}/contributing-features","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get identity outlier's contibuting features","description":{"content":"This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object\nRequires authorization scope of 'iai:outliers-management:read'","type":"text/plain"},"url":{"path":["outliers",":outlierId","contributing-features"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Whether or not to include translation messages object in returned response","type":"text/plain"},"key":"include-translation-messages","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\nSorting is supported for the following fields: **importance**","type":"text/plain"},"key":"sorters","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The outlier id","type":"text/plain"},"type":"any","value":"","key":"outlierId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get identity outlier's contibuting features' (get-peer-group-outliers-contributing-features)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get identity outlier's contibuting features + + + +This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object +Requires authorization scope of 'iai:outliers-management:read' + +
Path Parameters
Query Parameters
+ +Succeeded. Returns list of objects. Each object contains a feature and metadata about that feature + +
Response Headers
  • X-Total-Count integer
    + +The total result count. + +
  • accept-language string
    + +The locale to use for translations for displayName and description text + +
Schema array
    value object
    + +The feature value + +
    oneOf
  • number float
    + +**Possible values:** `<= 1` + +
  • integer int64
    • = -1` and `<= 1`"} defaultValue={undefined}>
    translationMessages object
    displayName
    description
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-peer-group-outliers.api.mdx b/products/idn/api/beta/get-peer-group-outliers.api.mdx new file mode 100644 index 000000000..06da12924 --- /dev/null +++ b/products/idn/api/beta/get-peer-group-outliers.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-peer-group-outliers +sidebar_label: Identity Outliers List +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getPeerGroupOutliers","tags":["IAI Peer Group Strategies"],"deprecated":true,"description":"-- Deprecated : See 'IAI Outliers' This API will be used by Identity Governance systems to identify identities that are not included in an organization's peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned.","parameters":[{"in":"path","name":"strategy","schema":{"type":"string"},"required":true,"description":"The strategy used to create peer groups. Currently, 'entitlement' is supported.","example":"entitlement"},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"List of identities that are not included in peer groups.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the peer group member."},"type":{"type":"string","description":"The type of the peer group member."},"peer_group_id":{"type":"string","description":"The ID of the peer group."},"attributes":{"type":"object","additionalProperties":{"type":"object"},"description":"Arbitrary key-value pairs, belonging to the peer group member."}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":[]}],"method":"get","path":"/peer-group-strategies/{strategy}/identity-outliers","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Identity Outliers List","description":{"content":"-- Deprecated : See 'IAI Outliers' This API will be used by Identity Governance systems to identify identities that are not included in an organization's peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned.","type":"text/plain"},"url":{"path":["peer-group-strategies",":strategy","identity-outliers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The strategy used to create peer groups. Currently, 'entitlement' is supported.","type":"text/plain"},"type":"any","value":"","key":"strategy"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Identity Outliers List' (get-peer-group-outliers)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Identity Outliers List + +:::caution deprecated + +This endpoint has been deprecated and may be removed in future versions of the API. + +::: + +-- Deprecated : See 'IAI Outliers' This API will be used by Identity Governance systems to identify identities that are not included in an organization's peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. + +
Path Parameters
Query Parameters
+ +List of identities that are not included in peer groups. + +
Schema array
    attributes object
    + +Arbitrary key-value pairs, belonging to the peer group member. + +
  • property name* object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-potential-role-applications.api.mdx b/products/idn/api/beta/get-potential-role-applications.api.mdx new file mode 100644 index 000000000..bfb725d2c --- /dev/null +++ b/products/idn/api/beta/get-potential-role-applications.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-potential-role-applications +sidebar_label: Retrieves the applications of a potential role for a role mining session +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getPotentialRoleApplications","tags":["IAI Role Mining"],"description":"This method returns the applications of a potential role for a role mining session.","parameters":[{"in":"path","name":"sessionId","schema":{"type":"string"},"required":true,"description":"The role mining session id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"path","name":"potentialRoleId","schema":{"type":"string"},"required":true,"description":"A potential role id in a role mining session","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Succeeded. Returns a list of potential roles for a role mining session.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the potential role"},"name":{"type":"string","description":"Name of the potential role"}},"example":{"id":"2c9180877212632a017228d5a796292b","name":"Slack"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Retrieves the applications of a potential role for a role mining session","description":{"content":"This method returns the applications of a potential role for a role mining session.","type":"text/plain"},"url":{"path":["role-mining-sessions",":sessionId","potential-role-summaries",":potentialRoleId","applications"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The role mining session id","type":"text/plain"},"type":"any","value":"","key":"sessionId"},{"disabled":false,"description":{"content":"(Required) A potential role id in a role mining session","type":"text/plain"},"type":"any","value":"","key":"potentialRoleId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Retrieves the applications of a potential role for a role mining session' (get-potential-role-applications)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieves the applications of a potential role for a role mining session + + + +This method returns the applications of a potential role for a role mining session. + +
Path Parameters
Query Parameters
+ +Succeeded. Returns a list of potential roles for a role mining session. + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-potential-role-summaries.api.mdx b/products/idn/api/beta/get-potential-role-summaries.api.mdx new file mode 100644 index 000000000..e25e3ac7c --- /dev/null +++ b/products/idn/api/beta/get-potential-role-summaries.api.mdx @@ -0,0 +1,79 @@ +--- +id: get-potential-role-summaries +sidebar_label: Retrieves all potential role summaries +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getPotentialRoleSummaries","tags":["IAI Role Mining"],"description":"This method returns the potential role summaries for a role mining session.","parameters":[{"in":"path","name":"sessionId","schema":{"type":"string"},"required":true,"description":"The role mining session id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"query","name":"sorters","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **createdDate**","example":"createdDate"},{"in":"query","name":"filters","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Filtering is supported for the following fields and operators:\n**createdById**: *eq, sw, co*\n**createdByName**: *eq, sw, co*\n**description**: *sw, co*\n**endDate**: *le, lt*\n**freshness**: *eq, ge, gt, le, lt*\n**name**: *eq, sw, co*\n**quality**: *eq, ge, gt, le, lt*\n**startDate**: *ge, gt*\n**saved**: *eq*\n**type**: *eq*","example":"(createdByName co \"int\")and (createdById sw \"2c9180907\")and (type eq \"COMMON\")and ((name co \"entt\")or (saved eq true))","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Succeeded. Returns a list of potential role summaries for a role mining session.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"potentialRoleRef":{"description":"Details about the potential role","type":"object","properties":{"id":{"type":"string","description":"Id of the potential role"},"name":{"type":"string","description":"Name of the potential role"}}},"identityCount":{"type":"integer","description":"The number of identities in a potential role.","example":25},"entitlementCount":{"type":"integer","description":"The number of entitlements in a potential role.","example":15},"identityGroupStatus":{"type":"string","description":"The status for this identity group which can be \"REQUESTED\" or \"OBTAINED\"","example":"OBTAINED"},"provisionState":{"description":"The status of provisioning for this potential role. Can be \"POTENTIAL\", \"PENDING\", \"FAILED\", or \"COMPLETE\".","example":"PENDING","type":"string","enum":["POTENTIAL","PENDING","COMPLETE","FAILED"]},"roleId":{"type":"string","description":"ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned.","example":"2a4be6fbcf3c4e66b95a0c15ffd591"},"density":{"type":"integer","description":"The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities.","example":90},"freshness":{"type":"integer","description":"The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles.","example":70},"quality":{"type":"integer","description":"The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness.","example":80}},"example":{"potentialRoleRef":{"id":"dd4c13c6-8237-4753-bfb7-f627e489f9ec","name":"Potential Role - dd4c13"},"identityCount":"25","entitlementCount":"15","identityGroupStatus":"OBTAINED","provisionState":"PENDING","roleId":"2a4be6fbcf3c4e66b95a0c15ffd591"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/role-mining-sessions/{sessionId}/potential-role-summaries","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Retrieves all potential role summaries","description":{"content":"This method returns the potential role summaries for a role mining session.","type":"text/plain"},"url":{"path":["role-mining-sessions",":sessionId","potential-role-summaries"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **createdDate**","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Filtering is supported for the following fields and operators:\n**createdById**: *eq, sw, co*\n**createdByName**: *eq, sw, co*\n**description**: *sw, co*\n**endDate**: *le, lt*\n**freshness**: *eq, ge, gt, le, lt*\n**name**: *eq, sw, co*\n**quality**: *eq, ge, gt, le, lt*\n**startDate**: *ge, gt*\n**saved**: *eq*\n**type**: *eq*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The role mining session id","type":"text/plain"},"type":"any","value":"","key":"sessionId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Retrieves all potential role summaries' (get-potential-role-summaries)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieves all potential role summaries + + + +This method returns the potential role summaries for a role mining session. + +
Path Parameters
Query Parameters
+ +Succeeded. Returns a list of potential role summaries for a role mining session. + +
Schema array
    potentialRoleRef object
    + +Details about the potential role + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-potential-role.api.mdx b/products/idn/api/beta/get-potential-role.api.mdx new file mode 100644 index 000000000..38a9bc3e3 --- /dev/null +++ b/products/idn/api/beta/get-potential-role.api.mdx @@ -0,0 +1,91 @@ +--- +id: get-potential-role +sidebar_label: Retrieves a specific potential role +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getPotentialRole","tags":["IAI Role Mining"],"description":"This method returns a specific potential role for a role mining session.","parameters":[{"in":"path","name":"sessionId","schema":{"type":"string"},"required":true,"description":"The role mining session id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"path","name":"potentialRoleId","schema":{"type":"string"},"required":true,"description":"A potential role id in a role mining session","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"}],"responses":{"200":{"description":"Succeeded. Returns a list of potential roles for a role mining session.","content":{"application/json":{"schema":{"type":"object","properties":{"createdBy":{"description":"The session created by details.","type":"object","properties":{"id":{"type":"string","description":"ID of the creator","example":"2c918090761a5aac0176215c46a62d58"},"displayName":{"type":"string","description":"The display name of the creator","example":"Ashley.Pierce"}}},"density":{"type":"integer","description":"The density of a potential role.","example":75,"format":"int32"},"description":{"type":"string","description":"The description of a potential role.","example":"Potential Role for Accounting dept"},"entitlementCount":{"type":"integer","description":"The number of entitlements in a potential role.","example":25,"format":"int32"},"excludedEntitlements":{"description":"The list of entitlement ids to be excluded.","type":"array","items":{"type":"string"},"example":["07a0b4e2","13b4e2a0"]},"freshness":{"type":"integer","description":"The freshness of a potential role.","example":75,"format":"int32"},"identityCount":{"type":"integer","description":"The number of identities in a potential role.","example":25,"format":"int32"},"identityDistribution":{"description":"Identity attribute distribution.","type":"array","items":{"type":"object","properties":{"attributeName":{"type":"string","description":"Id of the potential role","example":"department"},"distribution":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}},"example":[{"attributeValue":"NM Tier 3","count":6}]}}}},"identityIds":{"description":"The list of ids in a potential role.","type":"array","items":{"type":"string"},"example":["07a0b4e2","13b4e2a0"]},"name":{"type":"string","description":"Name of the potential role.","example":"Saved Potential Role - 07/10"},"provisionState":{"description":"The provisioning state of a potential role.","type":"string","enum":["POTENTIAL","PENDING","COMPLETE","FAILED"],"example":"POTENTIAL"},"quality":{"type":"integer","description":"The quality of a potential role.","example":100,"format":"int32"},"roleId":{"type":"string","description":"The roleId of a potential role.","example":"07a0b4e2-7a76-44fa-bd0b-c64654b66519"},"saved":{"type":"boolean","description":"The potential role's saved status.","example":true},"session":{"description":"The session parameters of the potential role.","type":"object","properties":{"minNumIdentitiesInPotentialRole":{"type":"integer","description":"Minimum number of identities in a potential role","example":20,"format":"int32"},"name":{"type":"string","description":"The session's saved name","example":"Saved RM Session - 07/10"},"pruneThreshold":{"type":"integer","description":"The prune threshold to be used or null to calculate prescribedPruneThreshold","example":5,"format":"int32"},"saved":{"type":"boolean","description":"The session's saved status","example":true},"scope":{"description":"The scope of identities for this role mining session","example":{"identityIds":[],"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"]}}},"type":"object","properties":{"identityIds":{"type":"array","items":{"type":"string"},"description":"The list of identities for this role mining session.","example":["2c918090761a5aac0176215c46a62d58","2c918090761a5aac01722015c46a62d42"]},"criteria":{"type":"string","description":"The \"search\" criteria that produces the list of identities for this role mining session.","example":"source.name:DataScienceDataset"},"attributeFilterCriteria":{"type":"array","items":{"type":"object"},"description":"The filter criteria for this role mining session.","example":{"displayName":{"untranslated":"Location: Miami"},"ariaLabel":{"untranslated":"Location: Miami"},"data":{"displayName":{"translateKey":"IDN.IDENTITY_ATTRIBUTES.LOCATION"},"name":"location","operator":"EQUALS","values":["Miami"]}}}}},"type":{"description":"Role mining potential type","type":"string","enum":["SPECIALIZED","COMMON"],"example":"SPECIALIZED"}}},"type":{"description":"Role mining potential type.","type":"string","enum":["SPECIALIZED","COMMON"],"example":"SPECIALIZED"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Retrieves a specific potential role","description":{"content":"This method returns a specific potential role for a role mining session.","type":"text/plain"},"url":{"path":["role-mining-sessions",":sessionId","potential-role-summaries",":potentialRoleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The role mining session id","type":"text/plain"},"type":"any","value":"","key":"sessionId"},{"disabled":false,"description":{"content":"(Required) A potential role id in a role mining session","type":"text/plain"},"type":"any","value":"","key":"potentialRoleId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Retrieves a specific potential role' (get-potential-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieves a specific potential role + + + +This method returns a specific potential role for a role mining session. + +
Path Parameters
+ +Succeeded. Returns a list of potential roles for a role mining session. + +
Schema
    createdBy object
    + +The session created by details. + +
    identityDistribution object[]
    + +Identity attribute distribution. + +
    session object
    + +The session parameters of the potential role. + +
    scope object
    + +The scope of identities for this role mining session + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-provisioning-policy.api.mdx b/products/idn/api/beta/get-provisioning-policy.api.mdx new file mode 100644 index 000000000..145f14618 --- /dev/null +++ b/products/idn/api/beta/get-provisioning-policy.api.mdx @@ -0,0 +1,88 @@ +--- +id: get-provisioning-policy +sidebar_label: Get Provisioning Policy by UsageType +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getProvisioningPolicy","tags":["Sources"],"description":"This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow.\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","security":[{"oauth2":["idn:provisioning-policy:read","idn:provisioning-policy-source:read","idn:provisioning-policy:manage","idn:provisioning-policy-source-admin-operations:manage"]}],"parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source ID.","example":"2c9180835d191a86015d28455b4a2329"},{"in":"path","name":"usageType","required":true,"schema":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"description":"The type of ProvisioningPolicy usage.","example":"REGISTER"}],"responses":{"200":{"description":"The requested ProvisioningPolicyDto was successfully retrieved.","content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"the provisioning policy name","example":"example provisioning policy for inactive identities"},"description":{"type":"string","description":"the description of the provisioning policy","example":"this provisioning policy creates access based on an identity going inactive"},"usageType":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"userName"},"transform":{"type":"object","description":"The transform to apply to the field","example":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"default":{}},"attributes":{"type":"object","description":"Attributes required for the transform","example":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"}},"isRequired":{"type":"boolean","readOnly":true,"description":"Flag indicating whether or not the attribute is required.","default":false,"example":false},"type":{"type":"string","description":"The type of the attribute.","example":"string"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","default":false,"example":false}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sources/{sourceId}/provisioning-policies/{usageType}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Provisioning Policy by UsageType","description":{"content":"This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow.\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":sourceId","provisioning-policies",":usageType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source ID.","type":"text/plain"},"type":"any","value":"","key":"sourceId"},{"disabled":false,"description":{"content":"(Required) The type of ProvisioningPolicy usage.","type":"text/plain"},"type":"any","value":"","key":"usageType"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Provisioning Policy by UsageType' (get-provisioning-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Provisioning Policy by UsageType + + + +This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. +A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +
Path Parameters
+ +The requested ProvisioningPolicyDto was successfully retrieved. + +
Schema
    fields object[]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-public-identity-config.api.mdx b/products/idn/api/beta/get-public-identity-config.api.mdx new file mode 100644 index 000000000..f64c18288 --- /dev/null +++ b/products/idn/api/beta/get-public-identity-config.api.mdx @@ -0,0 +1,79 @@ +--- +id: get-public-identity-config +sidebar_label: Get Public Identity Config +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getPublicIdentityConfig","tags":["Public Identities Config"],"description":"This gets details of public identity config.","responses":{"200":{"description":"Request succeeded.","content":{"application/json":{"schema":{"type":"object","description":"Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org","properties":{"attributes":{"type":"array","items":{"type":"object","description":"Used to map an attribute key for an Identity to its display name.","properties":{"key":{"type":"string","description":"the key of the attribute","example":"country"},"name":{"type":"string","description":"the display name of the attribute","example":"Country"}}}},"modifiedBy":{"type":"object","nullable":true,"description":"The manager for the identity.","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of identity.","example":"Thomas Edison"}}},"modified":{"type":"string","description":"the date/time of the modification","format":"date-time","example":"2018-06-25T20:22:28.104Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/public-identities-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Public Identity Config","description":{"content":"This gets details of public identity config.","type":"text/plain"},"url":{"path":["public-identities-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Public Identity Config' (get-public-identity-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Public Identity Config + + + +This gets details of public identity config. + +
+ +Request succeeded. + +
Schema
    attributes object[]
    modifiedBy object
    + +The manager for the identity. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-reassignment-config-types.api.mdx b/products/idn/api/beta/get-reassignment-config-types.api.mdx new file mode 100644 index 000000000..f1dcb85f4 --- /dev/null +++ b/products/idn/api/beta/get-reassignment-config-types.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-reassignment-config-types +sidebar_label: List Reassignment Config Types +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getReassignmentConfigTypes","tags":["Work Reassignment"],"description":"Gets a collection of types which are available in the Reassignment Configuration UI.","security":[{"oauth2":["idn:reassignment-configuration:read"]}],"responses":{"200":{"description":"List of Reassignment Configuration Types","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Type of Reassignment Configuration.","properties":{"internalName":{"type":"string","description":"Enum list of valid work types that can be selected for a Reassignment Configuration","enum":["ACCESS_REQUESTS","CERTIFICATIONS","MANUAL_TASKS"],"example":"ACCESS_REQUESTS"},"displayName":{"type":"string","description":"Human readable display name of the type to be shown on UI","example":"Access Requests"},"description":{"type":"string","description":"Description of the type of work to be reassigned, displayed by the UI.","example":"Reassign Access Request Work Items for an identity"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/reassignment-configurations/types","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Reassignment Config Types","description":{"content":"Gets a collection of types which are available in the Reassignment Configuration UI.","type":"text/plain"},"url":{"path":["reassignment-configurations","types"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Reassignment Config Types' (get-reassignment-config-types)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Reassignment Config Types + + + +Gets a collection of types which are available in the Reassignment Configuration UI. + +
+ +List of Reassignment Configuration Types + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-reassignment-configuration.api.mdx b/products/idn/api/beta/get-reassignment-configuration.api.mdx new file mode 100644 index 000000000..08c16cdb4 --- /dev/null +++ b/products/idn/api/beta/get-reassignment-configuration.api.mdx @@ -0,0 +1,111 @@ +--- +id: get-reassignment-configuration +sidebar_label: Get Reassignment Configuration +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getReassignmentConfiguration","tags":["Work Reassignment"],"description":"Gets the Reassignment Configuration for an identity.","security":[{"oauth2":["idn:reassignment-configuration:read"]}],"parameters":[{"in":"path","name":"identityId","schema":{"type":"string"},"description":"unique identity id","required":true,"example":"2c91808781a71ddb0181b9090b5c504f"}],"responses":{"200":{"description":"Reassignment Configuration for an identity","content":{"application/json":{"schema":{"type":"object","description":"The response body of a Reassignment Configuration for a single identity","properties":{"identity":{"type":"object","description":"The definition of an Identity according to the Reassignment Configuration service","properties":{"id":{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"},"name":{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}},"configDetails":{"type":"array","description":"Details of how work should be reassigned for an Identity","items":{"type":"object","description":"The request body of Reassignment Configuration Details for a specific identity and config type","properties":{"configType":{"type":"string","description":"Enum list of valid work types that can be selected for a Reassignment Configuration","enum":["ACCESS_REQUESTS","CERTIFICATIONS","MANUAL_TASKS"],"example":"ACCESS_REQUESTS"},"targetIdentity":{"type":"object","description":"The definition of an Identity according to the Reassignment Configuration service","properties":{"id":{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"},"name":{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}},"startDate":{"type":"string","description":"The date from which to start reassigning work items","format":"date-time","example":"2022-07-21T11:13:12.345Z"},"endDate":{"type":"string","description":"The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment.","format":"date-time","example":"0001-01-01T00:00:00Z"},"auditDetails":{"type":"object","description":"Audit details for the reassignment configuration of an identity","properties":{"created":{"type":"string","description":"Initial date and time when the record was created","format":"date-time","example":"2022-07-21T11:13:12.345Z"},"createdBy":{"type":"object","description":"The definition of an Identity according to the Reassignment Configuration service","properties":{"id":{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"},"name":{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}},"modified":{"type":"string","description":"Last modified date and time for the record","format":"date-time","example":"2022-07-21T11:13:12.345Z"},"modifiedBy":{"type":"object","description":"The definition of an Identity according to the Reassignment Configuration service","properties":{"id":{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"},"name":{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}}}}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/reassignment-configurations/{identityId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Reassignment Configuration","description":{"content":"Gets the Reassignment Configuration for an identity.","type":"text/plain"},"url":{"path":["reassignment-configurations",":identityId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) unique identity id","type":"text/plain"},"type":"any","value":"","key":"identityId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Reassignment Configuration' (get-reassignment-configuration)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Reassignment Configuration + + + +Gets the Reassignment Configuration for an identity. + +
Path Parameters
+ +Reassignment Configuration for an identity + +
Schema
    identity object
    + +The definition of an Identity according to the Reassignment Configuration service + +
    configDetails object[]
    + +Details of how work should be reassigned for an Identity + +
    targetIdentity object
    + +The definition of an Identity according to the Reassignment Configuration service + +
    auditDetails object
    + +Audit details for the reassignment configuration of an identity + +
    createdBy object
    + +The definition of an Identity according to the Reassignment Configuration service + +
    modifiedBy object
    + +The definition of an Identity according to the Reassignment Configuration service + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-recommendations-config.api.mdx b/products/idn/api/beta/get-recommendations-config.api.mdx new file mode 100644 index 000000000..c79f6a959 --- /dev/null +++ b/products/idn/api/beta/get-recommendations-config.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-recommendations-config +sidebar_label: Get certification recommendation config values +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRecommendationsConfig","tags":["IAI Recommendations"],"description":"Retrieves configuration attributes used by certification recommendations.","responses":{"200":{"description":"Cert recommendation configuration attributes","content":{"application/json":{"schema":{"type":"object","properties":{"recommenderFeatures":{"type":"array","items":{"type":"string"},"description":"List of identity attributes to use for calculating certification recommendations","example":["jobTitle","location","peer_group","department","active"]},"peerGroupPercentageThreshold":{"type":"number","description":"The percent value that the recommendation calculation must surpass to produce a YES recommendation","minimum":0,"maximum":1,"example":0.5},"forceRefresh":{"type":"boolean","description":"If true, rulesRecommenderConfig will be refreshed with new programatically selected attribute and threshold values on the next pipeline run","example":false}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":[]}],"method":"get","path":"/recommendations/config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get certification recommendation config values","description":{"content":"Retrieves configuration attributes used by certification recommendations.","type":"text/plain"},"url":{"path":["recommendations","config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get certification recommendation config values' (get-recommendations-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get certification recommendation config values + + + +Retrieves configuration attributes used by certification recommendations. + +
+ +Cert recommendation configuration attributes + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-recommendations.api.mdx b/products/idn/api/beta/get-recommendations.api.mdx new file mode 100644 index 000000000..7c70ab503 --- /dev/null +++ b/products/idn/api/beta/get-recommendations.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-recommendations +sidebar_label: Returns a Recommendation Based on Object +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRecommendations","tags":["IAI Recommendations"],"description":"The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"requests":{"type":"array","items":{"description":"List of requests to retrieve recommendations","type":"object","properties":{"identityId":{"type":"string","description":"The identity ID","example":"2c938083633d259901633d25c68c00fa"},"item":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the access item for which to retrieve the recommendation","example":"2c938083633d259901633d2623ec0375"},"type":{"type":"string","example":"ENTITLEMENT","description":"The type of the access item.","enum":["ENTITLEMENT","ACCESS_PROFILE","ROLE"]}}}}}},"excludeInterpretations":{"type":"boolean","description":"Exclude interpretations in the response if \"true\". Return interpretations in the response if this attribute is not specified.","default":"false","example":"false"},"includeTranslationMessages":{"type":"boolean","description":"When set to true, the calling system uses the translated messages for the specified language","default":"false","example":"false"},"includeDebugInformation":{"type":"boolean","description":"Returns the recommender calculations if set to true","default":"false","example":"true"},"prescribeMode":{"type":"boolean","description":"When set to true, uses prescribedRulesRecommenderConfig to get identity attributes and peer group threshold instead of standard config.","default":"false","example":"false"}}}}}},"responses":{"200":{"description":"The recommendations for a customer","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"request":{"type":"object","properties":{"identityId":{"type":"string","description":"The identity ID","example":"2c938083633d259901633d25c68c00fa"},"item":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the access item for which to retrieve the recommendation","example":"2c938083633d259901633d2623ec0375"},"type":{"type":"string","example":"ENTITLEMENT","description":"The type of the access item.","enum":["ENTITLEMENT","ACCESS_PROFILE","ROLE"]}}}}},"recommendation":{"type":"string","example":"YES","description":"The recommendation - YES if the access is recommended, NO if not recommended, MAYBE if there is not enough information to make a recommendation, NOT_FOUND if the identity is not found in the system","enum":["YES","NO","MAYBE","NOT_FOUND"]},"interpretations":{"type":"array","items":{"type":"string"},"description":"The list of interpretations explaining the recommendation. The array is empty if includeInterpretations is false or not present in the request. e.g. - [ \"Not approved in the last 6 months.\" ]. Interpretations will be translated using the client's locale as found in the Accept-Language header. If a translation for the client's locale cannot be found, the US English translation will be returned.","example":["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":{"type":"array","example":[{"key":"recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH","values":["75","department"]}],"items":{"properties":{"key":{"type":"string","description":"The key of the translation message","example":"recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH"},"values":{"type":"array","description":"The values corresponding to the translation messages","items":{"type":"string"},"example":["75","department"]}}},"description":"The list of translation messages, if they have been requested."},"recommenderCalculations":{"description":"The calcuations performed behind the scenes that provide recommendations to the user.","properties":{"identityId":{"type":"string","description":"The ID of the identity","example":"2c91808457d8f3ab0157e3e62cb4213c"},"entitlementId":{"type":"string","description":"The entitlement ID","example":"2c91809050db617d0150e0bf3215385e"},"recommendation":{"type":"string","description":"The actual recommendation","example":"YES"},"overallWeightedScore":{"type":"number","description":"The overall weighted score"},"featureWeightedScores":{"type":"object","description":"The weighted score of each individual feature","additionalProperties":{"type":"number"}},"threshold":{"type":"number","description":"The configured value against which the overallWeightedScore is compared"},"identityAttributes":{"type":"object","description":"The values for your configured features","additionalProperties":{"type":"object","properties":{"value":{"type":"string"}}}},"featureValues":{"description":"The feature details","type":"object","properties":{"feature":{"type":"string","description":"The type of feature","example":"department"},"numerator":{"type":"integer","format":"int32","example":14,"description":"The number of identities that have access to the feature"},"denominator":{"type":"integer","format":"int32","example":14,"description":"The number of identities with the corresponding feature"}}}}}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":[]}],"method":"post","path":"/recommendations/request","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"requests":[{"identityId":"2c938083633d259901633d25c68c00fa","item":{"id":"2c938083633d259901633d2623ec0375","type":"ENTITLEMENT"}}],"excludeInterpretations":"false","includeTranslationMessages":"false","includeDebugInformation":"true","prescribeMode":"false"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Returns a Recommendation Based on Object","description":{"content":"The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations.","type":"text/plain"},"url":{"path":["recommendations","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns a Recommendation Based on Object' (get-recommendations)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns a Recommendation Based on Object + + + +The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. + +
Request Body required
    requests object[]
    item object
+ +The recommendations for a customer + +
Schema
    response object[]
    request object
    item object
    translationMessages undefined[]
    + +The list of translation messages, if they have been requested. + +
    recommenderCalculations
    + +The calcuations performed behind the scenes that provide recommendations to the user. + +
    featureWeightedScores object
    + +The weighted score of each individual feature + +
  • property name* number
    • identityAttributes object
    + +The values for your configured features + +
  • property name* object
    • featureValues object
    + +The feature details + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-role-assigned-identities.api.mdx b/products/idn/api/beta/get-role-assigned-identities.api.mdx new file mode 100644 index 000000000..8d5b1d5f0 --- /dev/null +++ b/products/idn/api/beta/get-role-assigned-identities.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-role-assigned-identities +sidebar_label: Identities assigned a Role +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRoleAssignedIdentities","tags":["Roles"],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"description":"ID of the Role for which the assigned Identities are to be listed","example":"2c91808a7813090a017814121e121518","required":true},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**aliasName**: *eq, sw*\n\n**email**: *eq, sw*\n\n**name**: *eq, sw, co*","example":"name sw Joe"},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **id**, **name**, **aliasName**, **email**","example":"aliasName,name"}],"responses":{"200":{"description":"List of Identities assigned the Role","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"A subset of the fields of an Identity which is a member of a Role.","properties":{"id":{"type":"string","description":"The ID of the Identity","example":"2c9180a46faadee4016fb4e018c20639"},"aliasName":{"type":"string","description":"The alias / username of the Identity","example":"t.edison"},"name":{"type":"string","description":"The human-readable display name of the Identity","example":"Thomas Edison"},"email":{"type":"string","description":"Email address of the Identity","example":"t.edison@identitynow.com"},"roleAssignmentSource":{"type":"string","enum":["ACCESS_REQUEST","ROLE_MEMBERSHIP"],"description":"Type which indicates how a particular Identity obtained a particular Role","example":"ACCESS_REQUEST"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:role-unchecked:read","idn:role-unchecked:manage","idn:role-checked:manage","idn:role-checked:read"]}],"description":"Identities assigned a Role","method":"get","path":"/roles/{id}/assigned-identities","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Identities assigned a Role","description":{"type":"text/plain"},"url":{"path":["roles",":id","assigned-identities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**aliasName**: *eq, sw*\n\n**email**: *eq, sw*\n\n**name**: *eq, sw, co*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **id**, **name**, **aliasName**, **email**","type":"text/plain"},"key":"sorters","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Role for which the assigned Identities are to be listed","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Identities assigned a Role' (get-role-assigned-identities)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Identities assigned a Role + + + +Identities assigned a Role + +
Path Parameters
Query Parameters
+ +List of Identities assigned the Role + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-role-insight.api.mdx b/products/idn/api/beta/get-role-insight.api.mdx new file mode 100644 index 000000000..74afc3f5f --- /dev/null +++ b/products/idn/api/beta/get-role-insight.api.mdx @@ -0,0 +1,79 @@ +--- +id: get-role-insight +sidebar_label: Get a single role insight +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRoleInsight","tags":["Role Insights"],"description":"This endpoint gets role insights information for a role.","parameters":[{"in":"path","name":"insightId","schema":{"type":"string"},"required":true,"description":"The role insight id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"}],"responses":{"200":{"description":"Succeeded. Returns information about insights for a single role.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Insight id","example":"1467e61e-f284-439c-ba2d-c6cc11cf0941"},"numberOfUpdates":{"type":"integer","description":"Total number of updates for this role","example":5},"createdDate":{"type":"string","format":"date-time","description":"The date-time insights were last created for this role.","example":"2020-05-19T13:49:37.385Z"},"role":{"description":"A role","type":"object","properties":{"name":{"type":"string","description":"Role name","example":"Software Engineer"},"id":{"type":"string","description":"Role id","example":"1467e61e-f284-439c-ba2d-c6cc11cf0941"},"description":{"type":"string","description":"Role description","example":"Person who develops software"},"ownerName":{"type":"string","description":"Role owner name","example":"Bob"},"ownerId":{"type":"string","description":"Role owner id","example":"1467e61e-f284-439c-ba2d-c6cc11cf0941"}}},"insight":{"description":"The kind of insight this is and some stats","type":"object","properties":{"type":{"type":"string","description":"The number of identities in this role with the entitlement.","example":"ADD"},"identitiesWithAccess":{"type":"integer","description":"The number of identities in this role with the entitlement.","example":850},"identitiesImpacted":{"type":"integer","description":"The number of identities in this role that do not have the specified entitlement.","example":150},"totalNumberOfIdentities":{"type":"integer","description":"The total number of identities.","example":1000}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/role-insights/{insightId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get a single role insight","description":{"content":"This endpoint gets role insights information for a role.","type":"text/plain"},"url":{"path":["role-insights",":insightId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The role insight id","type":"text/plain"},"type":"any","value":"","key":"insightId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a single role insight' (get-role-insight)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a single role insight + + + +This endpoint gets role insights information for a role. + +
Path Parameters
+ +Succeeded. Returns information about insights for a single role. + +
Schema
    role object
    + +A role + +
    insight object
    + +The kind of insight this is and some stats + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-role-insights-current-entitlements.api.mdx b/products/idn/api/beta/get-role-insights-current-entitlements.api.mdx new file mode 100644 index 000000000..9bb1659db --- /dev/null +++ b/products/idn/api/beta/get-role-insights-current-entitlements.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-role-insights-current-entitlements +sidebar_label: Get current entitlement for a role +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRoleInsightsCurrentEntitlements","tags":["Role Insights"],"description":"This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding.","parameters":[{"in":"path","name":"insightId","schema":{"type":"string"},"required":true,"description":"The role insight id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"query","name":"filters","description":"Filter parameter(s) by \"starts with\" for the name and description.","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Succeeded. Returns a list of current or pre-existing entitlements for a role.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entitlement"},"id":{"type":"string","description":"Id of the entitlement"},"description":{"type":"string","description":"Description for the entitlement"},"source":{"type":"string","description":"Source or the application for the entitlement"},"attribute":{"type":"string","description":"Attribute for the entitlement"},"value":{"type":"string","description":"Attribute value for the entitlement"}},"example":{"name":"Administrator","id":"8c190e67-87aa-4ed9-a90b-d9d5344523fb","description":"Full administrative access to IdentityNow","source":"IdentityNow","attribute":"assignedGroups","value":"ORG_ADMIN"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/role-insights/{insightId}/current-entitlements","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get current entitlement for a role","description":{"content":"This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding.","type":"text/plain"},"url":{"path":["role-insights",":insightId","current-entitlements"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Filter parameter(s) by \"starts with\" for the name and description.","type":"text/plain"},"key":"filters","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The role insight id","type":"text/plain"},"type":"any","value":"","key":"insightId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get current entitlement for a role' (get-role-insights-current-entitlements)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get current entitlement for a role + + + +This endpoint gets the entitlements for a role. The term "current" is to distinguish from the entitlement(s) an insight might recommend adding. + +
Path Parameters
Query Parameters
+ +Succeeded. Returns a list of current or pre-existing entitlements for a role. + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-role-insights-entitlements-changes.api.mdx b/products/idn/api/beta/get-role-insights-entitlements-changes.api.mdx new file mode 100644 index 000000000..6b0cb7a52 --- /dev/null +++ b/products/idn/api/beta/get-role-insights-entitlements-changes.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-role-insights-entitlements-changes +sidebar_label: Get entitlement insights for a role +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRoleInsightsEntitlementsChanges","tags":["Role Insights"],"description":"This endpoint returns entitlement insights for a role.","parameters":[{"in":"path","name":"insightId","schema":{"type":"string"},"required":true,"description":"The role insight id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"query","name":"sorters","description":"sort by identitiesWithAccess or name","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"in":"query","name":"filters","description":"Filter parameter(s) by \"starts with\" for the name and description.","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Succeeded. Returns a list of entitlements to be added for a role.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the entitlement"},"id":{"type":"string","description":"Id of the entitlement"},"description":{"type":"string","description":"Description for the entitlement"},"attribute":{"type":"string","description":"Attribute for the entitlement"},"value":{"type":"string","description":"Attribute value for the entitlement"},"source":{"type":"string","description":"Source or the application for the entitlement"},"insight":{"description":"The kind of insight this is and some stats","type":"object","properties":{"type":{"type":"string","description":"The number of identities in this role with the entitlement.","example":"ADD"},"identitiesWithAccess":{"type":"integer","description":"The number of identities in this role with the entitlement.","example":850},"identitiesImpacted":{"type":"integer","description":"The number of identities in this role that do not have the specified entitlement.","example":150},"totalNumberOfIdentities":{"type":"integer","description":"The total number of identities.","example":1000}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/role-insights/{insightId}/entitlement-changes","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get entitlement insights for a role","description":{"content":"This endpoint returns entitlement insights for a role.","type":"text/plain"},"url":{"path":["role-insights",":insightId","entitlement-changes"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"sort by identitiesWithAccess or name","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"Filter parameter(s) by \"starts with\" for the name and description.","type":"text/plain"},"key":"filters","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The role insight id","type":"text/plain"},"type":"any","value":"","key":"insightId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get entitlement insights for a role' (get-role-insights-entitlements-changes)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get entitlement insights for a role + + + +This endpoint returns entitlement insights for a role. + +
Path Parameters
Query Parameters
+ +Succeeded. Returns a list of entitlements to be added for a role. + +
Schema array
    insight object
    + +The kind of insight this is and some stats + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-role-insights-requests.api.mdx b/products/idn/api/beta/get-role-insights-requests.api.mdx new file mode 100644 index 000000000..cc6d34378 --- /dev/null +++ b/products/idn/api/beta/get-role-insights-requests.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-role-insights-requests +sidebar_label: Returns the metadata for a request in order to generate insights for roles. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRoleInsightsRequests","tags":["Role Insights"],"description":"This endpoint returns details of a prior request.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The role insights request id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"}],"responses":{"200":{"description":"Succeeded. Returns details of an earlier role insights request.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Request Id for a role insight generation request","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},"createdDate":{"type":"string","format":"date-time","description":"The date-time role insights request was created.","example":"2020-09-16T18:49:32.150Z"},"lastGenerated":{"type":"string","format":"date-time","description":"The date-time role insights request was completed.","example":"2020-09-16T18:50:12.150Z"},"numberOfUpdates":{"type":"integer","description":"Total number of updates for this request. Starts with 0 and will have correct number when request is COMPLETED.","example":0},"roleIds":{"description":"The role IDs that are in this request.","type":"array","items":{"type":"string"}},"status":{"type":"string","description":"Request status","enum":["CREATED","IN PROGRESS","COMPLETED","FAILED"]}},"example":{"id":"c9aa02f7-86b0-4bc4-84bd-3116a6131e77","createdDate":"2020-09-16T18:49:32.150Z","lastGenerated":"2020-09-16T18:49:32.150Z","numberOfUpdates":0,"roleIds":["2c91808e720e94f8017253287c0a44f4","2c918087723ac2800172532191540e03","2c9180986e4c8592016e6b15eaef447c"],"status":"CREATED"}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/role-insights/requests/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Returns the metadata for a request in order to generate insights for roles.","description":{"content":"This endpoint returns details of a prior request.","type":"text/plain"},"url":{"path":["role-insights","requests",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The role insights request id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns the metadata for a request in order to generate insights for roles.' (get-role-insights-requests)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns the metadata for a request in order to generate insights for roles. + + + +This endpoint returns details of a prior request. + +
Path Parameters
+ +Succeeded. Returns details of an earlier role insights request. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-role-insights-summary.api.mdx b/products/idn/api/beta/get-role-insights-summary.api.mdx new file mode 100644 index 000000000..c52e8427b --- /dev/null +++ b/products/idn/api/beta/get-role-insights-summary.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-role-insights-summary +sidebar_label: Get role insights summary information +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRoleInsightsSummary","tags":["Role Insights"],"description":"This method returns high level summary information for role insights for a customer.","responses":{"200":{"description":"Succeeded. Returns high level counts.","content":{"application/json":{"schema":{"type":"object","properties":{"numberOfUpdates":{"type":"integer","description":"Total number of roles with updates"},"lastGenerated":{"type":"string","format":"date-time","description":"The date-time role insights were last found.","example":"2020-05-19T13:49:37.385Z"},"entitlementsIncludedInRoles":{"type":"integer","description":"The number of entitlements included in roles (vs free radicals).","example":45},"totalNumberOfEntitlements":{"type":"integer","description":"The total number of entitlements.","example":250},"identitiesWithAccessViaRoles":{"type":"integer","description":"The number of identities in roles vs. identities with just entitlements and not in roles.","example":550},"totalNumberOfIdentities":{"type":"integer","description":"The total number of identities.","example":980}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/role-insights/summary","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get role insights summary information","description":{"content":"This method returns high level summary information for role insights for a customer.","type":"text/plain"},"url":{"path":["role-insights","summary"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get role insights summary information' (get-role-insights-summary)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get role insights summary information + + + +This method returns high level summary information for role insights for a customer. + +
+ +Succeeded. Returns high level counts. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-role-insights.api.mdx b/products/idn/api/beta/get-role-insights.api.mdx new file mode 100644 index 000000000..1189e2141 --- /dev/null +++ b/products/idn/api/beta/get-role-insights.api.mdx @@ -0,0 +1,79 @@ +--- +id: get-role-insights +sidebar_label: Get role insights +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRoleInsights","tags":["Role Insights"],"description":"This method returns detailed role insights for each role.","parameters":[{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"name":"sorters","in":"query","description":"sort by numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities (default- ascending)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"filters","in":"query","description":"Filter parameter(s) by \"starts with\" for the name, ownerName and description.","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Succeeded. Returns a list of roles with information about insights for each role.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Insight id","example":"1467e61e-f284-439c-ba2d-c6cc11cf0941"},"numberOfUpdates":{"type":"integer","description":"Total number of updates for this role","example":5},"createdDate":{"type":"string","format":"date-time","description":"The date-time insights were last created for this role.","example":"2020-05-19T13:49:37.385Z"},"role":{"description":"A role","type":"object","properties":{"name":{"type":"string","description":"Role name","example":"Software Engineer"},"id":{"type":"string","description":"Role id","example":"1467e61e-f284-439c-ba2d-c6cc11cf0941"},"description":{"type":"string","description":"Role description","example":"Person who develops software"},"ownerName":{"type":"string","description":"Role owner name","example":"Bob"},"ownerId":{"type":"string","description":"Role owner id","example":"1467e61e-f284-439c-ba2d-c6cc11cf0941"}}},"insight":{"description":"The kind of insight this is and some stats","type":"object","properties":{"type":{"type":"string","description":"The number of identities in this role with the entitlement.","example":"ADD"},"identitiesWithAccess":{"type":"integer","description":"The number of identities in this role with the entitlement.","example":850},"identitiesImpacted":{"type":"integer","description":"The number of identities in this role that do not have the specified entitlement.","example":150},"totalNumberOfIdentities":{"type":"integer","description":"The total number of identities.","example":1000}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/role-insights","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get role insights","description":{"content":"This method returns detailed role insights for each role.","type":"text/plain"},"url":{"path":["role-insights"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"sort by numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities (default- ascending)","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"Filter parameter(s) by \"starts with\" for the name, ownerName and description.","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get role insights' (get-role-insights)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get role insights + + + +This method returns detailed role insights for each role. + +
Query Parameters
+ +Succeeded. Returns a list of roles with information about insights for each role. + +
Schema array
    role object
    + +A role + +
    insight object
    + +The kind of insight this is and some stats + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-role-mining-session-status.api.mdx b/products/idn/api/beta/get-role-mining-session-status.api.mdx new file mode 100644 index 000000000..75c641415 --- /dev/null +++ b/products/idn/api/beta/get-role-mining-session-status.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-role-mining-session-status +sidebar_label: Get role mining session status state +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRoleMiningSessionStatus","tags":["IAI Role Mining"],"description":"This method returns a role mining session status for a customer.","parameters":[{"in":"path","name":"sessionId","schema":{"type":"string"},"required":true,"description":"The role mining session id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"}],"responses":{"200":{"description":"Succeeded. Returns session status","content":{"application/json":{"schema":{"type":"object","properties":{"state":{"description":"The role mining session status. Can be one of these states - CREATED|UPDATED|IDENTITIES_OBTAINED|PRUNE_THRESHOLD_OBTAINED|POTENTIAL_ROLES_PROCESSING|POTENTIAL_ROLES_CREATED","type":"string","example":"CREATED"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/role-mining-sessions/{sessionId}/status","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get role mining session status state","description":{"content":"This method returns a role mining session status for a customer.","type":"text/plain"},"url":{"path":["role-mining-sessions",":sessionId","status"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The role mining session id","type":"text/plain"},"type":"any","value":"","key":"sessionId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get role mining session status state' (get-role-mining-session-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get role mining session status state + + + +This method returns a role mining session status for a customer. + +
Path Parameters
+ +Succeeded. Returns session status + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-role-mining-session.api.mdx b/products/idn/api/beta/get-role-mining-session.api.mdx new file mode 100644 index 000000000..ecd6d0d7d --- /dev/null +++ b/products/idn/api/beta/get-role-mining-session.api.mdx @@ -0,0 +1,103 @@ +--- +id: get-role-mining-session +sidebar_label: Get a role mining session +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRoleMiningSession","tags":["IAI Role Mining"],"description":"The method retrieves a role mining session.","parameters":[{"in":"path","name":"sessionId","schema":{"type":"string"},"required":true,"description":"The role mining session id to be retrieved.","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"}],"responses":{"200":{"description":"Returns a role mining session","content":{"application/json":{"schema":{"type":"object","properties":{"scope":{"description":"The scope of identities for this role mining session","type":"object","properties":{"identityIds":{"type":"array","items":{"type":"string"},"description":"The list of identities for this role mining session.","example":["2c918090761a5aac0176215c46a62d58","2c918090761a5aac01722015c46a62d42"]},"criteria":{"type":"string","description":"The \"search\" criteria that produces the list of identities for this role mining session.","example":"source.name:DataScienceDataset"},"attributeFilterCriteria":{"type":"array","items":{"type":"object"},"description":"The filter criteria for this role mining session.","example":{"displayName":{"untranslated":"Location: Miami"},"ariaLabel":{"untranslated":"Location: Miami"},"data":{"displayName":{"translateKey":"IDN.IDENTITY_ATTRIBUTES.LOCATION"},"name":"location","operator":"EQUALS","values":["Miami"]}}}}},"minNumIdentitiesInPotentialRole":{"type":"integer","description":"Minimum number of identities in a potential role","example":20},"prescribedPruneThreshold":{"type":"integer","description":"The computed (or prescribed) prune threshold for this session","example":83},"pruneThreshold":{"type":"integer","description":"The prune threshold to be used for this role mining session","example":70},"potentialRoleCount":{"type":"integer","description":"The number of potential roles","example":8},"potentialRolesReadyCount":{"type":"integer","description":"The number of potential roles which have completed processing","example":4},"status":{"description":"The role mining session status","type":"object","properties":{"state":{"description":"The role mining session status. Can be one of these states - CREATED|UPDATED|IDENTITIES_OBTAINED|PRUNE_THRESHOLD_OBTAINED|POTENTIAL_ROLES_PROCESSING|POTENTIAL_ROLES_CREATED","type":"string","example":"CREATED"}}},"id":{"type":"string","description":"Session Id for this role mining session","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},"createdDate":{"type":"string","format":"date-time","description":"The date-time when this role mining session was created."},"modifiedDate":{"type":"string","format":"date-time","description":"The date-time when this role mining session was completed."},"type":{"description":"Role mining session type","type":"string","enum":["SPECIALIZED","COMMON"],"example":"SPECIALIZED"}},"example":{"scope":{"identityIds":[],"criteria":"source.name:DataScienceDataset"},"minNumIdentitiesInPotentialRole":20,"pruneThreshold":70,"prescribedPruneThreshold":83,"potentialRoleCount":8,"potentialRolesReadyCount":4,"status":{"state":"POTENTIAL_ROLES_PROCESSING"},"id":"602ba738-cf48-499b-a780-7b67b3fc1ecf","createdDate":"2021-09-08T16:11:05.348Z","modifiedDate":"2021-09-08T16:11:05.348Z","type":"SPECIALIZED"}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/role-mining-sessions/{sessionId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get a role mining session","description":{"content":"The method retrieves a role mining session.","type":"text/plain"},"url":{"path":["role-mining-sessions",":sessionId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The role mining session id to be retrieved.","type":"text/plain"},"type":"any","value":"","key":"sessionId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a role mining session' (get-role-mining-session)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a role mining session + + + +The method retrieves a role mining session. + +
Path Parameters
+ +Returns a role mining session + +
Schema
    scope object
    + +The scope of identities for this role mining session + +
    status object
    + +The role mining session status + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-role-mining-sessions.api.mdx b/products/idn/api/beta/get-role-mining-sessions.api.mdx new file mode 100644 index 000000000..b4f2d6131 --- /dev/null +++ b/products/idn/api/beta/get-role-mining-sessions.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-role-mining-sessions +sidebar_label: Retrieves all role mining sessions +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRoleMiningSessions","tags":["IAI Role Mining"],"description":"Returns all role mining sessions that match the query parameters","parameters":[{"in":"query","name":"filters","schema":{"type":"string"},"description":"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: **saved**: *eq* \"true\" or \"false\" **name**: *eq, sw*","example":"saved eq \"true\" and name sw \"RM Session\""},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"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: **createdBy, createdDate**","example":"createdBy,createdDate"},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Succeeded. Returns all role mining sessions that match the query parameters.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"scope":{"description":"The scope of identities for this role mining session","example":{"identityIds":[],"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"]}}},"type":"object","properties":{"identityIds":{"type":"array","items":{"type":"string"},"description":"The list of identities for this role mining session.","example":["2c918090761a5aac0176215c46a62d58","2c918090761a5aac01722015c46a62d42"]},"criteria":{"type":"string","description":"The \"search\" criteria that produces the list of identities for this role mining session.","example":"source.name:DataScienceDataset"},"attributeFilterCriteria":{"type":"array","items":{"type":"object"},"description":"The filter criteria for this role mining session.","example":{"displayName":{"untranslated":"Location: Miami"},"ariaLabel":{"untranslated":"Location: Miami"},"data":{"displayName":{"translateKey":"IDN.IDENTITY_ATTRIBUTES.LOCATION"},"name":"location","operator":"EQUALS","values":["Miami"]}}}}},"pruneThreshold":{"type":"integer","description":"The prune threshold to be used or null to calculate prescribedPruneThreshold","example":5,"format":"int32"},"prescribedPruneThreshold":{"type":"integer","description":"The calculated prescribedPruneThreshold","example":10,"format":"int32"},"minNumIdentitiesInPotentialRole":{"type":"integer","description":"Minimum number of identities in a potential role","example":20,"format":"int32"},"potentialRoleCount":{"type":"integer","description":"Number of potential roles","example":0,"format":"int32"},"potentialRolesReadyCount":{"type":"integer","description":"Number of potential roles ready","example":0,"format":"int32"},"status":{"description":"The status of the role mining session","example":"CREATED","type":"object","properties":{"state":{"description":"The role mining session status. Can be one of these states - CREATED|UPDATED|IDENTITIES_OBTAINED|PRUNE_THRESHOLD_OBTAINED|POTENTIAL_ROLES_PROCESSING|POTENTIAL_ROLES_CREATED","type":"string","example":"CREATED"}}},"type":{"description":"Role mining session type","example":"SPECIALIZED","type":"string","enum":["SPECIALIZED","COMMON"]},"emailRecipientId":{"type":"string","description":"The id of the user who will receive an email about the role mining session","example":"2c918090761a5aac0176215c46a62d58"},"createdBy":{"description":"The session created by details","type":"object","properties":{"id":{"type":"string","description":"ID of the creator","example":"2c918090761a5aac0176215c46a62d58"},"displayName":{"type":"string","description":"The display name of the creator","example":"Ashley.Pierce"}}},"identityCount":{"type":"integer","description":"Number of identities in the population which meet the search criteria or identity list provided","example":0,"format":"int32"},"saved":{"type":"boolean","description":"The session's saved status","example":true},"name":{"type":"string","description":"The session's saved name","example":"Saved RM Session - 07/10"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/role-mining-sessions","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Retrieves all role mining sessions","description":{"content":"Returns all role mining sessions that match the query parameters","type":"text/plain"},"url":{"path":["role-mining-sessions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"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: **saved**: *eq* \"true\" or \"false\" **name**: *eq, sw*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"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: **createdBy, createdDate**","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Retrieves all role mining sessions' (get-role-mining-sessions)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieves all role mining sessions + + + +Returns all role mining sessions that match the query parameters + +
Query Parameters
+ +Succeeded. Returns all role mining sessions that match the query parameters. + +
Schema array
    scope object
    + +The scope of identities for this role mining session + +
    status object
    + +The status of the role mining session + +
    createdBy object
    + +The session created by details + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-role.api.mdx b/products/idn/api/beta/get-role.api.mdx new file mode 100644 index 000000000..c84c7714f --- /dev/null +++ b/products/idn/api/beta/get-role.api.mdx @@ -0,0 +1,133 @@ +--- +id: get-role +sidebar_label: Get a Role +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRole","tags":["Roles"],"description":"This API returns a Role by its ID.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"ID of the Role","example":"2c91808a7813090a017814121e121518"}],"responses":{"200":{"description":"List of all Roles","content":{"application/json":{"schema":{"type":"object","description":"A Role","properties":{"id":{"type":"string","description":"The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.","example":"2c918086749d78830174a1a40e121518"},"name":{"type":"string","description":"The human-readable display name of the Role","maxLength":128,"example":"Role 2567"},"created":{"type":"string","description":"Date the Role was created","format":"date-time","example":"2021-03-01T22:32:58.104Z","readOnly":true},"modified":{"type":"string","description":"Date the Role was last modified.","format":"date-time","example":"2021-03-02T20:22:28.104Z","readOnly":true},"description":{"type":"string","nullable":true,"description":"A human-readable description of the Role","example":"Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor."},"owner":{"type":"object","nullable":true,"description":"The owner of this object.","properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"accessProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the Access Profile","example":"ff808081751e6e129f1518161919ecca"},"type":{"type":"string","description":"Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result.","enum":["ACCESS_PROFILE"],"example":"ACCESS_PROFILE"},"name":{"type":"string","description":"Human-readable display name of the Access Profile. This field is ignored on input.","example":"Access Profile 2567"}}},"nullable":true},"membership":{"nullable":true,"type":"object","description":"When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.","properties":{"type":{"type":"string","enum":["STANDARD","IDENTITY_LIST"],"description":"This enum characterizes the type of a Role's membership selector. Only the following two are fully supported:\n\nSTANDARD: Indicates that Role membership is defined in terms of a criteria expression\n\nIDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed","example":"IDENTITY_LIST"},"criteria":{"nullable":true,"type":"object","description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","nullable":true,"description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","nullable":true,"description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","nullable":true,"description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa."}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa."}}},"identities":{"type":"array","items":{"type":"object","description":"A reference to an Identity in an IDENTITY_LIST role membership criteria.","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY","nullable":true},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","nullable":true,"description":"Human-readable display name of the Identity.","example":"Thomas Edison"},"aliasName":{"type":"string","nullable":true,"description":"User name of the Identity","example":"t.edison"}}},"nullable":true,"description":"Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST."}}},"legacyMembershipInfo":{"type":"object","nullable":true,"description":"This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.","example":{"type":"IDENTITY_LIST"},"additionalProperties":true},"enabled":{"type":"boolean","description":"Whether the Role is enabled or not.","example":true,"default":false},"requestable":{"type":"boolean","description":"Whether the Role can be the target of access requests.","example":true,"default":false},"accessRequestConfig":{"nullable":true,"description":"Access request configuration for this object","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":true,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":true,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n\n**OWNER**: Owner of the associated Role\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"revocationRequestConfig":{"nullable":true,"default":null,"description":"Revocation request configuration for this object.","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":false,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":false,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the revocation request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"segments":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of IDs of segments, if any, to which this Role is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]}},"required":["name","owner"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:role-unchecked:read","idn:role-unchecked:manage","idn:role-checked:manage","idn:role-checked:read"]}],"method":"get","path":"/roles/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get a Role","description":{"content":"This API returns a Role by its ID.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.","type":"text/plain"},"url":{"path":["roles",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Role","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a Role' (get-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a Role + + + +This API returns a Role by its ID. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +
Path Parameters
+ +List of all Roles + +
Schema
    owner object
    + +The owner of this object. + +
    accessProfiles object[]
    membership object
    + +When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities. + +
    criteria object
    + +Defines STANDARD type Role membership + +
    key object
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]
    + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + +
    key object
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]
    + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + +
    key object
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    identities object[]
    + +Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. + +
    legacyMembershipInfo object
    + +This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. + +
    accessRequestConfig object
    + +Access request configuration for this object + +
    approvalSchemes object[]
    + +List describing the steps in approving the request + +
    revocationRequestConfig object
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]
    + +List describing the steps in approving the revocation request + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-search-attribute-config.api.mdx b/products/idn/api/beta/get-search-attribute-config.api.mdx new file mode 100644 index 000000000..efe613800 --- /dev/null +++ b/products/idn/api/beta/get-search-attribute-config.api.mdx @@ -0,0 +1,64 @@ +--- +id: get-search-attribute-config +sidebar_label: Retrieve a list of extended search attributes in IdentityNow. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getSearchAttributeConfig","tags":["Search Attribute Configuration"],"description":"This API retrieves a list of attribute/application associates currently configured in IdentityNow.\nA token with ORG_ADMIN authority is required to call this API.","responses":{"200":{"description":"List of attribute configurations in IdentityNow.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the new attribute","example":"newMailAttribute"},"displayName":{"type":"string","description":"The display name of the new attribute","example":"New Mail Attribute"},"applicationAttributes":{"type":"object","description":"Map of application id and their associated attribute.","example":{"2c91808b79fd2422017a0b35d30f3968":"employeeNumber","2c91808b79fd2422017a0b36008f396b":"employeeNumber"}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/accounts/search-attribute-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Retrieve a list of extended search attributes in IdentityNow.","description":{"content":"This API retrieves a list of attribute/application associates currently configured in IdentityNow.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts","search-attribute-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Retrieve a list of extended search attributes in IdentityNow.' (get-search-attribute-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieve a list of extended search attributes in IdentityNow. + + + +This API retrieves a list of attribute/application associates currently configured in IdentityNow. +A token with ORG_ADMIN authority is required to call this API. + +
+ +List of attribute configurations in IdentityNow. + +
Schema array
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-segment.api.mdx b/products/idn/api/beta/get-segment.api.mdx new file mode 100644 index 000000000..bd02c00b7 --- /dev/null +++ b/products/idn/api/beta/get-segment.api.mdx @@ -0,0 +1,85 @@ +--- +id: get-segment +sidebar_label: Get a Segment by its ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getSegment","tags":["Segments"],"description":"This API returns the segment specified by the given ID.\n\nA token with ORG_ADMIN or API authority is required to call this API.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the Segment to retrieve.","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"Segment","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"name":{"type":"string","description":"Segment Business Name","example":"segment-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this Segment is created","example":"2020-01-01T00:00:00.000000Z"},"modified":{"type":"string","format":"date-time","description":"The time when this Segment is modified","example":"2020-01-01T00:00:00.000000Z"},"description":{"type":"string","description":"Optional description of the Segment","example":"This segment represents xyz"},"owner":{"type":"object","nullable":true,"description":"The owner of this object.","properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"visibilityCriteria":{"type":"object","properties":{"expression":{"type":"object","properties":{"operator":{"type":"string","description":"Operator for the expression","enum":["AND","EQUALS"],"example":"EQUALS"},"attribute":{"type":"string","description":"Name for the attribute","example":"location"},"value":{"type":"object","properties":{"type":{"type":"string","description":"The type of attribute value","example":"STRING"},"value":{"type":"string","description":"The attribute value","example":"Austin"}}},"children":{"type":"array","description":"List of expressions","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of attribute value","example":"STRING"},"value":{"type":"string","description":"The attribute value","example":"Austin"}}},"example":[]}}}}},"active":{"type":"boolean","description":"Whether the Segment is currently active. Inactive segments have no effect."}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/segments/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get a Segment by its ID","description":{"content":"This API returns the segment specified by the given ID.\n\nA token with ORG_ADMIN or API authority is required to call this API.","type":"text/plain"},"url":{"path":["segments",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the Segment to retrieve.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a Segment by its ID' (get-segment)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a Segment by its ID + + + +This API returns the segment specified by the given ID. + +A token with ORG_ADMIN or API authority is required to call this API. + +
Path Parameters
+ +Segment + +
Schema
    owner object
    + +The owner of this object. + +
    visibilityCriteria object
    expression object
    value object
    children object[]
    + +List of expressions + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-service-desk-integration-list.api.mdx b/products/idn/api/beta/get-service-desk-integration-list.api.mdx new file mode 100644 index 000000000..8f368a1c1 --- /dev/null +++ b/products/idn/api/beta/get-service-desk-integration-list.api.mdx @@ -0,0 +1,115 @@ +--- +id: get-service-desk-integration-list +sidebar_label: List existing Service Desk Integrations +hide_title: true +hide_table_of_contents: true +api: {"tags":["Service Desk Integration"],"description":"Get a list of ServiceDeskIntegrationDto for existing Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","operationId":"getServiceDeskIntegrationList","parameters":[{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"name":"sorters","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**","example":"name"},{"name":"filters","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"comma-separated"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq*\n\n**type**: *eq, in*\n\n**cluster**: *eq, in*","example":"id eq 2c91808b6ef1d43e016efba0ce470904"},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"List of ServiceDeskIntegrationDto","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"},"modified":{"description":"Last modification date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}},{"type":"object","description":"Specification of a Service Desk integration","required":["description","type","attributes"],"properties":{"description":{"description":"Description of the Service Desk integration","type":"string","example":"A very nice Service Desk integration"},"type":{"description":"Service Desk integration types\n\n- ServiceNowSDIM\n- ServiceNow\n","type":"string","default":"ServiceNowSDIM","example":"ServiceNowSDIM"},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the identity that is the owner of this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the identity","example":"MyName"}}},"clusterRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the source cluster for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"cluster":{"description":"ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)","type":"string","example":"xyzzy999","deprecated":true},"managedSources":{"description":"Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)","type":"array","items":{"type":"string"},"deprecated":true,"example":["2c9180835d191a86015d28455b4a2329","2c5680835d191a85765d28455b4a9823"]},"provisioningConfig":{"description":"The 'provisioningConfig' property specifies the configuration used to provision integrations.","type":"object","properties":{"universalManager":{"description":"Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.","type":"boolean","readOnly":true,"example":true},"managedResourceRefs":{"description":"References to sources for the Service Desk integration template. May only be specified if universalManager is false.","type":"array","items":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"properties":{"type":{"description":"The type of object being referenced","enum":["SOURCE"],"example":"SOURCE"},"id":{"description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the source","example":"My Source"}}},"example":[{"type":"SOURCE","id":"2c9180855d191c59015d291ceb051111","name":"My Source 1"},{"type":"SOURCE","id":"2c9180855d191c59015d291ceb052222","name":"My Source 2"}]},"planInitializerScript":{"description":"This is a reference to a plan initializer script.","type":"object","properties":{"source":{"description":"This is a Rule that allows provisioning instruction changes.","type":"string","example":"\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n"}}},"noProvisioningRequests":{"description":"Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.","type":"boolean","example":true},"provisioningRequestExpiration":{"description":"When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.","type":"integer","format":"int32","example":7}}},"attributes":{"description":"Attributes of the Service Desk integration. Validation constraints enforced by the implementation.","type":"object","additionalProperties":true,"example":{"property":"value","key":"value"}},"beforeProvisioningRule":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to beforeProvisioningRule for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["RULE"],"example":"RULE"},"id":{"description":"ID of the rule","example":"2c91808568c529c60168cca6f90c1333"},"name":{"description":"Human-readable display name of the rule","example":"Example Rule"}}}}}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:service-desk-admin:read","idn:service-desk-integration:read"]}],"method":"get","path":"/service-desk-integrations","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List existing Service Desk Integrations","description":{"content":"Get a list of ServiceDeskIntegrationDto for existing Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","type":"text/plain"},"url":{"path":["service-desk-integrations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq*\n\n**type**: *eq, in*\n\n**cluster**: *eq, in*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List existing Service Desk Integrations' (get-service-desk-integration-list)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List existing Service Desk Integrations + + + +Get a list of ServiceDeskIntegrationDto for existing Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +
Query Parameters
+ +List of ServiceDeskIntegrationDto + +
Schema array
    ownerRef object
    + +Reference to the identity that is the owner of this Service Desk integration + +
    clusterRef object
    + +Reference to the source cluster for this Service Desk integration + +
    provisioningConfig object
    + +The 'provisioningConfig' property specifies the configuration used to provision integrations. + +
    managedResourceRefs object[]
    + +References to sources for the Service Desk integration template. May only be specified if universalManager is false. + +
    planInitializerScript object
    + +This is a reference to a plan initializer script. + +
    attributes object
    + +Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + +
    beforeProvisioningRule object
    + +Reference to beforeProvisioningRule for this Service Desk integration + +
\\\\r\\\\n\\\\r\\\\n\\\\r\\\\n Before Provisioning Rule which changes disables and enables to a modify.\\\\r\\\\n \\n\"\n },\n \"noProvisioningRequests\": true,\n \"provisioningRequestExpiration\": 7\n },\n \"attributes\": {\n \"property\": \"value\",\n \"key\": \"value\"\n },\n \"beforeProvisioningRule\": {\n \"type\": true,\n \"id\": true,\n \"name\": true\n }\n }\n]"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-service-desk-integration-template.api.mdx b/products/idn/api/beta/get-service-desk-integration-template.api.mdx new file mode 100644 index 000000000..b2370e2d4 --- /dev/null +++ b/products/idn/api/beta/get-service-desk-integration-template.api.mdx @@ -0,0 +1,103 @@ +--- +id: get-service-desk-integration-template +sidebar_label: Service Desk integration template by scriptName. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Service Desk Integration"],"description":"This API endpoint returns an existing Service Desk integration template by scriptName. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","operationId":"getServiceDeskIntegrationTemplate","parameters":[{"name":"scriptName","in":"path","description":"The scriptName value of the Service Desk integration template to get","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"aScriptName"}}],"responses":{"200":{"description":"Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"},"modified":{"description":"Last modification date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}},{"type":"object","description":"This is the model for a Service Desk integration template, used to create and edit Service Desk Integrations.","required":["type","attributes","provisioningConfig"],"properties":{"type":{"description":"The 'type' property specifies the type of the Service Desk integration template.","type":"string","example":"Web Service SDIM","default":"Web Service SDIM"},"attributes":{"description":"The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template.","type":"object","additionalProperties":true},"provisioningConfig":{"description":"The 'provisioningConfig' property specifies the configuration used to provision integrations using the template.","type":"object","properties":{"universalManager":{"description":"Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.","type":"boolean","readOnly":true,"example":true},"managedResourceRefs":{"description":"References to sources for the Service Desk integration template. May only be specified if universalManager is false.","type":"array","items":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"properties":{"type":{"description":"The type of object being referenced","enum":["SOURCE"],"example":"SOURCE"},"id":{"description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the source","example":"My Source"}}},"example":[{"type":"SOURCE","id":"2c9180855d191c59015d291ceb051111","name":"My Source 1"},{"type":"SOURCE","id":"2c9180855d191c59015d291ceb052222","name":"My Source 2"}]},"planInitializerScript":{"description":"This is a reference to a plan initializer script.","type":"object","properties":{"source":{"description":"This is a Rule that allows provisioning instruction changes.","type":"string","example":"\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n"}}},"noProvisioningRequests":{"description":"Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.","type":"boolean","example":true},"provisioningRequestExpiration":{"description":"When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.","type":"integer","format":"int32","example":7}}}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:service-desk-admin:read","idn:service-desk-integration:read"]}],"method":"get","path":"/service-desk-integrations/templates/{scriptName}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Service Desk integration template by scriptName.","description":{"content":"This API endpoint returns an existing Service Desk integration template by scriptName. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","type":"text/plain"},"url":{"path":["service-desk-integrations","templates",":scriptName"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The scriptName value of the Service Desk integration template to get","type":"text/plain"},"type":"any","value":"","key":"scriptName"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Service Desk integration template by scriptName.' (get-service-desk-integration-template)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Service Desk integration template by scriptName. + + + +This API endpoint returns an existing Service Desk integration template by scriptName. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +
Path Parameters
+ +Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName. + +
Schema
    attributes object
    + +The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template. + +
    provisioningConfig object
    + +The 'provisioningConfig' property specifies the configuration used to provision integrations using the template. + +
    managedResourceRefs object[]
    + +References to sources for the Service Desk integration template. May only be specified if universalManager is false. + +
    planInitializerScript object
    + +This is a reference to a plan initializer script. + +
\\\\r\\\\n\\\\r\\\\n\\\\r\\\\n Before Provisioning Rule which changes disables and enables to a modify.\\\\r\\\\n \\n\"\n },\n \"noProvisioningRequests\": true,\n \"provisioningRequestExpiration\": 7\n }\n}"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-service-desk-integration-types.api.mdx b/products/idn/api/beta/get-service-desk-integration-types.api.mdx new file mode 100644 index 000000000..d91e60e8a --- /dev/null +++ b/products/idn/api/beta/get-service-desk-integration-types.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-service-desk-integration-types +sidebar_label: Service Desk Integration Types List. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Service Desk Integration"],"description":"This API endpoint returns the current list of supported Service Desk integration types. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","operationId":"getServiceDeskIntegrationTypes","responses":{"200":{"description":"Responds with an array of the currently supported Service Desk integration types.","content":{"application/json":{"schema":{"type":"array","items":{"description":"This represents a Service Desk Integration template type.","required":["type","scriptName"],"type":"object","properties":{"name":{"description":"This is the name of the type.","example":"aName","type":"string"},"type":{"description":"This is the type value for the type.","example":"aType","type":"string"},"scriptName":{"description":"This is the scriptName attribute value for the type.","example":"aScriptName","type":"string"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:service-desk-admin:read","idn:service-desk-admin:manage","idn:service-desk-integration:read","idn:service-desk-integration:manage"]}],"method":"get","path":"/service-desk-integrations/types","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Service Desk Integration Types List.","description":{"content":"This API endpoint returns the current list of supported Service Desk integration types. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","type":"text/plain"},"url":{"path":["service-desk-integrations","types"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Service Desk Integration Types List.' (get-service-desk-integration-types)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Service Desk Integration Types List. + + + +This API endpoint returns the current list of supported Service Desk integration types. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +
+ +Responds with an array of the currently supported Service Desk integration types. + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-service-desk-integration.api.mdx b/products/idn/api/beta/get-service-desk-integration.api.mdx new file mode 100644 index 000000000..7b2ec9c7b --- /dev/null +++ b/products/idn/api/beta/get-service-desk-integration.api.mdx @@ -0,0 +1,115 @@ +--- +id: get-service-desk-integration +sidebar_label: Get a Service Desk integration +hide_title: true +hide_table_of_contents: true +api: {"tags":["Service Desk Integration"],"description":"Get an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","operationId":"getServiceDeskIntegration","parameters":[{"name":"id","in":"path","description":"ID of the Service Desk integration to get","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"anId"}}],"responses":{"200":{"description":"ServiceDeskIntegrationDto with the given ID","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"},"modified":{"description":"Last modification date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}},{"type":"object","description":"Specification of a Service Desk integration","required":["description","type","attributes"],"properties":{"description":{"description":"Description of the Service Desk integration","type":"string","example":"A very nice Service Desk integration"},"type":{"description":"Service Desk integration types\n\n- ServiceNowSDIM\n- ServiceNow\n","type":"string","default":"ServiceNowSDIM","example":"ServiceNowSDIM"},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the identity that is the owner of this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the identity","example":"MyName"}}},"clusterRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the source cluster for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"cluster":{"description":"ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)","type":"string","example":"xyzzy999","deprecated":true},"managedSources":{"description":"Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)","type":"array","items":{"type":"string"},"deprecated":true,"example":["2c9180835d191a86015d28455b4a2329","2c5680835d191a85765d28455b4a9823"]},"provisioningConfig":{"description":"The 'provisioningConfig' property specifies the configuration used to provision integrations.","type":"object","properties":{"universalManager":{"description":"Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.","type":"boolean","readOnly":true,"example":true},"managedResourceRefs":{"description":"References to sources for the Service Desk integration template. May only be specified if universalManager is false.","type":"array","items":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"properties":{"type":{"description":"The type of object being referenced","enum":["SOURCE"],"example":"SOURCE"},"id":{"description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the source","example":"My Source"}}},"example":[{"type":"SOURCE","id":"2c9180855d191c59015d291ceb051111","name":"My Source 1"},{"type":"SOURCE","id":"2c9180855d191c59015d291ceb052222","name":"My Source 2"}]},"planInitializerScript":{"description":"This is a reference to a plan initializer script.","type":"object","properties":{"source":{"description":"This is a Rule that allows provisioning instruction changes.","type":"string","example":"\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n"}}},"noProvisioningRequests":{"description":"Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.","type":"boolean","example":true},"provisioningRequestExpiration":{"description":"When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.","type":"integer","format":"int32","example":7}}},"attributes":{"description":"Attributes of the Service Desk integration. Validation constraints enforced by the implementation.","type":"object","additionalProperties":true,"example":{"property":"value","key":"value"}},"beforeProvisioningRule":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to beforeProvisioningRule for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["RULE"],"example":"RULE"},"id":{"description":"ID of the rule","example":"2c91808568c529c60168cca6f90c1333"},"name":{"description":"Human-readable display name of the rule","example":"Example Rule"}}}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:service-desk-admin:read","idn:service-desk-integration:read"]}],"method":"get","path":"/service-desk-integrations/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get a Service Desk integration","description":{"content":"Get an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","type":"text/plain"},"url":{"path":["service-desk-integrations",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Service Desk integration to get","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a Service Desk integration' (get-service-desk-integration)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a Service Desk integration + + + +Get an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +
Path Parameters
+ +ServiceDeskIntegrationDto with the given ID + +
Schema
    ownerRef object
    + +Reference to the identity that is the owner of this Service Desk integration + +
    clusterRef object
    + +Reference to the source cluster for this Service Desk integration + +
    provisioningConfig object
    + +The 'provisioningConfig' property specifies the configuration used to provision integrations. + +
    managedResourceRefs object[]
    + +References to sources for the Service Desk integration template. May only be specified if universalManager is false. + +
    planInitializerScript object
    + +This is a reference to a plan initializer script. + +
    attributes object
    + +Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + +
    beforeProvisioningRule object
    + +Reference to beforeProvisioningRule for this Service Desk integration + +
\\\\r\\\\n\\\\r\\\\n\\\\r\\\\n Before Provisioning Rule which changes disables and enables to a modify.\\\\r\\\\n \\n\"\n },\n \"noProvisioningRequests\": true,\n \"provisioningRequestExpiration\": 7\n },\n \"attributes\": {\n \"property\": \"value\",\n \"key\": \"value\"\n },\n \"beforeProvisioningRule\": {\n \"type\": true,\n \"id\": true,\n \"name\": true\n }\n}"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-single-search-attribute-config.api.mdx b/products/idn/api/beta/get-single-search-attribute-config.api.mdx new file mode 100644 index 000000000..e5cf1313e --- /dev/null +++ b/products/idn/api/beta/get-single-search-attribute-config.api.mdx @@ -0,0 +1,80 @@ +--- +id: get-single-search-attribute-config +sidebar_label: Get the details of a specific extended search attribute in IdentityNow. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getSingleSearchAttributeConfig","tags":["Search Attribute Configuration"],"description":"This API accepts an extended attribute name and retrieves the corresponding extended attribute configuration.\nA token with ORG_ADMIN authority is required to call this API.","parameters":[{"name":"name","in":"path","description":"Name of the extended search attribute configuration to delete.","required":true,"schema":{"type":"string","example":"newMailAttribute"}}],"responses":{"200":{"description":"Specific attribute configuration in IdentityNow.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the new attribute","example":"newMailAttribute"},"displayName":{"type":"string","description":"The display name of the new attribute","example":"New Mail Attribute"},"applicationAttributes":{"type":"object","description":"Map of application id and their associated attribute.","example":{"2c91808b79fd2422017a0b35d30f3968":"employeeNumber","2c91808b79fd2422017a0b36008f396b":"employeeNumber"}}}}}}}},"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/accounts/search-attribute-config/{name}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get the details of a specific extended search attribute in IdentityNow.","description":{"content":"This API accepts an extended attribute name and retrieves the corresponding extended attribute configuration.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts","search-attribute-config",":name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Name of the extended search attribute configuration to delete.","type":"text/plain"},"type":"any","value":"","key":"name"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get the details of a specific extended search attribute in IdentityNow.' (get-single-search-attribute-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get the details of a specific extended search attribute in IdentityNow. + + + +This API accepts an extended attribute name and retrieves the corresponding extended attribute configuration. +A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
+ +Specific attribute configuration in IdentityNow. + +
Schema array
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-sod-all-report-run-status.api.mdx b/products/idn/api/beta/get-sod-all-report-run-status.api.mdx new file mode 100644 index 000000000..241a17ab3 --- /dev/null +++ b/products/idn/api/beta/get-sod-all-report-run-status.api.mdx @@ -0,0 +1,76 @@ +--- +id: get-sod-all-report-run-status +sidebar_label: Get multi-report run task status +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getSodAllReportRunStatus","tags":["SOD Policy"],"description":"This endpoint gets the status for a violation report for all policy run.\nRequires role of ORG_ADMIN.","responses":{"200":{"description":"Status of the violation report run task for all policy run.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object","properties":{"status":{"type":"string","enum":["SUCCESS","WARNING","ERROR","TERMINATED","TEMP_ERROR","PENDING"]}}}]},"example":{"status":"SUCCESS","type":"REPORT_RESULT","id":"37b3b32a-f394-46f8-acad-b5223969fa68","name":"Multi Query Report"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sod-violation-report","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get multi-report run task status","description":{"content":"This endpoint gets the status for a violation report for all policy run.\nRequires role of ORG_ADMIN.","type":"text/plain"},"url":{"path":["sod-violation-report"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get multi-report run task status' (get-sod-all-report-run-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get multi-report run task status + + + +This endpoint gets the status for a violation report for all policy run. +Requires role of ORG_ADMIN. + +
+ +Status of the violation report run task for all policy run. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-sod-policy-schedule.api.mdx b/products/idn/api/beta/get-sod-policy-schedule.api.mdx new file mode 100644 index 000000000..520d0681f --- /dev/null +++ b/products/idn/api/beta/get-sod-policy-schedule.api.mdx @@ -0,0 +1,93 @@ +--- +id: get-sod-policy-schedule +sidebar_label: Get SOD policy schedule +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getSodPolicySchedule","tags":["SOD Policy"],"description":"This endpoint gets a specified SOD policy's schedule.\nRequires the role of ORG_ADMIN.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the object reference to retrieve.","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"SOD policy ID.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"SOD Policy schedule name","example":"SCH-1584312283015"},"created":{"type":"string","format":"date-time","description":"The time when this SOD policy schedule is created.","example":"2020-01-01T00:00:00.000000Z"},"modified":{"type":"string","format":"date-time","description":"The time when this SOD policy schedule is modified.","example":"2020-01-01T00:00:00.000000Z"},"description":{"type":"string","description":"SOD Policy schedule description","example":"Schedule for policy xyz"},"schedule":{"type":"object","description":"The schedule information.","properties":{"type":{"description":"Enum representing the currently supported schedule types.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["DAILY","WEEKLY","MONTHLY","CALENDAR"],"example":"WEEKLY"},"days":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The days to execute the search.\n\nIf `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`.\n\nIf `type` is `MONTHLY`, the values will be a number in double quotes, like `\"1\"`, `\"10\"`, or `\"28\"`. Optionally, the value `\"L\"` can be used to refer to the last day of the month.\n","example":{"type":"LIST","values":["MON","WED","FRI"]},"nullable":true}]},"hours":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The hours selected.","example":{"type":"RANGE","values":["9","18"],"interval":3}}]},"expiration":{"description":"The schedule expiration date. Latest possible expiration date is '2038-01-19T03:14:07+0000'","type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"},"timeZoneId":{"description":"The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org's default timezone is used.","nullable":true,"type":"string","example":"GMT-06:00"}},"required":["type","hours"]},"recipients":{"type":"array","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}},"emailEmptyResults":{"type":"boolean","description":"Indicates if empty results need to be emailed","example":false},"creatorId":{"type":"string","description":"Policy's creator ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"modifierId":{"type":"string","description":"Policy's modifier ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sod-policies/{id}/schedule","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get SOD policy schedule","description":{"content":"This endpoint gets a specified SOD policy's schedule.\nRequires the role of ORG_ADMIN.","type":"text/plain"},"url":{"path":["sod-policies",":id","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the object reference to retrieve.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get SOD policy schedule' (get-sod-policy-schedule)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get SOD policy schedule + + + +This endpoint gets a specified SOD policy's schedule. +Requires the role of ORG_ADMIN. + +
Path Parameters
+ +SOD policy ID. + +
Schema
    schedule object
    + +The schedule information. + +
    days object
    + +The days to execute the search. + +If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. + +If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. + + +
    hours object
    + +The hours selected. + +
    recipients object[]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-sod-policy.api.mdx b/products/idn/api/beta/get-sod-policy.api.mdx new file mode 100644 index 000000000..d1fe8a5a3 --- /dev/null +++ b/products/idn/api/beta/get-sod-policy.api.mdx @@ -0,0 +1,96 @@ +--- +id: get-sod-policy +sidebar_label: Get SOD policy by ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getSodPolicy","tags":["SOD Policy"],"description":"This gets specified SOD policy.\nRequires role of ORG_ADMIN.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the object reference to retrieve.","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"SOD policy ID.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Policy id","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"name":{"type":"string","description":"Policy Business Name","example":"policy-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this SOD policy is created.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"modified":{"type":"string","format":"date-time","description":"The time when this SOD policy is modified.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"description":{"type":"string","description":"Optional description of the SOD policy","example":"This policy ensures compliance of xyz","nullable":true},"ownerRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"externalPolicyReference":{"type":"string","description":"Optional External Policy Reference","example":"XYZ policy","nullable":true},"policyQuery":{"type":"string","description":"Search query of the SOD policy","example":"@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)"},"compensatingControls":{"type":"string","description":"Optional compensating controls(Mitigating Controls)","example":"Have a manager review the transaction decisions for their \"out of compliance\" employee","nullable":true},"correctionAdvice":{"type":"string","description":"Optional correction advice","example":"Based on the role of the employee, managers should remove access that is not required for their job function.","nullable":true},"state":{"type":"string","description":"whether the policy is enforced or not","enum":["ENFORCED","NOT_ENFORCED"],"example":"ENFORCED"},"tags":{"type":"array","description":"tags for this policy object","example":["TAG1","TAG2"],"items":{"type":"string"}},"creatorId":{"type":"string","description":"Policy's creator ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"modifierId":{"type":"string","description":"Policy's modifier ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","nullable":true,"readOnly":true},"violationOwnerAssignmentConfig":{"nullable":true,"type":"object","properties":{"assignmentRule":{"type":"string","enum":["MANAGER","STATIC",null],"description":"Details about the violations owner.\nMANAGER - identity's manager\nSTATIC - Governance Group or Identity","example":"MANAGER","nullable":true},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"nullable":true}]}}},"scheduled":{"type":"boolean","description":"defines whether a policy has been scheduled or not","example":true,"default":false},"type":{"type":"string","description":"whether a policy is query based or conflicting access based","default":"GENERAL","enum":["GENERAL","CONFLICTING_ACCESS_BASED"],"example":"GENERAL"},"conflictingAccessCriteria":{"allOf":[{"type":"object","properties":{"leftCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"DTO type","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}},"rightCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"DTO type","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}}}},{"nullable":true}]}}},"examples":{"Conflicting Access Based Policy":{"value":{"id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"Conflicting-Policy-Name","created":"2020-01-01T00:00:00.000000Z","modified":"2020-01-01T00:00:00.000000Z","description":"This policy ensures compliance of xyz","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Owner Name"},"externalPolicyReference":"XYZ policy","policyQuery":"@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)","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":["string"],"creatorId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","modifierId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","violationOwnerAssignmentConfig":{"assignmentRule":"MANAGER","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Violation Owner Name"}},"scheduled":true,"type":"CONFLICTING_ACCESS_BASED","conflictingAccessCriteria":{"leftCriteria":{"name":"money-in","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67"}]},"rightCriteria":{"name":"money-out","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a68"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a69"}]}}}},"General Policy":{"value":{"description":"Description","ownerRef":{"type":"IDENTITY","id":"2c918087682f9a86016839c05e8f1aff","name":"Owner Name"},"externalPolicyReference":"New policy","policyQuery":"policy query implementation","compensatingControls":"Compensating controls","correctionAdvice":"Correction advice","tags":[],"state":"ENFORCED","scheduled":false,"creatorId":"2c918087682f9a86016839c05e8f1aff","modifierId":null,"violationOwnerAssignmentConfig":null,"type":"GENERAL","conflictingAccessCriteria":null,"id":"52c11db4-733e-4c31-949a-766c95ec95f1","name":"General-Policy-Name","created":"2020-05-12T19:47:38Z","modified":"2020-05-12T19:47:38Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sod-policies/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get SOD policy by ID","description":{"content":"This gets specified SOD policy.\nRequires role of ORG_ADMIN.","type":"text/plain"},"url":{"path":["sod-policies",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the object reference to retrieve.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get SOD policy by ID' (get-sod-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get SOD policy by ID + + + +This gets specified SOD policy. +Requires role of ORG_ADMIN. + +
Path Parameters
+ +SOD policy ID. + +
Schema
    ownerRef object
    violationOwnerAssignmentConfig object
    ownerRef object
    conflictingAccessCriteria object
    leftCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
    rightCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-sod-violation-report-run-status.api.mdx b/products/idn/api/beta/get-sod-violation-report-run-status.api.mdx new file mode 100644 index 000000000..1938ec8aa --- /dev/null +++ b/products/idn/api/beta/get-sod-violation-report-run-status.api.mdx @@ -0,0 +1,88 @@ +--- +id: get-sod-violation-report-run-status +sidebar_label: Get violation report run status +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getSodViolationReportRunStatus","tags":["SOD Policy"],"description":"This gets the status for a violation report run task that has already been invoked.\nRequires role of ORG_ADMIN.","parameters":[{"in":"path","name":"reportResultId","schema":{"type":"string"},"required":true,"description":"The ID of the report reference to retrieve.","example":"2e8d8180-24bc-4d21-91c6-7affdb473b0d"}],"responses":{"200":{"description":"Status of the violation report run task.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object","properties":{"status":{"type":"string","enum":["SUCCESS","WARNING","ERROR","TERMINATED","TEMP_ERROR","PENDING"]}}}]},"example":{"status":"SUCCESS","type":"REPORT_RESULT","id":"2e8d8180-24bc-4d21-91c6-7affdb473b0d","name":"policy-xyz"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sod-policies/sod-violation-report-status/{reportResultId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get violation report run status","description":{"content":"This gets the status for a violation report run task that has already been invoked.\nRequires role of ORG_ADMIN.","type":"text/plain"},"url":{"path":["sod-policies","sod-violation-report-status",":reportResultId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the report reference to retrieve.","type":"text/plain"},"type":"any","value":"","key":"reportResultId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get violation report run status' (get-sod-violation-report-run-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get violation report run status + + + +This gets the status for a violation report run task that has already been invoked. +Requires role of ORG_ADMIN. + +
Path Parameters
+ +Status of the violation report run task. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-sod-violation-report-status.api.mdx b/products/idn/api/beta/get-sod-violation-report-status.api.mdx new file mode 100644 index 000000000..853ab1265 --- /dev/null +++ b/products/idn/api/beta/get-sod-violation-report-status.api.mdx @@ -0,0 +1,88 @@ +--- +id: get-sod-violation-report-status +sidebar_label: Get SOD violation report status +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getSodViolationReportStatus","tags":["SOD Policy"],"description":"This gets the status for a violation report run task that has already been invoked.\nRequires role of ORG_ADMIN.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the object reference to retrieve.","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"Status of the violation report run task.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object","properties":{"status":{"type":"string","enum":["SUCCESS","WARNING","ERROR","TERMINATED","TEMP_ERROR","PENDING"]}}}]},"example":{"status":"SUCCESS","type":"REPORT_RESULT","id":"2e8d8180-24bc-4d21-91c6-7affdb473b0d","name":"policy-xyz"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sod-policies/{id}/violation-report","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get SOD violation report status","description":{"content":"This gets the status for a violation report run task that has already been invoked.\nRequires role of ORG_ADMIN.","type":"text/plain"},"url":{"path":["sod-policies",":id","violation-report"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the object reference to retrieve.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get SOD violation report status' (get-sod-violation-report-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get SOD violation report status + + + +This gets the status for a violation report run task that has already been invoked. +Requires role of ORG_ADMIN. + +
Path Parameters
+ +Status of the violation report run task. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-source-accounts-schema.api.mdx b/products/idn/api/beta/get-source-accounts-schema.api.mdx new file mode 100644 index 000000000..0da986db0 --- /dev/null +++ b/products/idn/api/beta/get-source-accounts-schema.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-source-accounts-schema +sidebar_label: Downloads source accounts schema template +hide_title: true +hide_table_of_contents: true +api: {"tags":["Sources"],"operationId":"getSourceAccountsSchema","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"The Source id","example":"8c190e6787aa4ed9a90bd9d5344523fb"}],"responses":{"200":{"description":"Successfully downloaded the file","content":{"text/csv":{"example":"id,name,givenName,familyName,e-mail,location,manager,groups,startDate,endDate"}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:source-schema:read","idn:source-schema:manage"]}],"description":"Downloads source accounts schema template","method":"get","path":"/sources/{id}/schemas/accounts","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Downloads source accounts schema template","description":{"type":"text/plain"},"url":{"path":["sources",":id","schemas","accounts"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"text/csv"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Downloads source accounts schema template' (get-source-accounts-schema)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Downloads source accounts schema template + + + +Downloads source accounts schema template + +
Path Parameters
+ +Successfully downloaded the file + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-source-attr-sync-config.api.mdx b/products/idn/api/beta/get-source-attr-sync-config.api.mdx new file mode 100644 index 000000000..ae4b68568 --- /dev/null +++ b/products/idn/api/beta/get-source-attr-sync-config.api.mdx @@ -0,0 +1,96 @@ +--- +id: get-source-attr-sync-config +sidebar_label: Attribute Sync Config +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getSourceAttrSyncConfig","tags":["Sources"],"description":"This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not.\nA token with ORG_ADMIN authority is required to call this API.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"The source id","example":"2c9180835d191a86015d28455b4a2329"}],"responses":{"200":{"description":"Attribute synchronization configuration for a source","content":{"application/json":{"schema":{"type":"object","description":"Specification of attribute sync configuration for a source","required":["source","attributes"],"properties":{"source":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Reference to the source which is the target of the attribute synchronization","example":[{"type":"SOURCE","id":"2c9180835d191a86015d28455b4b232a","name":"HR Active Directory"}]},"attributes":{"type":"array","description":"Attribute synchronization configuration for specific identity attributes in the context of a source","items":{"type":"object","description":"Specification of source attribute sync mapping configuration for an identity attribute","required":["name","displayName","enabled","target"],"properties":{"name":{"type":"string","description":"Name of the identity attribute","example":"email"},"displayName":{"type":"string","description":"Display name of the identity attribute","example":"Email"},"enabled":{"type":"boolean","description":"Determines whether or not the attribute is enabled for synchronization","example":true},"target":{"type":"string","description":"Name of the source account attribute to which the identity attribute value will be synchronized if enabled","example":"mail"}}},"example":[{"name":"email","displayName":"Email","enabled":true,"target":"mail"},{"name":"firstname","displayName":"First Name","enabled":false,"target":"givenName"}]}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sources/{id}/attribute-sync-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Attribute Sync Config","description":{"content":"This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":id","attribute-sync-config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The source id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Attribute Sync Config' (get-source-attr-sync-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Attribute Sync Config + + + +This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. +A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
+ +Attribute synchronization configuration for a source + +
Schema
    source object
    + +Reference to the source which is the target of the attribute synchronization + +
    attributes object[]
    + +Attribute synchronization configuration for specific identity attributes in the context of a source + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-source-config.api.mdx b/products/idn/api/beta/get-source-config.api.mdx new file mode 100644 index 000000000..803c65eac --- /dev/null +++ b/products/idn/api/beta/get-source-config.api.mdx @@ -0,0 +1,76 @@ +--- +id: get-source-config +sidebar_label: Gets source config with language translations +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getSourceConfig","tags":["Sources"],"description":"Looks up and returns the source config for the requested source id after populating the source config values and applying language translations.\nA token with ORG_ADMIN authority is required to call this API.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Source id"},{"in":"query","name":"locale","schema":{"type":"string","enum":["de","no","fi","sv","ru","pt","ko","zh-TW","en","it","fr","zh-CN","hu","es","cs","ja","pl","da","nl"]},"description":"The locale to apply to the config. If no viable locale is given, it will default to \"en\""}],"responses":{"200":{"description":"A Connector Detail object","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The connector name","example":"JDBC"},"sourceConfigXml":{"type":"string","description":"XML representation of the source config data","example":"
\n\t
"},"sourceConfig":{"type":"string","description":"JSON representation of the source config data","example":{"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":{"type":"boolean","description":"true if the source is a direct connect source","example":true},"fileUpload":{"type":"boolean","description":"Connector config's file upload attribute, false if not there","example":false},"uploadedFiles":{"type":"string","description":"List of uploaded file strings for the connector","example":[]},"connectorMetadata":{"type":"object","description":"Object containing metadata pertinent to the UI to be used","example":{"supportedUI":"EXTJS"}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sources/{id}/connectors/source-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Gets source config with language translations","description":{"content":"Looks up and returns the source config for the requested source id after populating the source config values and applying language translations.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":id","connectors","source-config"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The locale to apply to the config. If no viable locale is given, it will default to \"en\"","type":"text/plain"},"key":"locale","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Gets source config with language translations' (get-source-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Gets source config with language translations + + + +Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. +A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
Query Parameters
+ +A Connector Detail object + +
Schema
\\n\\t \",\n \"sourceConfig\": {\n \"Form\": {\n \"Field\": {\n \"_defaultValue\": \"true\",\n \"_hidden\": \"true\",\n \"_name\": \"cloudAuthEnabled\",\n \"_type\": \"boolean\",\n \"_value\": \"true\"\n },\n \"_xmlns\": \"http://www.sailpoint.com/xsd/sailpoint_form_1_0.xsd\",\n \"_connectorName\": \"Active Directory - Direct\",\n \"_directConnect\": \"true\",\n \"_name\": \"Active Directory\",\n \"_status\": \"released\",\n \"_type\": \"SourceConfig\",\n \"__text\": \"\\\\n\\\\t\"\n }\n },\n \"directConnect\": true,\n \"fileUpload\": false,\n \"uploadedFiles\": [],\n \"connectorMetadata\": {\n \"supportedUI\": \"EXTJS\"\n }\n}"} language={"json"}>
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-source-entitlement-request-config.api.mdx b/products/idn/api/beta/get-source-entitlement-request-config.api.mdx new file mode 100644 index 000000000..7725f5d0a --- /dev/null +++ b/products/idn/api/beta/get-source-entitlement-request-config.api.mdx @@ -0,0 +1,89 @@ +--- +id: get-source-entitlement-request-config +sidebar_label: Get Source Entitlement Request Configuration +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:sources:read","idn:sources:manage"]}],"operationId":"getSourceEntitlementRequestConfig","tags":["Sources"],"description":"This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source.\n\nAccess request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined.\n- During access request, this source-level entitlement request configuration overrides the global organization-level configuration.\n- However, the entitlement-level configuration (if defined) overrides this source-level configuration.\n\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","responses":{"200":{"description":"Source Entitlement Request Configuration Details.","content":{"application/json":{"schema":{"type":"object","description":"Entitlement Request Configuration","properties":{"accessRequestConfig":{"type":"object","properties":{"approvalSchemes":{"type":"array","description":"Ordered list of approval steps for the access request. Empty when no approval is required.","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["ENTITLEMENT_OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n\n**ENTITLEMENT_OWNER**: Owner of the associated Entitlement\n\n**SOURCE_OWNER**: Owner of the associated Source\n\n**MANAGER**: Manager of the Identity for whom the request is being made\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"e3eab852-8315-467f-9de7-70eda97f63c8"}}}},"requestCommentRequired":{"type":"boolean","description":"If the requester must provide a comment during access request.","default":false,"example":true},"denialCommentRequired":{"type":"boolean","description":"If the reviewer must provide a comment when denying the access request.","default":false,"example":false}},"description":"Configuration for requesting access to entitlements"}}},"examples":{"Get default config":{"description":"The default config for a source should look like the following where the empty approvalSchemes indicates that no approvals are required.","value":{"accessRequestConfig":{"approvalSchemes":[],"requestCommentRequired":false,"denialCommentRequired":false}}},"Get config with one approval":{"description":"In case of a single approval, the config could look like the following.","value":{"accessRequestConfig":{"approvalSchemes":[{"approverId":null,"approverType":"SOURCE_OWNER"}],"requestCommentRequired":true,"denialCommentRequired":false}}},"Get config with multiple approvals":{"description":"In case of multiple levels of approvals the config could look like the following. In this scenario, access request review process should go through all the approvers sequentially.","value":{"accessRequestConfig":{"approvalSchemes":[{"approverId":null,"approverType":"ENTITLEMENT_OWNER"},{"approverId":null,"approverType":"SOURCE_OWNER"},{"approverId":"95e538a3-30c1-433a-af05-4bed973bbc22","approverType":"GOVERNANCE_GROUP"}],"requestCommentRequired":true,"denialCommentRequired":false}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sources/{id}/entitlement-request-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Source Entitlement Request Configuration","description":{"content":"This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source.\n\nAccess request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined.\n- During access request, this source-level entitlement request configuration overrides the global organization-level configuration.\n- However, the entitlement-level configuration (if defined) overrides this source-level configuration.\n\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":id","entitlement-request-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Source Entitlement Request Configuration' (get-source-entitlement-request-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Source Entitlement Request Configuration + + + +This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. + +Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. +- During access request, this source-level entitlement request configuration overrides the global organization-level configuration. +- However, the entitlement-level configuration (if defined) overrides this source-level configuration. + +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +
+ +Source Entitlement Request Configuration Details. + +
Schema
    accessRequestConfig object
    + +Configuration for requesting access to entitlements + +
    approvalSchemes object[]
    + +Ordered list of approval steps for the access request. Empty when no approval is required. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-source-entitlements-schema.api.mdx b/products/idn/api/beta/get-source-entitlements-schema.api.mdx new file mode 100644 index 000000000..994a39b60 --- /dev/null +++ b/products/idn/api/beta/get-source-entitlements-schema.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-source-entitlements-schema +sidebar_label: Downloads source entitlements schema template +hide_title: true +hide_table_of_contents: true +api: {"tags":["Sources"],"operationId":"getSourceEntitlementsSchema","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"The Source id","example":"8c190e6787aa4ed9a90bd9d5344523fb"},{"in":"query","name":"schemaName","schema":{"type":"string"},"description":"Name of entitlement schema","example":"?schemaName=group"}],"responses":{"200":{"description":"Successfully downloaded the file","content":{"text/csv":{"example":"id,name,displayName,created,description,modified,entitlements,groups,permissions"}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:source-schema:read","idn:source-schema:manage"]}],"description":"Downloads source entitlements schema template","method":"get","path":"/sources/{id}/schemas/entitlements","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Downloads source entitlements schema template","description":{"type":"text/plain"},"url":{"path":["sources",":id","schemas","entitlements"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Name of entitlement schema","type":"text/plain"},"key":"schemaName","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"text/csv"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Downloads source entitlements schema template' (get-source-entitlements-schema)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Downloads source entitlements schema template + + + +Downloads source entitlements schema template + +
Path Parameters
Query Parameters
+ +Successfully downloaded the file + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-source-schema.api.mdx b/products/idn/api/beta/get-source-schema.api.mdx new file mode 100644 index 000000000..998f264af --- /dev/null +++ b/products/idn/api/beta/get-source-schema.api.mdx @@ -0,0 +1,96 @@ +--- +id: get-source-schema +sidebar_label: Get Source Schema by ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getSourceSchema","tags":["Sources"],"description":"Get the Source Schema by ID in IdentityNow.\n","parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source ID.","example":"2c9180835d191a86015d28455b4a2329"},{"in":"path","name":"schemaId","schema":{"type":"string"},"required":true,"description":"The Schema ID.","example":"2c9180835d191a86015d28455b4a2329"}],"responses":{"200":{"description":"The requested Schema was successfully retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Schema.","example":"2c9180835d191a86015d28455b4a2329"},"name":{"type":"string","description":"The name of the Schema.","example":"account"},"nativeObjectType":{"type":"string","description":"The name of the object type on the native system that the schema represents.","example":"User"},"identityAttribute":{"type":"string","description":"The name of the attribute used to calculate the unique identifier for an object in the schema.","example":"sAMAccountName"},"displayAttribute":{"type":"string","description":"The name of the attribute used to calculate the display value for an object in the schema.","example":"distinguishedName"},"hierarchyAttribute":{"type":"string","description":"The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.","example":"memberOf"},"includePermissions":{"type":"boolean","description":"Flag indicating whether or not the include permissions with the object data when aggregating the schema.","example":false},"features":{"type":"array","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING."},"description":"The features that the schema supports.","example":["PROVISIONING","NO_PERMISSIONS_PROVISIONING","GROUPS_HAVE_MEMBERS"]},"configuration":{"type":"object","description":"Holds any extra configuration data that the schema may require.","example":{"groupMemberAttribute":"member"}},"attributes":{"type":"array","description":"The attribute definitions which form the schema.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"sAMAccountName"},"type":{"type":"string","enum":["STRING","LONG","INT","BOOLEAN"],"description":"The underlying type of the value which an AttributeDefinition represents.","example":"STRING"},"schema":{"description":"A reference to the schema on the source to the attribute values map to.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"The object ID this reference applies to.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The human-readable display name of the object.","example":"group"}}},"description":{"type":"string","description":"A human-readable description of the attribute.","example":"The sAMAccountName attribute"},"isMulti":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","example":false},"isEntitlement":{"type":"boolean","description":"Flag indicating whether or not the attribute is an entitlement.","example":false},"isGroup":{"type":"boolean","description":"Flag indicating whether or not the attribute represents a group.\nThis can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute..\n","example":false}}},"example":[{"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":{"type":"string","description":"The date the Schema was created.","format":"date-time","example":"2019-12-24T22:32:58.104Z"},"modified":{"type":"string","description":"The date the Schema was last modified.","format":"date-time","example":"2019-12-31T20:22:28.104Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sources/{sourceId}/schemas/{schemaId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Source Schema by ID","description":{"content":"Get the Source Schema by ID in IdentityNow.\n","type":"text/plain"},"url":{"path":["sources",":sourceId","schemas",":schemaId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source ID.","type":"text/plain"},"type":"any","value":"","key":"sourceId"},{"disabled":false,"description":{"content":"(Required) The Schema ID.","type":"text/plain"},"type":"any","value":"","key":"schemaId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Source Schema by ID' (get-source-schema)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Source Schema by ID + + + +Get the Source Schema by ID in IdentityNow. + + +
Path Parameters
+ +The requested Schema was successfully retrieved. + +
Schema
    attributes object[]
    + +The attribute definitions which form the schema. + +
    schema object
    + +A reference to the schema on the source to the attribute values map to. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-source.api.mdx b/products/idn/api/beta/get-source.api.mdx new file mode 100644 index 000000000..8ad6ed924 --- /dev/null +++ b/products/idn/api/beta/get-source.api.mdx @@ -0,0 +1,128 @@ +--- +id: get-source +sidebar_label: Get Source by ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getSource","security":[{"oauth2":["idn:sources:read"]}],"tags":["Sources"],"description":"This end-point gets a specific source in IdentityNow.\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Source ID","example":"2c9180835d191a86015d28455b4a2329"}],"responses":{"200":{"description":"A Source object","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"the id of the Source","example":"2c91808568c529c60168cca6f90c1324"},"name":{"type":"string","description":"Human-readable name of the source","example":"My Source"},"description":{"type":"string","description":"Human-readable description of the source","example":"This is the corporate directory."},"owner":{"description":"Reference to an owning Identity Object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity","example":"MyName"}}},"cluster":{"description":"Reference to the associated Cluster","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"type":"string","description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"accountCorrelationConfig":{"description":"Reference to an Account Correlation Config object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG"],"example":"ACCOUNT_CORRELATION_CONFIG"},"id":{"type":"string","description":"ID of the account correlation config","example":"2c9180855d191c59015d28583727245a"},"name":{"type":"string","description":"Human-readable display name of the account correlation config","example":"Directory [source-62867] Account Correlation"}}},"accountCorrelationRule":{"description":"Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"managerCorrelationMapping":{"description":"Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity","type":"object","properties":{"accountAttribute":{"type":"string","description":"Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.","example":"manager"},"identityAttribute":{"type":"string","description":"Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.","example":"manager"}}},"managerCorrelationRule":{"description":"Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"beforeProvisioningRule":{"description":"Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"schemas":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"ID of the schema","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the schema","example":"MySchema"}}},"description":"List of references to Schema objects","example":[{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232a","name":"account"},{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232b","name":"group"}]},"passwordPolicies":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["PASSWORD_POLICY"],"example":"PASSWORD_POLICY"},"id":{"type":"string","description":"ID of the policy","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the policy","example":"My Password Policy"}}},"description":"List of references to the associated PasswordPolicy objects.","example":[{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb053980","name":"Corporate Password Policy"},{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb057777","name":"Vendor Password Policy"}]},"features":{"type":"array","description":"Optional features that can be supported by a source.","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING."},"example":["SYNC_PROVISIONING","MANAGER_LOOKUP","SEARCH","PROVISIONING","AUTHENTICATE","GROUP_PROVISIONING","PASSWORD"]},"type":{"type":"string","description":"Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ","example":"OpenLDAP - Direct"},"connector":{"type":"string","description":"Connector script name.","example":"active-directory"},"connectorClass":{"type":"string","description":"The fully qualified name of the Java class that implements the connector interface.","example":"sailpoint.connector.LDAPConnector"},"connectorAttributes":{"type":"object","description":"Connector specific configuration; will differ from type to type.","example":{"healthCheckTimeout":30,"authSearchAttributes":["cn","uid","mail"]}},"deleteThreshold":{"type":"integer","format":"int32","description":"Number from 0 to 100 that specifies when to skip the delete phase.","example":10},"authoritative":{"type":"boolean","description":"When true indicates the source is referenced by an IdentityProfile.","example":false},"managementWorkgroup":{"description":"Reference to Management Workgroup for this Source","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["GOVERNANCE_GROUP"],"example":"GOVERNANCE_GROUP"},"id":{"type":"string","description":"ID of the management workgroup","example":"2c91808568c529c60168cca6f90c2222"},"name":{"type":"string","description":"Human-readable display name of the management workgroup","example":"My Management Workgroup"}}},"healthy":{"type":"boolean","description":"When true indicates a healthy source","example":true},"status":{"type":"string","description":"A status identifier, giving specific information on why a source is healthy or not","example":"SOURCE_STATE_HEALTHY"},"since":{"type":"string","description":"Timestamp showing when a source health check was last performed","example":"2021-09-28T15:48:29.3801666300Z"},"connectorId":{"type":"string","description":"The id of connector","example":"active-directory"},"connectorName":{"type":"string","description":"The name of the connector that was chosen on source creation","example":"Active Directory"},"connectionType":{"type":"string","description":"The type of connection (direct or file)","example":"file"},"connectorImplementstionId":{"type":"string","description":"The connector implementstion id","example":"delimited-file"}},"required":["name","owner","connector"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sources/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Source by ID","description":{"content":"This end-point gets a specific source in IdentityNow.\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Source by ID' (get-source)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Source by ID + + + +This end-point gets a specific source in IdentityNow. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +
Path Parameters
+ +A Source object + +
Schema
    owner object
    + +Reference to an owning Identity Object + +
    cluster object
    + +Reference to the associated Cluster + +
    accountCorrelationConfig object
    + +Reference to an Account Correlation Config object + +
    accountCorrelationRule object
    + +Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used. + +
    managerCorrelationMapping object
    + +Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + +
    managerCorrelationRule object
    + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
    beforeProvisioningRule object
    + +Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + +
    schemas object[]
    + +List of references to Schema objects + +
    passwordPolicies object[]
    + +List of references to the associated PasswordPolicy objects. + +
    managementWorkgroup object
    + +Reference to Management Workgroup for this Source + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-sp-config-export-status.api.mdx b/products/idn/api/beta/get-sp-config-export-status.api.mdx new file mode 100644 index 000000000..9452d3e20 --- /dev/null +++ b/products/idn/api/beta/get-sp-config-export-status.api.mdx @@ -0,0 +1,89 @@ +--- +id: get-sp-config-export-status +sidebar_label: Get export job status +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getSpConfigExportStatus","tags":["SP-Config"],"description":"This gets the status of the export job identified by the `id` parameter.\nThe request will need one of the following security scopes:\n- sp:config:read - sp:config:manage","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the export job whose status will be returned.","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"Export job status successfully returned.","content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"type":"string","description":"Unique id assigned to this job.","example":"3469b87d-48ca-439a-868f-2160001da8c1"},"status":{"type":"string","description":"Status of the job.","enum":["NOT_STARTED","IN_PROGRESS","COMPLETE","CANCELLED","FAILED"],"example":"COMPLETE"},"type":{"type":"string","description":"Type of the job, either export or import.","enum":["EXPORT","IMPORT"],"example":"IMPORT"},"message":{"type":"string","description":"This message contains additional information about the overall status of the job.","example":"Download import results for details."},"description":{"type":"string","description":"Optional user defined description/name for export job.","example":"ETS configuration objects from Acme-Solar sandbox"},"expiration":{"type":"string","format":"date-time","description":"The time until which the artifacts will be available for download.","example":"2021-05-11T22:23:16Z"},"created":{"type":"string","format":"date-time","description":"The time the job was started.","example":"2021-05-11T22:23:16Z"},"modified":{"type":"string","format":"date-time","description":"The time of the last update to the job.","example":"2021-05-11T22:23:16Z"},"completed":{"type":"string","format":"date-time","description":"The time the job was completed.","example":"2021-05-11T22:23:16Z"}},"required":["jobId","status","type","message","description","expiration","created","modified","completed"]},"example":{"jobId":"1e824aa0-4c6e-4f14-95e9-e7dc5234aa51","status":"COMPLETE","type":"EXPORT","message":null,"description":"Export Job 1 Test","expiration":"2021-05-20T15:04:24Z","created":"2021-05-13T15:04:24.112Z","modified":"2021-05-13T15:04:27.363Z","completed":"2021-05-13T15:04:27.358Z"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sp-config/export/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get export job status","description":{"content":"This gets the status of the export job identified by the `id` parameter.\nThe request will need one of the following security scopes:\n- sp:config:read - sp:config:manage","type":"text/plain"},"url":{"path":["sp-config","export",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the export job whose status will be returned.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get export job status' (get-sp-config-export-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get export job status + + + +This gets the status of the export job identified by the `id` parameter. +The request will need one of the following security scopes: +- sp:config:read - sp:config:manage + +
Path Parameters
+ +Export job status successfully returned. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-sp-config-export.api.mdx b/products/idn/api/beta/get-sp-config-export.api.mdx new file mode 100644 index 000000000..4bc962901 --- /dev/null +++ b/products/idn/api/beta/get-sp-config-export.api.mdx @@ -0,0 +1,101 @@ +--- +id: get-sp-config-export +sidebar_label: Download export job result. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getSpConfigExport","tags":["SP-Config"],"description":"This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file.\nThe request will need one of the following security scopes:\n- sp:config:read - sp:config:manage","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the export job whose results will be downloaded.","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"Exported JSON objects.","content":{"application/json":{"schema":{"type":"object","title":"Config Export Response Body","description":"Response model for config export download response.","properties":{"version":{"type":"integer","description":"Current version of the export results object.","example":1},"timestamp":{"type":"string","format":"date-time","description":"Time the export was completed.","example":"2021-05-11T22:23:16Z"},"tenant":{"type":"string","description":"Name of the tenant where this export originated.","example":"sample-tenant"},"description":{"type":"string","description":"Optional user defined description/name for export job.","example":"Export Job 1 Test"},"options":{"type":"object","properties":{"excludeTypes":{"description":"Object type names to be excluded from an sp-config export command.","type":"array","items":{"type":"string","enum":["ACCESS_PROFILE","ACCESS_REQUEST_CONFIG","ATTR_SYNC_SOURCE_CONFIG","AUTH_ORG","CAMPAIGN_FILTER","FORM_DEFINITION","GOVERNANCE_GROUP","IDENTITY_PROFILE","LIFECYCLE_STATE","NOTIFICATION_TEMPLATE","PASSWORD_POLICY","PASSWORD_SYNC_GROUP","PUBLIC_IDENTITIES_CONFIG","ROLE","RULE","SERVICE_DESK_INTEGRATION","SOD_POLICY","SOURCE","TRANSFORM","TRIGGER_SUBSCRIPTION","WORKFLOWS"],"example":"SOURCE"}},"includeTypes":{"description":"Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes.","type":"array","items":{"type":"string","enum":["ACCESS_PROFILE","ACCESS_REQUEST_CONFIG","ATTR_SYNC_SOURCE_CONFIG","AUTH_ORG","CAMPAIGN_FILTER","FORM_DEFINITION","GOVERNANCE_GROUP","IDENTITY_PROFILE","LIFECYCLE_STATE","NOTIFICATION_TEMPLATE","PASSWORD_POLICY","PASSWORD_SYNC_GROUP","PUBLIC_IDENTITIES_CONFIG","ROLE","RULE","SERVICE_DESK_INTEGRATION","SOD_POLICY","SOURCE","TRANSFORM","TRIGGER_SUBSCRIPTION","WORKFLOWS"],"example":"TRIGGER_SUBSCRIPTION"}},"objectOptions":{"description":"Additional options targeting specific objects related to each item in the includeTypes field","type":"object","additionalProperties":{"type":"object","properties":{"includedIds":{"description":"Object ids to be included in an import or export.","type":"array","items":{"type":"string","example":"be9e116d-08e1-49fc-ab7f-fa585e96c9e4"}},"includedNames":{"description":"Object names to be included in an import or export.","type":"array","items":{"type":"string","example":"Test Object"}}}},"example":{"TRIGGER_SUBSCRIPTION":{"includedIds":["be9e116d-08e1-49fc-ab7f-fa585e96c9e4"],"includedNames":["Test 2"]}}}},"description":"Options used to create this export."},"objects":{"type":"array","items":{"type":"object","title":"Config Object for Export and Import","description":"Config export and import format for individual object configurations.","properties":{"version":{"type":"integer","description":"Current version of configuration object.","example":1},"self":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"object":{"description":"Object details. Format dependant on the object type.","additionalProperties":true}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sp-config/export/{id}/download","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Download export job result.","description":{"content":"This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file.\nThe request will need one of the following security scopes:\n- sp:config:read - sp:config:manage","type":"text/plain"},"url":{"path":["sp-config","export",":id","download"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the export job whose results will be downloaded.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Download export job result.' (get-sp-config-export)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Download export job result. + + + +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 + +
Path Parameters
+ +Exported JSON objects. + +
Schema
    options object
    + +Options used to create this export. + +
    objectOptions object
    + +Additional options targeting specific objects related to each item in the includeTypes field + +
  • property name* object
    • objects object[]
    self object
    object
    + +Object details. Format dependant on the object type. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-sp-config-import-status.api.mdx b/products/idn/api/beta/get-sp-config-import-status.api.mdx new file mode 100644 index 000000000..61027a596 --- /dev/null +++ b/products/idn/api/beta/get-sp-config-import-status.api.mdx @@ -0,0 +1,90 @@ +--- +id: get-sp-config-import-status +sidebar_label: Get import job status +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getSpConfigImportStatus","tags":["SP-Config"],"description":"This gets the status of the import job identified by the `id` parameter.\nFor more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).\nThe request will need the following security scope:\n- sp:config:manage","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the import job whose status will be returned.","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"Import job status successfully returned.","content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"type":"string","description":"Unique id assigned to this job.","example":"3469b87d-48ca-439a-868f-2160001da8c1"},"status":{"type":"string","description":"Status of the job.","enum":["NOT_STARTED","IN_PROGRESS","COMPLETE","CANCELLED","FAILED"],"example":"COMPLETE"},"type":{"type":"string","description":"Type of the job, either export or import.","enum":["EXPORT","IMPORT"],"example":"IMPORT"},"message":{"type":"string","description":"This message contains additional information about the overall status of the job.","example":"Download import results for details."},"description":{"type":"string","description":"Optional user defined description/name for export job.","example":"ETS configuration objects from Acme-Solar sandbox"},"expiration":{"type":"string","format":"date-time","description":"The time until which the artifacts will be available for download.","example":"2021-05-11T22:23:16Z"},"created":{"type":"string","format":"date-time","description":"The time the job was started.","example":"2021-05-11T22:23:16Z"},"modified":{"type":"string","format":"date-time","description":"The time of the last update to the job.","example":"2021-05-11T22:23:16Z"},"completed":{"type":"string","format":"date-time","description":"The time the job was completed.","example":"2021-05-11T22:23:16Z"}},"required":["jobId","status","type","message","description","expiration","created","modified","completed"]},"example":{"jobId":"4fb10503-1c49-4603-8f8d-886e1f6aa47b","status":"COMPLETE","type":"IMPORT","message":"Download import results for details.","description":null,"expiration":"2021-05-20T16:42:39Z","created":"2021-05-13T16:42:39.333Z","modified":"2021-05-13T16:42:40.71Z","completed":"2021-05-13T16:42:40.705Z"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sp-config/import/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get import job status","description":{"content":"This gets the status of the import job identified by the `id` parameter.\nFor more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).\nThe request will need the following security scope:\n- sp:config:manage","type":"text/plain"},"url":{"path":["sp-config","import",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the import job whose status will be returned.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get import job status' (get-sp-config-import-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get import job status + + + +This gets the status of the import job identified by the `id` parameter. +For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). +The request will need the following security scope: +- sp:config:manage + +
Path Parameters
+ +Import job status successfully returned. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-sp-config-import.api.mdx b/products/idn/api/beta/get-sp-config-import.api.mdx new file mode 100644 index 000000000..de616e84a --- /dev/null +++ b/products/idn/api/beta/get-sp-config-import.api.mdx @@ -0,0 +1,93 @@ +--- +id: get-sp-config-import +sidebar_label: Download import job result +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getSpConfigImport","tags":["SP-Config"],"description":"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.\nThe request will need the following security scope:\n- sp:config:manage","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the import job whose results will be downloaded.","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"Import results JSON object, containing detailed results of the import operation.","content":{"application/json":{"schema":{"type":"object","title":"Config Import Response Body","description":"Response Body for Config Import command.","properties":{"results":{"type":"object","additionalProperties":{"type":"object","title":"Import Object Response Body","description":"Response model for import of a single object.","properties":{"infos":{"description":"Informational messages returned from the target service on import.","type":"array","items":{"type":"object","title":"Config Import/Export Message","description":"Message model for Config Import/Export.","properties":{"key":{"type":"string","description":"Message key.","example":"UNKNOWN_REFERENCE_RESOLVER"},"text":{"type":"string","description":"Message text.","example":"Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]"},"details":{"type":"object","description":"Message details if any, in key:value pairs.","additionalProperties":{"type":"object"},"example":{"details":"message details"}}},"required":["key","text","details"]}},"warnings":{"description":"Warning messages returned from the target service on import.","type":"array","items":{"type":"object","title":"Config Import/Export Message","description":"Message model for Config Import/Export.","properties":{"key":{"type":"string","description":"Message key.","example":"UNKNOWN_REFERENCE_RESOLVER"},"text":{"type":"string","description":"Message text.","example":"Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]"},"details":{"type":"object","description":"Message details if any, in key:value pairs.","additionalProperties":{"type":"object"},"example":{"details":"message details"}}},"required":["key","text","details"]}},"errors":{"description":"Error messages returned from the target service on import.","type":"array","items":{"type":"object","title":"Config Import/Export Message","description":"Message model for Config Import/Export.","properties":{"key":{"type":"string","description":"Message key.","example":"UNKNOWN_REFERENCE_RESOLVER"},"text":{"type":"string","description":"Message text.","example":"Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]"},"details":{"type":"object","description":"Message details if any, in key:value pairs.","additionalProperties":{"type":"object"},"example":{"details":"message details"}}},"required":["key","text","details"]}},"importedObjects":{"description":"References to objects that were created or updated by the import.","type":"array","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}}},"required":["infos","warnings","errors","importedObjects"]},"description":"The results of an object configuration import job.","example":{"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":{"type":"string","description":"If a backup was performed before the import, this will contain the jobId of the backup job. This id can be used to retrieve the json file of the backup export.","example":"be9e116d-08e1-49fc-ab7f-fa585e96c9e4"}},"required":["results"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sp-config/import/{id}/download","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Download import job result","description":{"content":"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.\nThe request will need the following security scope:\n- sp:config:manage","type":"text/plain"},"url":{"path":["sp-config","import",":id","download"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the import job whose results will be downloaded.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Download import job result' (get-sp-config-import)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Download import job result + + + +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 + +
Path Parameters
+ +Import results JSON object, containing detailed results of the import operation. + +
Schema
    results object
    + +The results of an object configuration import job. + +
  • property name* object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-status-check-details.api.mdx b/products/idn/api/beta/get-status-check-details.api.mdx new file mode 100644 index 000000000..3e50569b4 --- /dev/null +++ b/products/idn/api/beta/get-status-check-details.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-status-check-details +sidebar_label: Get the time check configuration +hide_title: true +hide_table_of_contents: true +api: {"tags":["Service Desk Integration"],"description":"Get the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","operationId":"getStatusCheckDetails","responses":{"200":{"description":"QueuedCheckConfigDetails containing the configured values","content":{"application/json":{"schema":{"description":"Configuration of maximum number days and interval for checking Service Desk integration queue status","required":["provisioningStatusCheckIntervalMinutes","provisioningMaxStatusCheckDays"],"type":"object","properties":{"provisioningStatusCheckIntervalMinutes":{"description":"interval in minutes between status checks","type":"string","example":30},"provisioningMaxStatusCheckDays":{"description":"maximum number of days to check","type":"string","example":2}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:service-desk-admin:read","idn:service-desk-admin:manage","idn:service-desk-integration:read","idn:service-desk-integration:manage"]}],"method":"get","path":"/service-desk-integrations/status-check-configuration","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get the time check configuration","description":{"content":"Get the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","type":"text/plain"},"url":{"path":["service-desk-integrations","status-check-configuration"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get the time check configuration' (get-status-check-details)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get the time check configuration + + + +Get the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +
+ +QueuedCheckConfigDetails containing the configured values + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-tagged-object.api.mdx b/products/idn/api/beta/get-tagged-object.api.mdx new file mode 100644 index 000000000..4d5466def --- /dev/null +++ b/products/idn/api/beta/get-tagged-object.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-tagged-object +sidebar_label: Get Tagged Object +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getTaggedObject","security":[{"oauth2":["idn:tag:read","idn:tag:manage"]}],"tags":["Tagged Objects"],"description":"This gets a tagged object for the specified type.","parameters":[{"in":"path","name":"type","schema":{"type":"string","enum":["ROLE","IDENTITY","SOD_POLICY"]},"required":true,"description":"The type of tagged object to retrieve.","example":"ROLE"},{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the object reference to retrieve.","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"Tagged object by type and ID.","content":{"application/json":{"schema":{"type":"object","properties":{"objectRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"tags":{"type":"array","items":{"type":"string"},"description":"Labels to be applied to an Object","example":["BU_FINANCE","PCI"]}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/tagged-objects/{type}/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Tagged Object","description":{"content":"This gets a tagged object for the specified type.","type":"text/plain"},"url":{"path":["tagged-objects",":type",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The type of tagged object to retrieve.","type":"text/plain"},"type":"any","value":"","key":"type"},{"disabled":false,"description":{"content":"(Required) The ID of the object reference to retrieve.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Tagged Object' (get-tagged-object)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Tagged Object + + + +This gets a tagged object for the specified type. + +
Path Parameters
+ +Tagged object by type and ID. + +
Schema
    objectRef object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-tenant-config-configuration.api.mdx b/products/idn/api/beta/get-tenant-config-configuration.api.mdx new file mode 100644 index 000000000..067cf3a7f --- /dev/null +++ b/products/idn/api/beta/get-tenant-config-configuration.api.mdx @@ -0,0 +1,103 @@ +--- +id: get-tenant-config-configuration +sidebar_label: Get Tenant-wide Reassignment Configuration settings +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getTenantConfigConfiguration","tags":["Work Reassignment"],"description":"Gets the global Reassignment Configuration settings for the requestor's tenant.","security":[{"oauth2":["idn:reassignment-tenant-configuration:read"]}],"responses":{"200":{"description":"Tenant-wide Reassignment Configuration settings","content":{"application/json":{"schema":{"type":"object","description":"Tenant-wide Reassignment Configuration settings","properties":{"auditDetails":{"type":"object","description":"Audit details for the reassignment configuration of an identity","properties":{"created":{"type":"string","description":"Initial date and time when the record was created","format":"date-time","example":"2022-07-21T11:13:12.345Z"},"createdBy":{"type":"object","description":"The definition of an Identity according to the Reassignment Configuration service","properties":{"id":{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"},"name":{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}},"modified":{"type":"string","description":"Last modified date and time for the record","format":"date-time","example":"2022-07-21T11:13:12.345Z"},"modifiedBy":{"type":"object","description":"The definition of an Identity according to the Reassignment Configuration service","properties":{"id":{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"},"name":{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}}}},"configDetails":{"type":"object","description":"Details of any tenant-wide Reassignment Configurations (eg. enabled/disabled)","properties":{"disabled":{"type":"boolean","nullable":true,"description":"Flag to determine if Reassignment Configuration is enabled or disabled for a tenant. When this flag is set to true, Reassignment Configuration is disabled.","default":false,"example":true}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/reassignment-configurations/tenant-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Tenant-wide Reassignment Configuration settings","description":{"content":"Gets the global Reassignment Configuration settings for the requestor's tenant.","type":"text/plain"},"url":{"path":["reassignment-configurations","tenant-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Tenant-wide Reassignment Configuration settings' (get-tenant-config-configuration)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Tenant-wide Reassignment Configuration settings + + + +Gets the global Reassignment Configuration settings for the requestor's tenant. + +
+ +Tenant-wide Reassignment Configuration settings + +
Schema
    auditDetails object
    + +Audit details for the reassignment configuration of an identity + +
    createdBy object
    + +The definition of an Identity according to the Reassignment Configuration service + +
    modifiedBy object
    + +The definition of an Identity according to the Reassignment Configuration service + +
    configDetails object
    + +Details of any tenant-wide Reassignment Configurations (eg. enabled/disabled) + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-transform.api.mdx b/products/idn/api/beta/get-transform.api.mdx new file mode 100644 index 000000000..3c261bd37 --- /dev/null +++ b/products/idn/api/beta/get-transform.api.mdx @@ -0,0 +1,88 @@ +--- +id: get-transform +sidebar_label: Transform by ID +hide_title: true +hide_table_of_contents: true +api: {"tags":["Transforms"],"description":"This API returns the transform specified by the given ID.\nA token with transform read authority is required to call this API.","operationId":"getTransform","parameters":[{"name":"id","in":"path","description":"ID of the transform to retrieve","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"2c9180835d2e5168015d32f890ca1581"}],"responses":{"200":{"description":"Transform with the given ID","content":{"application/json":{"schema":{"type":"object","description":"DTO for representing an internally- or customer-defined transform.","required":["name","type","attributes"],"properties":{"id":{"type":"string","description":"Unique ID of this transform","example":"2cd78adghjkja34jh2b1hkjhasuecd"},"name":{"type":"string","description":"Unique name of this transform","example":"Timestamp To Date"},"type":{"type":"string","description":"The transform type (see [Transformations in IdentityNow Using Seaspray](https://community.sailpoint.com/docs/DOC-4629)).","example":"concat"},"attributes":{"type":"object","nullable":true,"description":"Meta-data about the transform. Values in this list are specific to the type of transform to be executed.","example":{"inputFormat":"MMM dd yyyy, HH:mm:ss.SSS","outputFormat":"yyyy/dd/MM"}},"internal":{"type":"boolean","default":false,"readOnly":true,"description":"Indicates whether this is an internal SailPoint-created transform or a customer-created transform","example":false}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:transform:read","idn:transform:manage"]}],"method":"get","path":"/transforms/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Transform by ID","description":{"content":"This API returns the transform specified by the given ID.\nA token with transform read authority is required to call this API.","type":"text/plain"},"url":{"path":["transforms",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the transform to retrieve","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Transform by ID' (get-transform)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Transform by ID + + + +This API returns the transform specified by the given ID. +A token with transform read authority is required to call this API. + +
Path Parameters
+ +Transform with the given ID + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-valid-time-zones.api.mdx b/products/idn/api/beta/get-valid-time-zones.api.mdx new file mode 100644 index 000000000..a64c4d25f --- /dev/null +++ b/products/idn/api/beta/get-valid-time-zones.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-valid-time-zones +sidebar_label: Get list of time zones +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getValidTimeZones","tags":["Org Config"],"security":[{"oauth2":["idn:org-configs:read","idn:org-configs-user:read"]}],"description":"Get a list of valid time zones that can be set in org configurations.","responses":{"200":{"description":"Request successful","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}},"example":["Etc/GMT-6","Etc/GMT+8","EST","America/Chicago","America/Toronto","Asia/Gaza","Europe/Brussels","Europe/Kiev"]}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/org-config/valid-time-zones","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get list of time zones","description":{"content":"Get a list of valid time zones that can be set in org configurations.","type":"text/plain"},"url":{"path":["org-config","valid-time-zones"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get list of time zones' (get-valid-time-zones)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get list of time zones + + + +Get a list of valid time zones that can be set in org configurations. + +
+ +Request successful + +
Schema array
  • string
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-work-item.api.mdx b/products/idn/api/beta/get-work-item.api.mdx new file mode 100644 index 000000000..ab24e73c5 --- /dev/null +++ b/products/idn/api/beta/get-work-item.api.mdx @@ -0,0 +1,67 @@ +--- +id: get-work-item +sidebar_label: Get a Work Item +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getWorkItem","tags":["Work Items"],"description":"This gets the details of a Work Item belonging to either the specified user(admin required), or the current user.","parameters":[{"in":"query","name":"ownerId","schema":{"type":"string"},"description":"ID of the work item owner.","required":false},{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"ID of the work item."}],"responses":{"200":{"description":"The work item with the given ID.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the work item","example":"2c9180835d2e5168015d32f890ca1581"},"requesterId":{"type":"string","description":"ID of the requester","example":"2c9180835d2e5168015d32f890ca1581"},"requesterDisplayName":{"type":"string","description":"The displayname of the requester","example":"John Smith"},"ownerId":{"type":"string","description":"The ID of the owner","example":"2c9180835d2e5168015d32f890ca1581"},"ownerName":{"type":"string","description":"The name of the owner","example":"Jason Smith"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z"},"description":{"type":"string","description":"The description of the work item","example":"Create account on source 'AD'"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"},"type":{"type":"string","enum":["UNKNOWN","GENERIC","CERTIFICATION","REMEDIATION","DELEGATION","APPROVAL","VIOLATIONREVIEW","FORM","POLICYVIOLATION","CHALLENGE","IMPACTANALYSIS","SIGNOFF","EVENT","MANUALACTION","TEST"],"example":"GENERIC","description":"The type of the work item"},"remediationItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the certification","example":"2c9180835d2e5168015d32f890ca1581"},"targetId":{"type":"string","description":"The ID of the certification target","example":"2c9180835d2e5168015d32f890ca1581"},"targetName":{"type":"string","description":"The name of the certification target","example":"john.smith"},"targetDisplayName":{"type":"string","description":"The display name of the certification target","example":"emailAddress"},"applicationName":{"type":"string","description":"The name of the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute being certified","example":"phoneNumber"},"attributeOperation":{"type":"string","description":"The operation of the certification on the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute being certified","example":"512-555-1212"},"nativeIdentity":{"type":"string","description":"The native identity of the target","example":"jason.smith2"}}},"approvalItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the approval item","example":"2c9180835d2e5168015d32f890ca1581"},"account":{"type":"string","description":"The account referenced by the approval item","example":"john.smith"},"application":{"type":"string","description":"The name the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute","example":"emailAddress"},"attributeOperation":{"type":"string","description":"The operation of the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute","example":"a@b.com"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"}}},"name":{"type":"string","description":"The work item name","example":"Account Create"},"completed":{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z"},"numItems":{"type":"integer","description":"The number of items in the work item","example":19},"errors":{"type":"array","items":{"type":"string"},"example":["The work item ID that was specified was not found."]}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}}},"method":"get","path":"/work-items/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get a Work Item","description":{"content":"This gets the details of a Work Item belonging to either the specified user(admin required), or the current user.","type":"text/plain"},"url":{"path":["work-items",":id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"ID of the work item owner.","type":"text/plain"},"key":"ownerId","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the work item.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a Work Item' (get-work-item)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a Work Item + + + +This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. + +
Path Parameters
Query Parameters
+ +The work item with the given ID. + +
Schema array
    remediationItems object
    approvalItems object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-work-items-summary.api.mdx b/products/idn/api/beta/get-work-items-summary.api.mdx new file mode 100644 index 000000000..715083ebe --- /dev/null +++ b/products/idn/api/beta/get-work-items-summary.api.mdx @@ -0,0 +1,67 @@ +--- +id: get-work-items-summary +sidebar_label: Work Items Summary +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getWorkItemsSummary","tags":["Work Items"],"description":"This gets a summary of work items belonging to either the specified user(admin required), or the current user.","parameters":[{"in":"query","name":"ownerId","schema":{"type":"string"},"description":"ID of the work item owner.","required":false}],"responses":{"200":{"description":"List of work items","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"open":{"type":"integer","description":"The count of open work items","example":29},"completed":{"type":"integer","description":"The count of completed work items","example":1},"total":{"type":"integer","description":"The count of total work items","example":30}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}}},"method":"get","path":"/work-items/summary","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Work Items Summary","description":{"content":"This gets a summary of work items belonging to either the specified user(admin required), or the current user.","type":"text/plain"},"url":{"path":["work-items","summary"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"ID of the work item owner.","type":"text/plain"},"key":"ownerId","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Work Items Summary' (get-work-items-summary)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Work Items Summary + + + +This gets a summary of work items belonging to either the specified user(admin required), or the current user. + +
Query Parameters
+ +List of work items + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-workflow-execution-history.api.mdx b/products/idn/api/beta/get-workflow-execution-history.api.mdx new file mode 100644 index 000000000..5e7276a52 --- /dev/null +++ b/products/idn/api/beta/get-workflow-execution-history.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-workflow-execution-history +sidebar_label: Get Workflow Execution History +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getWorkflowExecutionHistory","tags":["Workflows"],"description":"Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found.","security":[{"oauth2":["sp:workflow:read"]}],"parameters":[{"name":"id","in":"path","description":"Id of the workflow execution","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b"}}],"responses":{"200":{"description":"List of workflow execution events for the given workflow execution","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of event","enum":["WorkflowExecutionScheduled","WorkflowExecutionStarted","WorkflowExecutionCompleted","WorkflowExecutionFailed","WorkflowTaskScheduled","WorkflowTaskStarted","WorkflowTaskCompleted","WorkflowTaskFailed","ActivityTaskScheduled","ActivityTaskStarted","ActivityTaskCompleted","ActivityTaskFailed"],"example":"WorkflowTaskScheduled"},"timestamp":{"type":"string","format":"date-time","description":"The date-time when the event occurred","example":"2022-02-07T20:13:31.640618296Z"},"attributes":{"type":"object","description":"Additional attributes associated with the event","example":{}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/workflow-executions/{id}/history","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Workflow Execution History","description":{"content":"Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found.","type":"text/plain"},"url":{"path":["workflow-executions",":id","history"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the workflow execution","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Workflow Execution History' (get-workflow-execution-history)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Workflow Execution History + + + +Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + +
Path Parameters
+ +List of workflow execution events for the given workflow execution + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-workflow-execution.api.mdx b/products/idn/api/beta/get-workflow-execution.api.mdx new file mode 100644 index 000000000..bef7896a2 --- /dev/null +++ b/products/idn/api/beta/get-workflow-execution.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-workflow-execution +sidebar_label: Get a Workflow Execution +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getWorkflowExecution","tags":["Workflows"],"description":"Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found.","security":[{"oauth2":["sp:workflow:read"]}],"parameters":[{"name":"id","in":"path","description":"Id of the workflow execution","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b"}}],"responses":{"200":{"description":"The workflow execution","content":{"application/json":{"schema":{"items":{"type":"object","properties":{"id":{"type":"string","description":"The workflow execution ID","example":"b393f4e2-4785-4d7f-ab27-3a6b8ded4c81"},"workflowId":{"type":"string","description":"The workflow ID","example":"d201c5d9-d37b-4a2f-af14-66414f39d568"},"requestId":{"type":"string","description":"This backend ID tracks a workflow request in the system. You can provide this ID in a customer support ticket for debugging purposes.","example":"41e12a74fa7b4a6a98ae47887b64acdb"},"startTime":{"type":"string","format":"date-time","description":"The date/time the workflow started","example":"2022-02-07T20:13:29.356648026Z"},"closeTime":{"type":"string","format":"date-time","description":"The date/time the workflow ended","example":"2022-02-07T20:13:31.682410165Z"},"status":{"description":"The workflow execution status","type":"string","enum":["Completed","Failed","Canceled","Running"],"example":"Completed"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/workflow-executions/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get a Workflow Execution","description":{"content":"Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found.","type":"text/plain"},"url":{"path":["workflow-executions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the workflow execution","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a Workflow Execution' (get-workflow-execution)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a Workflow Execution + + + +Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + +
Path Parameters
+ +The workflow execution + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-workflow.api.mdx b/products/idn/api/beta/get-workflow.api.mdx new file mode 100644 index 000000000..052aaffd0 --- /dev/null +++ b/products/idn/api/beta/get-workflow.api.mdx @@ -0,0 +1,99 @@ +--- +id: get-workflow +sidebar_label: Get Workflow By Id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getWorkflow","tags":["Workflows"],"description":"Get a single workflow by id.","security":[{"oauth2":["sp:workflow:read"]}],"parameters":[{"name":"id","in":"path","description":"Id of the workflow","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b"}}],"responses":{"200":{"description":"The workflow object","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","description":"Workflow ID. This is a UUID generated upon creation.","example":"d201c5e9-d37b-4aff-af14-66414f39d569"},"executionCount":{"type":"integer","format":"int32","description":"The number of times this workflow has been executed","example":2},"failureCount":{"type":"integer","format":"int32","description":"The number of times this workflow has failed during execution","example":0},"created":{"type":"string","format":"date-time","description":"The date and time the workflow was created","example":"2022-01-10T16:06:16.636381447Z"},"creator":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that created the workflow.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}},"example":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"}}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the workflow","example":"Send Email"},"owner":{"description":"The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request.","properties":{"type":{"type":"string","enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"},"id":{"type":"string","description":"The unique ID of the object","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The name of the object","example":"William Wilson"}}},"description":{"type":"string","description":"Description of what the workflow accomplishes","example":"Send an email to the identity who's attributes changed."},"definition":{"type":"object","description":"The map of steps that the workflow will execute.","properties":{"start":{"type":"string","description":"The name of the starting step.","example":"Send Email Test"},"steps":{"type":"object","description":"One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type.","additionalProperties":true,"example":{"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":{"type":"boolean","description":"Enable or disable the workflow. Workflows cannot be created in an enabled state.","default":false,"example":false},"trigger":{"type":"object","description":"The trigger that starts the workflow","required":["type","attributes"],"properties":{"type":{"type":"string","enum":["EVENT","EXTERNAL","SCHEDULED"],"example":"EVENT","description":"The trigger type"},"attributes":{"anyOf":[{"title":"Event Trigger Attributes","type":"object","description":"Attributes related to an IdentityNow ETS event","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the trigger","example":"idn:identity-attributes-changed"},"filter.$":{"type":"string","description":"JSON path expression that will limit which events the trigger will fire on","example":"$.changes[?(@.attribute == 'manager')]"}}},{"title":"External Trigger Attributes","type":"object","description":"Attributes related to an external trigger","required":["name"],"properties":{"name":{"type":"string","description":"A unique name for the external trigger","example":"search-and-notify"},"description":{"type":"string","description":"Additonal context about the external trigger","example":"Run a search and notify the results"}}},{"title":"Scheduled Trigger Attributes","type":"object","description":"Attributes related to a scheduled trigger","required":["cronString"],"properties":{"cronString":{"type":"string","description":"A valid CRON expression","externalDocs":{"description":"CRON expression editor","url":"https://crontab.guru/"},"example":"0 * */3 */5 *"}}}],"description":"Workflow Trigger Attributes."}}}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/workflows/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get Workflow By Id","description":{"content":"Get a single workflow by id.","type":"text/plain"},"url":{"path":["workflows",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the workflow","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Workflow By Id' (get-workflow)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Workflow By Id + + + +Get a single workflow by id. + +
Path Parameters
+ +The workflow object + +
Schema
    creator object
    + +The identity that created the workflow. + +
    owner
    + +The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request. + +
    definition object
    + +The map of steps that the workflow will execute. + +
    steps object
    + +One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. + +
    trigger object
    + +The trigger that starts the workflow + +
    attributes object
    + +Workflow Trigger Attributes. + +
    anyOf
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/get-workgroup.api.mdx b/products/idn/api/beta/get-workgroup.api.mdx new file mode 100644 index 000000000..d79b91f77 --- /dev/null +++ b/products/idn/api/beta/get-workgroup.api.mdx @@ -0,0 +1,79 @@ +--- +id: get-workgroup +sidebar_label: Get an Governance Groups +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getWorkgroup","tags":["Governance Groups"],"description":"This API returns an Governance Groups by its ID.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"ID of the Governance Groups","example":"2c9180837ca6693d017ca8d097500149"}],"responses":{"200":{"description":"An Governance Groups","content":{"application/json":{"schema":{"type":"object","properties":{"owner":{"description":"Owner of the Governance Group","type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable name of the owner","example":"William Wilson"},"displayName":{"type":"string","description":"Human-readable display name of the owner","example":"William"},"emailAddress":{"type":"string","description":"Email ID of the owner","example":"william@sailpoint.com"}}},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"description":{"type":"string","description":"Description of the Governance Group","example":"Description of the Governance Group"},"memberCount":{"type":"integer","format":"int64","example":1641498673000,"description":"Number of members in the Governance Group."},"connectionCount":{"type":"integer","format":"int64","example":1641498673000,"description":"Number of connections in the Governance Group."}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:workgroup:read"]}],"method":"get","path":"/workgroups/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get an Governance Groups","description":{"content":"This API returns an Governance Groups by its ID.","type":"text/plain"},"url":{"path":["workgroups",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Governance Groups","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get an Governance Groups' (get-workgroup)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get an Governance Groups + + + +This API returns an Governance Groups by its ID. + +
Path Parameters
+ +An Governance Groups + +
Schema
    owner object
    + +Owner of the Governance Group + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/governance-groups.tag.mdx b/products/idn/api/beta/governance-groups.tag.mdx new file mode 100644 index 000000000..3afb26408 --- /dev/null +++ b/products/idn/api/beta/governance-groups.tag.mdx @@ -0,0 +1,25 @@ +--- +id: governance-groups +title: "Governance Groups" +description: "Governance Groups" +custom_edit_url: null +--- + + + +Use this API to implement and customize Governance Group functionality. With this functionality in place, administrators can create Governance Groups and configure them for use throughout IdentityNow. + +A governance group is a group of users that can make governance decisions about access. If your organization has the Access Request or Certifications service, you can configure governance groups to review access requests or certifications. A governance group can determine whether specific access is appropriate for a user. + +Refer to [Creating and Managing Governance Groups](https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html) for more information about how to build Governance Groups in the visual builder in the IdentityNow UI. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/iai-access-request-recommendations.tag.mdx b/products/idn/api/beta/iai-access-request-recommendations.tag.mdx new file mode 100644 index 000000000..18d957fc2 --- /dev/null +++ b/products/idn/api/beta/iai-access-request-recommendations.tag.mdx @@ -0,0 +1,16 @@ +--- +id: iai-access-request-recommendations +title: "IAI Access Request Recommendations" +description: "IAI Access Request Recommendations" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/iai-common-access.tag.mdx b/products/idn/api/beta/iai-common-access.tag.mdx new file mode 100644 index 000000000..dbbfe87e0 --- /dev/null +++ b/products/idn/api/beta/iai-common-access.tag.mdx @@ -0,0 +1,16 @@ +--- +id: iai-common-access +title: "IAI Common Access" +description: "IAI Common Access" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/iai-outliers.tag.mdx b/products/idn/api/beta/iai-outliers.tag.mdx new file mode 100644 index 000000000..8718a2441 --- /dev/null +++ b/products/idn/api/beta/iai-outliers.tag.mdx @@ -0,0 +1,16 @@ +--- +id: iai-outliers +title: "IAI Outliers" +description: "IAI Outliers" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/iai-peer-group-strategies.tag.mdx b/products/idn/api/beta/iai-peer-group-strategies.tag.mdx new file mode 100644 index 000000000..ec04b18af --- /dev/null +++ b/products/idn/api/beta/iai-peer-group-strategies.tag.mdx @@ -0,0 +1,16 @@ +--- +id: iai-peer-group-strategies +title: "IAI Peer Group Strategies" +description: "IAI Peer Group Strategies" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/iai-recommendations.tag.mdx b/products/idn/api/beta/iai-recommendations.tag.mdx new file mode 100644 index 000000000..7149c8f93 --- /dev/null +++ b/products/idn/api/beta/iai-recommendations.tag.mdx @@ -0,0 +1,16 @@ +--- +id: iai-recommendations +title: "IAI Recommendations" +description: "IAI Recommendations" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/iai-role-mining.tag.mdx b/products/idn/api/beta/iai-role-mining.tag.mdx new file mode 100644 index 000000000..d66d5aae8 --- /dev/null +++ b/products/idn/api/beta/iai-role-mining.tag.mdx @@ -0,0 +1,16 @@ +--- +id: iai-role-mining +title: "IAI Role Mining" +description: "IAI Role Mining" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/identities.tag.mdx b/products/idn/api/beta/identities.tag.mdx new file mode 100644 index 000000000..46b372d5e --- /dev/null +++ b/products/idn/api/beta/identities.tag.mdx @@ -0,0 +1,35 @@ +--- +id: identities +title: "Identities" +description: "Identities" +custom_edit_url: null +--- + + + +Use this API to implement identity functionality. +With this functionality in place, administrators can synchronize an identity's attributes with its various source attributes. + +IdentityNow uses identities as users' authoritative accounts. Identities can own other accounts, entitlements, and attributes. + +An identity has a variety of attributes, such as an account name, an email address, a job title, and more. +These identity attributes can be correlated with different attributes on different sources. +For example, the identity John.Smith can own an account in the GitHub source with the account name John-Smith-Org, and IdentityNow knows they are the same person with the same access and attributes. + +In IdentityNow, administrators often set up these synchronizations to get triggered automatically with a change or to run on a schedule. +To manually synchronize attributes for an identity, administrators can use the Identities drop-down menu and select Identity List to view the list of identities. +They can then select the identity they want to manually synchronize and use the hamburger menu to select 'Synchronize Attributes.' +Doing so immediately begins the attribute synchronization and analyzes all accounts for the selected identity. + +Refer to [Synchronizing Attributes](https://documentation.sailpoint.com/saas/help/provisioning/attr_sync.html) for more information about synchronizing attributes. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/identity-history.tag.mdx b/products/idn/api/beta/identity-history.tag.mdx new file mode 100644 index 000000000..9c3bd4af0 --- /dev/null +++ b/products/idn/api/beta/identity-history.tag.mdx @@ -0,0 +1,16 @@ +--- +id: identity-history +title: "Identity History" +description: "Identity History" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/identity-profiles.tag.mdx b/products/idn/api/beta/identity-profiles.tag.mdx new file mode 100644 index 000000000..55d065643 --- /dev/null +++ b/products/idn/api/beta/identity-profiles.tag.mdx @@ -0,0 +1,31 @@ +--- +id: identity-profiles +title: "Identity Profiles" +description: "Identity Profiles" +custom_edit_url: null +--- + + + +Use this API to implement and customize identity profile functionality. +With this functionality in place, administrators can manage identity profiles and configure them for use by identities throughout IdentityNow. + +Identity profiles represent the configurations that can be applied to identities as a way of granting them a set of security and access, as well as defining the mappings between their identity attributes and their source attributes. +This allows administrators to save time by applying identity profiles to any number of similar identities rather than configuring each one individually. + +In IdentityNow, administrators can use the Identities drop-down menu and select Identity Profiles to view the list of identity profiles. +This list shows some details about each identity profile, along with its status. They can select an identity profile to view and modify its settings, its mappings between identity attributes and correlating source account attributes, and its provisioning settings. +Administrators can also use this page to create new identity profiles or delete existing ones. + +Refer to [Creating Identity Profiles](https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html) for more information about identity profiles. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/identitynow-beta-api.info.mdx b/products/idn/api/beta/identitynow-beta-api.info.mdx new file mode 100644 index 000000000..e12561ffd --- /dev/null +++ b/products/idn/api/beta/identitynow-beta-api.info.mdx @@ -0,0 +1,36 @@ +--- +id: identitynow-beta-api +sidebar_label: Introduction +sidebar_position: 0 +hide_title: true +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'IdentityNow Beta API' (identitynow-beta-api)" +--- + +import ApiLogo from "@theme/ApiLogo"; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import Export from "@theme/ApiDemoPanel/Export"; + +Version: 3.1.0-beta + + + +# IdentityNow Beta API + + + +Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + +

Authentication

+ +OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information. +- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) +- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) +- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) + +Which authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use) + +Learn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details) + + +
Security Scheme Type:oauth2
clientCredentials OAuth Flow:

Token URL: https://tenant.api.identitynow.com/oauth/token

Scopes:
  • sp:scopes:default: default scope
  • sp:scopes:all: access to all scopes
authorizationCode OAuth Flow:

Token URL: https://tenant.api.identitynow.com/oauth/token

Authorization URL: https://tenant.identitynow.com/oauth/authorize

Scopes:
  • sp:scopes:default: default scope
  • sp:scopes:all: access to all scopes

Contact

Developer Relations: URL: https://developer.sailpoint.com/discuss/api-help

License

MIT
\ No newline at end of file diff --git a/products/idn/api/beta/ignore-identity-outliers.api.mdx b/products/idn/api/beta/ignore-identity-outliers.api.mdx new file mode 100644 index 000000000..506c36ca7 --- /dev/null +++ b/products/idn/api/beta/ignore-identity-outliers.api.mdx @@ -0,0 +1,76 @@ +--- +id: ignore-identity-outliers +sidebar_label: IAI Identity Outliers Ignore +hide_title: true +hide_table_of_contents: true +api: {"operationId":"ignoreIdentityOutliers","tags":["IAI Outliers"],"description":"This API receives a list of IdentityIDs in the request, changes the outliers to be ignored--returning a 204 if successful.\nRequires authorization scope of 'iai:outliers-management:update'","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"description":"List of identity IDs to ignore from outlier listing","example":["abc123def456","ghi789jkl012"]}}}},"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/outliers/ignore","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":["abc123def456","ghi789jkl012"],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"IAI Identity Outliers Ignore","description":{"content":"This API receives a list of IdentityIDs in the request, changes the outliers to be ignored--returning a 204 if successful.\nRequires authorization scope of 'iai:outliers-management:update'","type":"text/plain"},"url":{"path":["outliers","ignore"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'IAI Identity Outliers Ignore' (ignore-identity-outliers)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## IAI Identity Outliers Ignore + + + +This API receives a list of IdentityIDs in the request, changes the outliers to be ignored--returning a 204 if successful. +Requires authorization scope of 'iai:outliers-management:update' + +
Request Body array required
  • string
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/import-form-definitions.api.mdx b/products/idn/api/beta/import-form-definitions.api.mdx new file mode 100644 index 000000000..ab6d78c86 --- /dev/null +++ b/products/idn/api/beta/import-form-definitions.api.mdx @@ -0,0 +1,119 @@ +--- +id: import-form-definitions +sidebar_label: Import form definitions from export. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Custom Forms"],"operationId":"importFormDefinitions","requestBody":{"description":"Body is the request payload to import form definitions","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"object":{"properties":{"created":{"description":"Created is the date the form definition was created","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Created"},"description":{"description":"Description is the form definition description","example":"My form description","type":"string","x-go-name":"Description"},"formConditions":{"description":"FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form","items":{"description":"FormCondition represent a form conditional","properties":{"effects":{"description":"Effects is a list of effects","items":{"description":"ConditionEffect is the effect produced by a condition","properties":{"config":{"additionalProperties":{},"description":"Config is a arbitrary map that holds a configuration based on EffectType","example":{},"type":"object","x-go-name":"Config"},"effectType":{"description":"EffectType is the type of effect to perform when the conditions are evaluated for this logic block\nHIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","enum":["HIDE","SHOW","DISABLE","ENABLE","REQUIRE","OPTIONAL","SUBMIT_MESSAGE","SUBMIT_NOTIFICATION","SET_DEFAULT_VALUE"],"example":"HIDE","type":"string","x-go-enum-desc":"HIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","x-go-name":"EffectType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Effects"},"ruleOperator":{"description":"RuleOperator is a ConditionRuleLogicalOperatorType value\nAND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","enum":["AND","OR"],"example":"AND","type":"string","x-go-enum-desc":"AND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","x-go-name":"RuleOperator"},"rules":{"description":"Rules is a list of rules","items":{"properties":{"operator":{"description":"Operator is a ConditionRuleComparisonOperatorType value\nEQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","enum":["EQ","NE","CO","NOT_CO","IN","NOT_IN","EM","NOT_EM","SW","NOT_SW","EW","NOT_EW"],"example":"EQ","type":"string","x-go-enum-desc":"EQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","x-go-name":"Operator"},"source":{"description":"Source, if the sourceType is ConditionRuleSourceTypeInput then the source type is the name of the form input to accept. While if the sourceType is ConditionRuleSourceTypeElement\nthen source is the name of a technical key of an element to retrieve its value","example":"department","type":"string","x-go-name":"Source"},"sourceType":{"description":"SourceType defines what type of object is being selected. Either a reference to a form input (by input name), or a form element (by technical key)\nINPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","enum":["INPUT","ELEMENT"],"example":"ELEMENT","type":"string","x-go-enum-desc":"INPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","x-go-name":"SourceType"},"value":{"description":"Value is the value based on the ValueType","example":"Engineering","x-go-name":"Value"},"valueType":{"description":"ValueType is a ConditionRuleValueType type\nSTRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","enum":["STRING","STRING_LIST","INPUT","ELEMENT","LIST","BOOLEAN"],"example":"STRING","type":"string","x-go-enum-desc":"STRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","x-go-name":"ValueType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Rules"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormConditions"},"formElements":{"description":"FormElements is a list of nested form elements","items":{"properties":{"config":{"additionalProperties":{},"description":"Config is a config object","example":{"label":"Department"},"type":"object","x-go-name":"Config"},"elementType":{"description":"ElementType is a FormElementType value\nTEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","enum":["TEXT","TOGGLE","TEXTAREA","HIDDEN","PHONE","EMAIL","SELECT","DATE","SECTION","COLUMNS"],"example":"TEXT","type":"string","x-go-enum-desc":"TEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","x-go-name":"ElementType"},"id":{"description":"ID is a form element identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"key":{"description":"Key is the technical key","example":"department","type":"string","x-go-name":"Key"},"validations":{"description":"FormElementValidationsSet is a set of FormElementValidation items","example":[{"validationType":"REQUIRED"}],"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormElements"},"formInput":{"description":"FormInput is a list of form inputs that are required when creating a form-instance object","items":{"properties":{"description":{"description":"Description is the description for this form input value","example":"A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic","type":"string","x-go-name":"Description"},"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"label":{"description":"Label is the name for this form input value","example":"input1","type":"string","x-go-name":"Label"},"type":{"description":"Type is a FormDefinitionInputType value\nSTRING FormDefinitionInputTypeString","enum":["STRING"],"example":"STRING","type":"string","x-go-enum-desc":"STRING FormDefinitionInputTypeString","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormInput"},"id":{"description":"FormDefinitionID is a unique guid identifying this form definition","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"FormDefinitionID"},"modified":{"description":"Modified is the last date the form definition was modified","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Modified"},"name":{"description":"Name is the form definition name","example":"My form","type":"string","x-go-name":"Name"},"owner":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a FormOwnerType value\nIDENTITY FormOwnerTypeIdentity","enum":["IDENTITY"],"example":"IDENTITY","type":"string","x-go-enum-desc":"IDENTITY FormOwnerTypeIdentity","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"usedBy":{"description":"UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used","items":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a FormUsedByType value\nWORKFLOW FormUsedByTypeWorkflow\nSOURCE FormUsedByTypeSource","enum":["WORKFLOW","SOURCE"],"example":"WORKFLOW","type":"string","x-go-enum-desc":"WORKFLOW FormUsedByTypeWorkflow\nSOURCE FormUsedByTypeSource","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"UsedBy"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"self":{"type":"string","x-go-name":"Self"},"version":{"type":"integer","format":"int8","x-go-name":"Version"}}}},"example":[{"version":1,"self":{"name":"All fields not required","id":"05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa","type":"FORM_DEFINITION"},"object":{"id":"05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa","name":"All fields not required","description":"description","owner":{"type":"IDENTITY","id":"3447d8ec2602455ab6f1e8408a0f0150"},"usedBy":[{"type":"WORKFLOW","id":"5008594c-dacc-4295-8fee-41df60477304"},{"type":"WORKFLOW","id":"97e75a75-c179-4fbc-a2da-b5fa4aaa8743"}],"formInput":[{"type":"STRING","label":"input1","description":"A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic"}],"formElements":[{"id":"3069272797630701","elementType":"SECTION","config":{"label":"First Section","formElements":[{"id":"3069272797630700","elementType":"TEXT","key":"firstName","config":{"label":"First Name"}},{"id":"3498415402897539","elementType":"TEXT","key":"lastName","config":{"label":"Last Name"}}]}}],"formConditions":[{"ruleOperator":"AND","rules":[{"sourceType":"INPUT","source":"Department","operator":"EQ","valueType":"STRING","value":"Sales"}],"effects":[{"effectType":"HIDE","config":{"element":"2614088730489570"}}]}],"created":"2022-10-04T19:27:04.456Z","modified":"2022-11-16T20:45:02.172Z"}}]}},"required":false},"responses":{"202":{"description":"Returns statuses of those form definition objects imported","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"object","additionalProperties":{"type":"object"},"x-go-name":"Detail"},"key":{"type":"string","x-go-name":"Key"},"text":{"type":"string","x-go-name":"Text"}}},"x-go-name":"Errors"},"importedObjects":{"type":"array","items":{"type":"object","properties":{"object":{"properties":{"created":{"description":"Created is the date the form definition was created","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Created"},"description":{"description":"Description is the form definition description","example":"My form description","type":"string","x-go-name":"Description"},"formConditions":{"description":"FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form","items":{"description":"FormCondition represent a form conditional","properties":{"effects":{"description":"Effects is a list of effects","items":{"description":"ConditionEffect is the effect produced by a condition","properties":{"config":{"additionalProperties":{},"description":"Config is a arbitrary map that holds a configuration based on EffectType","example":{},"type":"object","x-go-name":"Config"},"effectType":{"description":"EffectType is the type of effect to perform when the conditions are evaluated for this logic block\nHIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","enum":["HIDE","SHOW","DISABLE","ENABLE","REQUIRE","OPTIONAL","SUBMIT_MESSAGE","SUBMIT_NOTIFICATION","SET_DEFAULT_VALUE"],"example":"HIDE","type":"string","x-go-enum-desc":"HIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","x-go-name":"EffectType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Effects"},"ruleOperator":{"description":"RuleOperator is a ConditionRuleLogicalOperatorType value\nAND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","enum":["AND","OR"],"example":"AND","type":"string","x-go-enum-desc":"AND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","x-go-name":"RuleOperator"},"rules":{"description":"Rules is a list of rules","items":{"properties":{"operator":{"description":"Operator is a ConditionRuleComparisonOperatorType value\nEQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","enum":["EQ","NE","CO","NOT_CO","IN","NOT_IN","EM","NOT_EM","SW","NOT_SW","EW","NOT_EW"],"example":"EQ","type":"string","x-go-enum-desc":"EQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","x-go-name":"Operator"},"source":{"description":"Source, if the sourceType is ConditionRuleSourceTypeInput then the source type is the name of the form input to accept. While if the sourceType is ConditionRuleSourceTypeElement\nthen source is the name of a technical key of an element to retrieve its value","example":"department","type":"string","x-go-name":"Source"},"sourceType":{"description":"SourceType defines what type of object is being selected. Either a reference to a form input (by input name), or a form element (by technical key)\nINPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","enum":["INPUT","ELEMENT"],"example":"ELEMENT","type":"string","x-go-enum-desc":"INPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","x-go-name":"SourceType"},"value":{"description":"Value is the value based on the ValueType","example":"Engineering","x-go-name":"Value"},"valueType":{"description":"ValueType is a ConditionRuleValueType type\nSTRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","enum":["STRING","STRING_LIST","INPUT","ELEMENT","LIST","BOOLEAN"],"example":"STRING","type":"string","x-go-enum-desc":"STRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","x-go-name":"ValueType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Rules"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormConditions"},"formElements":{"description":"FormElements is a list of nested form elements","items":{"properties":{"config":{"additionalProperties":{},"description":"Config is a config object","example":{"label":"Department"},"type":"object","x-go-name":"Config"},"elementType":{"description":"ElementType is a FormElementType value\nTEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","enum":["TEXT","TOGGLE","TEXTAREA","HIDDEN","PHONE","EMAIL","SELECT","DATE","SECTION","COLUMNS"],"example":"TEXT","type":"string","x-go-enum-desc":"TEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","x-go-name":"ElementType"},"id":{"description":"ID is a form element identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"key":{"description":"Key is the technical key","example":"department","type":"string","x-go-name":"Key"},"validations":{"description":"FormElementValidationsSet is a set of FormElementValidation items","example":[{"validationType":"REQUIRED"}],"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormElements"},"formInput":{"description":"FormInput is a list of form inputs that are required when creating a form-instance object","items":{"properties":{"description":{"description":"Description is the description for this form input value","example":"A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic","type":"string","x-go-name":"Description"},"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"label":{"description":"Label is the name for this form input value","example":"input1","type":"string","x-go-name":"Label"},"type":{"description":"Type is a FormDefinitionInputType value\nSTRING FormDefinitionInputTypeString","enum":["STRING"],"example":"STRING","type":"string","x-go-enum-desc":"STRING FormDefinitionInputTypeString","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormInput"},"id":{"description":"FormDefinitionID is a unique guid identifying this form definition","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"FormDefinitionID"},"modified":{"description":"Modified is the last date the form definition was modified","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Modified"},"name":{"description":"Name is the form definition name","example":"My form","type":"string","x-go-name":"Name"},"owner":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a FormOwnerType value\nIDENTITY FormOwnerTypeIdentity","enum":["IDENTITY"],"example":"IDENTITY","type":"string","x-go-enum-desc":"IDENTITY FormOwnerTypeIdentity","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"usedBy":{"description":"UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used","items":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a FormUsedByType value\nWORKFLOW FormUsedByTypeWorkflow\nSOURCE FormUsedByTypeSource","enum":["WORKFLOW","SOURCE"],"example":"WORKFLOW","type":"string","x-go-enum-desc":"WORKFLOW FormUsedByTypeWorkflow\nSOURCE FormUsedByTypeSource","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"UsedBy"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"self":{"type":"string","x-go-name":"Self"},"version":{"type":"integer","format":"int8","x-go-name":"Version"}}},"x-go-name":"ImportedObjects"},"infos":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"object","additionalProperties":{"type":"object"},"x-go-name":"Detail"},"key":{"type":"string","x-go-name":"Key"},"text":{"type":"string","x-go-name":"Text"}}},"x-go-name":"Infos"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"object","additionalProperties":{"type":"object"},"x-go-name":"Detail"},"key":{"type":"string","x-go-name":"Key"},"text":{"type":"string","x-go-name":"Text"}}},"x-go-name":"Warnings"}}}}}},"400":{"description":"An error with the request occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"401":{"description":"An error with the authorization occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"403":{"description":"An error with the user permissions occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"title":"Error is the standard API error response type.","type":"object","properties":{"detailCode":{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"trackingId":{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"}}}},"500":{"description":"An internal server error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}}},"security":[{"oauth2":["sp:forms:manage"]}],"x-codegen-request-body-name":"Body","description":"Import form definitions from export.","method":"post","path":"/form-definitions/import","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"object":{"created":"2023-07-12T20:14:57.74486Z","description":"My form description","formConditions":[{"effects":[{"config":{},"effectType":"HIDE"}],"ruleOperator":"AND","rules":[{"operator":"EQ","source":"department","sourceType":"ELEMENT","value":"Engineering","valueType":"STRING"}]}],"formElements":[{"config":{"label":"Department"},"elementType":"TEXT","id":"00000000-0000-0000-0000-000000000000","key":"department","validations":[{"validationType":"REQUIRED"}]}],"formInput":[{"description":"A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic","id":"00000000-0000-0000-0000-000000000000","label":"input1","type":"STRING"}],"id":"00000000-0000-0000-0000-000000000000","modified":"2023-07-12T20:14:57.74486Z","name":"My form","owner":{"id":"00000000-0000-0000-0000-000000000000","type":"IDENTITY"},"usedBy":[{"id":"00000000-0000-0000-0000-000000000000","type":"WORKFLOW"}]},"self":"string","version":0}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Import form definitions from export.","description":{"type":"text/plain"},"url":{"path":["form-definitions","import"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Import form definitions from export.' (import-form-definitions)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Import form definitions from export. + + + +Import form definitions from export. + +
Request Body array
+ +Body is the request payload to import form definitions + +
    object object
    formConditions object[]
    + +FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form + +
    effects object[]
    + +Effects is a list of effects + +
    config object
    + +Config is a arbitrary map that holds a configuration based on EffectType + +
    rules object[]
    + +Rules is a list of rules + +
    formElements object[]
    + +FormElements is a list of nested form elements + +
    config object
    + +Config is a config object + +
    formInput object[]
    + +FormInput is a list of form inputs that are required when creating a form-instance object + +
    owner object
    usedBy object[]
    + +UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used + +
+ +Returns statuses of those form definition objects imported + +
Schema
    errors object[]
    detail object
  • property name* object
    • importedObjects object[]
    object object
    formConditions object[]
    + +FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form + +
    effects object[]
    + +Effects is a list of effects + +
    config object
    + +Config is a arbitrary map that holds a configuration based on EffectType + +
    rules object[]
    + +Rules is a list of rules + +
    formElements object[]
    + +FormElements is a list of nested form elements + +
    config object
    + +Config is a config object + +
    formInput object[]
    + +FormInput is a list of form inputs that are required when creating a form-instance object + +
    owner object
    usedBy object[]
    + +UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used + +
    infos object[]
    detail object
  • property name* object
    • warnings object[]
    detail object
  • property name* object
+ +An error with the request occurred + +
Schema
    messages object[]
+ +An error with the authorization occurred + +
Schema
    messages object[]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
+ +Too many requests + +
Schema
    messages object[]
+ +An internal server error occurred + +
Schema
    messages object[]
\ No newline at end of file diff --git a/products/idn/api/beta/import-identity-profiles.api.mdx b/products/idn/api/beta/import-identity-profiles.api.mdx new file mode 100644 index 000000000..c92e9cc5f --- /dev/null +++ b/products/idn/api/beta/import-identity-profiles.api.mdx @@ -0,0 +1,123 @@ +--- +id: import-identity-profiles +sidebar_label: Import Identity Profiles +hide_title: true +hide_table_of_contents: true +api: {"operationId":"importIdentityProfiles","description":"This imports previously exported identity profiles.","tags":["Identity Profiles"],"requestBody":{"description":"Previously exported Identity Profiles.","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Identity Profile exported object","properties":{"version":{"type":"integer","example":1,"description":"Version or object from the target service."},"self":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"object":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true},"modified":{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}},{"type":"object","required":["authoritativeSource"],"properties":{"description":{"type":"string","description":"The description of the Identity Profile.","example":"My custom flat file profile","nullable":true},"owner":{"type":"object","description":"The owner of the Identity Profile.","nullable":true,"properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Type of the object to which this reference applies","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"priority":{"type":"integer","format":"int64","description":"The priority for an Identity Profile.","example":10},"authoritativeSource":{"type":"object","properties":{"type":{"type":"string","enum":["SOURCE"],"description":"Type of the object to which this reference applies","example":"SOURCE"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"HR Active Directory"}}},"identityRefreshRequired":{"type":"boolean","default":false,"description":"True if a identity refresh is needed. Typically triggered when a change on the source has been made.","example":true},"identityCount":{"type":"integer","description":"The number of identities that belong to the Identity Profile.","format":"int32","example":8},"identityAttributeConfig":{"type":"object","description":"Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process.","properties":{"enabled":{"description":"The backend will only promote values if the profile/mapping is enabled.","type":"boolean","default":false,"example":true},"attributeTransforms":{"type":"array","items":{"type":"object","description":"Defines a transformation definition for an identity attribute.","properties":{"identityAttributeName":{"type":"string","description":"Name of the identity attribute.","example":"email"},"transformDefinition":{"description":"The seaspray transformation definition.","type":"object","properties":{"type":{"type":"string","description":"The type of the transform definition.","example":"accountAttribute"},"attributes":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"object"}]},"description":"Arbitrary key-value pairs to store any metadata for the object","example":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}}}}}}}}},"identityExceptionReportReference":{"type":"object","nullable":true,"properties":{"taskResultId":{"type":"string","format":"uuid","description":"The id of the task result.","example":"2b838de9-db9b-abcf-e646-d4f274ad4238"},"reportName":{"type":"string","example":"My annual report","description":"The name of the report."}}},"hasTimeBasedAttr":{"description":"Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile.","type":"boolean","default":false,"example":true}}}]}}}}}}},"responses":{"200":{"description":"The result of importing Identity Profiles.","content":{"application/json":{"schema":{"type":"object","title":"Import Object Response Body","description":"Response model for import of a single object.","properties":{"infos":{"description":"Informational messages returned from the target service on import.","type":"array","items":{"type":"object","title":"Config Import/Export Message","description":"Message model for Config Import/Export.","properties":{"key":{"type":"string","description":"Message key.","example":"UNKNOWN_REFERENCE_RESOLVER"},"text":{"type":"string","description":"Message text.","example":"Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]"},"details":{"type":"object","description":"Message details if any, in key:value pairs.","additionalProperties":{"type":"object"},"example":{"details":"message details"}}},"required":["key","text","details"]}},"warnings":{"description":"Warning messages returned from the target service on import.","type":"array","items":{"type":"object","title":"Config Import/Export Message","description":"Message model for Config Import/Export.","properties":{"key":{"type":"string","description":"Message key.","example":"UNKNOWN_REFERENCE_RESOLVER"},"text":{"type":"string","description":"Message text.","example":"Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]"},"details":{"type":"object","description":"Message details if any, in key:value pairs.","additionalProperties":{"type":"object"},"example":{"details":"message details"}}},"required":["key","text","details"]}},"errors":{"description":"Error messages returned from the target service on import.","type":"array","items":{"type":"object","title":"Config Import/Export Message","description":"Message model for Config Import/Export.","properties":{"key":{"type":"string","description":"Message key.","example":"UNKNOWN_REFERENCE_RESOLVER"},"text":{"type":"string","description":"Message text.","example":"Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]"},"details":{"type":"object","description":"Message details if any, in key:value pairs.","additionalProperties":{"type":"object"},"example":{"details":"message details"}}},"required":["key","text","details"]}},"importedObjects":{"description":"References to objects that were created or updated by the import.","type":"array","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}}},"required":["infos","warnings","errors","importedObjects"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:identity-profile:manage"]}],"method":"post","path":"/identity-profiles/import","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"version":1,"self":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"},"object":{"name":"aName","description":"My custom flat file profile","owner":{"type":"IDENTITY","id":"2c9180835d191a86015d28455b4b232a","name":"William Wilson"},"priority":10,"authoritativeSource":{"type":"SOURCE","id":"2c9180835d191a86015d28455b4b232a","name":"HR Active Directory"},"identityRefreshRequired":true,"identityCount":8,"identityAttributeConfig":{"enabled":true,"attributeTransforms":[{"identityAttributeName":"email","transformDefinition":{"type":"accountAttribute","attributes":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}}}]},"identityExceptionReportReference":{"taskResultId":"2b838de9-db9b-abcf-e646-d4f274ad4238","reportName":"My annual report"},"hasTimeBasedAttr":true}}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Import Identity Profiles","description":{"content":"This imports previously exported identity profiles.","type":"text/plain"},"url":{"path":["identity-profiles","import"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Import Identity Profiles' (import-identity-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Import Identity Profiles + + + +This imports previously exported identity profiles. + +
Request Body array required
+ +Previously exported Identity Profiles. + +
    self object
    object object
    owner object
    + +The owner of the Identity Profile. + +
    authoritativeSource object required
    identityAttributeConfig object
    + +Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. + +
    attributeTransforms object[]
    transformDefinition object
    + +The seaspray transformation definition. + +
    attributes object
    + +Arbitrary key-value pairs to store any metadata for the object + +
    identityExceptionReportReference object
+ +The result of importing Identity Profiles. + +
Schema
    infos object[]
    + +Informational messages returned from the target service on import. + +
    details object
    + +Message details if any, in key:value pairs. + +
  • property name* object
    • warnings object[]
    + +Warning messages returned from the target service on import. + +
    details object
    + +Message details if any, in key:value pairs. + +
  • property name* object
    • errors object[]
    + +Error messages returned from the target service on import. + +
    details object
    + +Message details if any, in key:value pairs. + +
  • property name* object
    • importedObjects object[]
    + +References to objects that were created or updated by the import. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/import-non-employee-records-in-bulk.api.mdx b/products/idn/api/beta/import-non-employee-records-in-bulk.api.mdx new file mode 100644 index 000000000..45360eb61 --- /dev/null +++ b/products/idn/api/beta/import-non-employee-records-in-bulk.api.mdx @@ -0,0 +1,91 @@ +--- +id: import-non-employee-records-in-bulk +sidebar_label: Imports, or Updates, Non-Employee Records +hide_title: true +hide_table_of_contents: true +api: {"operationId":"importNonEmployeeRecordsInBulk","security":[{"oauth2":["idn:nelm:manage"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This post will import, or update, Non-Employee records found in the CSV.\nRequest will need the following security scope:\n'idn:nesr:create'","parameters":[{"in":"path","name":"id","description":"Source Id (UUID)","required":true,"schema":{"type":"string"},"example":"e136567de87e4d029e60b3c3c55db56d"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"data":{"type":"string","format":"binary"}},"required":["data"]}}}},"responses":{"202":{"description":"The CSV was accepted to be bulk inserted now or at a later time.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The bulk upload job's ID. (UUID)","example":"2c91808568c529c60168cca6f90cffff"},"sourceId":{"type":"string","description":"The ID of the source to bulk-upload non-employees to. (UUID)","example":"2c91808568c529c60168cca6f90c1313"},"created":{"type":"string","format":"date-time","description":"The date-time the job was submitted.","example":"2019-08-23T18:52:59.162Z"},"modified":{"type":"string","format":"date-time","description":"The date-time that the job was last updated.","example":"2019-08-23T18:52:59.162Z"},"status":{"type":"string","enum":["PENDING","IN_PROGRESS","COMPLETED","ERROR"],"description":"Returns the following values indicating the progress or result of the bulk upload job.\n\"PENDING\" means the job is queued and waiting to be processed.\n\"IN_PROGRESS\" means the job is currently being processed.\n\"COMPLETED\" means the job has been completed without any errors.\n\"ERROR\" means the job failed to process with errors.\n","example":"PENDING"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.\nThe response body will contain the list of specific errors with one on each line.\n","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/non-employee-sources/{id}/non-employee-bulk-upload","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Imports, or Updates, Non-Employee Records","description":{"content":"This post will import, or update, Non-Employee records found in the CSV.\nRequest will need the following security scope:\n'idn:nesr:create'","type":"text/plain"},"url":{"path":["non-employee-sources",":id","non-employee-bulk-upload"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Source Id (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[]},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Imports, or Updates, Non-Employee Records' (import-non-employee-records-in-bulk)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Imports, or Updates, Non-Employee Records + + + +This post will import, or update, Non-Employee records found in the CSV. +Request will need the following security scope: +'idn:nesr:create' + +
Path Parameters
Request Body
+ +The CSV was accepted to be bulk inserted now or at a later time. + +
Schema
+ +Client Error - Returned if the request body is invalid. +The response body will contain the list of specific errors with one on each line. + + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/import-source-accounts-schema.api.mdx b/products/idn/api/beta/import-source-accounts-schema.api.mdx new file mode 100644 index 000000000..2a78959ce --- /dev/null +++ b/products/idn/api/beta/import-source-accounts-schema.api.mdx @@ -0,0 +1,83 @@ +--- +id: import-source-accounts-schema +sidebar_label: Uploads source accounts schema template +hide_title: true +hide_table_of_contents: true +api: {"tags":["Sources"],"description":"This API uploads a source schema template file to configure a source's account attributes.","operationId":"importSourceAccountsSchema","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"The Source id","example":"8c190e6787aa4ed9a90bd9d5344523fb"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Successfully uploaded the file","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Schema.","example":"2c9180835d191a86015d28455b4a2329"},"name":{"type":"string","description":"The name of the Schema.","example":"account"},"nativeObjectType":{"type":"string","description":"The name of the object type on the native system that the schema represents.","example":"User"},"identityAttribute":{"type":"string","description":"The name of the attribute used to calculate the unique identifier for an object in the schema.","example":"sAMAccountName"},"displayAttribute":{"type":"string","description":"The name of the attribute used to calculate the display value for an object in the schema.","example":"distinguishedName"},"hierarchyAttribute":{"type":"string","description":"The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.","example":"memberOf"},"includePermissions":{"type":"boolean","description":"Flag indicating whether or not the include permissions with the object data when aggregating the schema.","example":false},"features":{"type":"array","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING."},"description":"The features that the schema supports.","example":["PROVISIONING","NO_PERMISSIONS_PROVISIONING","GROUPS_HAVE_MEMBERS"]},"configuration":{"type":"object","description":"Holds any extra configuration data that the schema may require.","example":{"groupMemberAttribute":"member"}},"attributes":{"type":"array","description":"The attribute definitions which form the schema.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"sAMAccountName"},"type":{"type":"string","enum":["STRING","LONG","INT","BOOLEAN"],"description":"The underlying type of the value which an AttributeDefinition represents.","example":"STRING"},"schema":{"description":"A reference to the schema on the source to the attribute values map to.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"The object ID this reference applies to.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The human-readable display name of the object.","example":"group"}}},"description":{"type":"string","description":"A human-readable description of the attribute.","example":"The sAMAccountName attribute"},"isMulti":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","example":false},"isEntitlement":{"type":"boolean","description":"Flag indicating whether or not the attribute is an entitlement.","example":false},"isGroup":{"type":"boolean","description":"Flag indicating whether or not the attribute represents a group.\nThis can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute..\n","example":false}}},"example":[{"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":{"type":"string","description":"The date the Schema was created.","format":"date-time","example":"2019-12-24T22:32:58.104Z"},"modified":{"type":"string","description":"The date the Schema was last modified.","format":"date-time","example":"2019-12-31T20:22:28.104Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:source-schema:manage"]}],"method":"post","path":"/sources/{id}/schemas/accounts","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Uploads source accounts schema template","description":{"content":"This API uploads a source schema template file to configure a source's account attributes.","type":"text/plain"},"url":{"path":["sources",":id","schemas","accounts"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[]},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Uploads source accounts schema template' (import-source-accounts-schema)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Uploads source accounts schema template + + + +This API uploads a source schema template file to configure a source's account attributes. + +
Path Parameters
Request Body required
+ +Successfully uploaded the file + +
Schema
    attributes object[]
    + +The attribute definitions which form the schema. + +
    schema object
    + +A reference to the schema on the source to the attribute values map to. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/import-source-connector-file.api.mdx b/products/idn/api/beta/import-source-connector-file.api.mdx new file mode 100644 index 000000000..849720e60 --- /dev/null +++ b/products/idn/api/beta/import-source-connector-file.api.mdx @@ -0,0 +1,116 @@ +--- +id: import-source-connector-file +sidebar_label: Upload connector file to source +hide_title: true +hide_table_of_contents: true +api: {"operationId":"importSourceConnectorFile","security":[{"oauth2":["idn:sources-admin:manage"]}],"tags":["Sources"],"description":"This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events.\nA token with ORG_ADMIN authority is required to call this API.","parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source id","example":"8c190e6787aa4ed9a90bd9d5344523fb"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Uploaded the file successfully and sent all post-upload events","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"the id of the Source","example":"2c91808568c529c60168cca6f90c1324"},"name":{"type":"string","description":"Human-readable name of the source","example":"My Source"},"description":{"type":"string","description":"Human-readable description of the source","example":"This is the corporate directory."},"owner":{"description":"Reference to an owning Identity Object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity","example":"MyName"}}},"cluster":{"description":"Reference to the associated Cluster","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"type":"string","description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"accountCorrelationConfig":{"description":"Reference to an Account Correlation Config object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG"],"example":"ACCOUNT_CORRELATION_CONFIG"},"id":{"type":"string","description":"ID of the account correlation config","example":"2c9180855d191c59015d28583727245a"},"name":{"type":"string","description":"Human-readable display name of the account correlation config","example":"Directory [source-62867] Account Correlation"}}},"accountCorrelationRule":{"description":"Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"managerCorrelationMapping":{"description":"Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity","type":"object","properties":{"accountAttribute":{"type":"string","description":"Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.","example":"manager"},"identityAttribute":{"type":"string","description":"Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.","example":"manager"}}},"managerCorrelationRule":{"description":"Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"beforeProvisioningRule":{"description":"Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"schemas":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"ID of the schema","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the schema","example":"MySchema"}}},"description":"List of references to Schema objects","example":[{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232a","name":"account"},{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232b","name":"group"}]},"passwordPolicies":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["PASSWORD_POLICY"],"example":"PASSWORD_POLICY"},"id":{"type":"string","description":"ID of the policy","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the policy","example":"My Password Policy"}}},"description":"List of references to the associated PasswordPolicy objects.","example":[{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb053980","name":"Corporate Password Policy"},{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb057777","name":"Vendor Password Policy"}]},"features":{"type":"array","description":"Optional features that can be supported by a source.","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING."},"example":["SYNC_PROVISIONING","MANAGER_LOOKUP","SEARCH","PROVISIONING","AUTHENTICATE","GROUP_PROVISIONING","PASSWORD"]},"type":{"type":"string","description":"Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ","example":"OpenLDAP - Direct"},"connector":{"type":"string","description":"Connector script name.","example":"active-directory"},"connectorClass":{"type":"string","description":"The fully qualified name of the Java class that implements the connector interface.","example":"sailpoint.connector.LDAPConnector"},"connectorAttributes":{"type":"object","description":"Connector specific configuration; will differ from type to type.","example":{"healthCheckTimeout":30,"authSearchAttributes":["cn","uid","mail"]}},"deleteThreshold":{"type":"integer","format":"int32","description":"Number from 0 to 100 that specifies when to skip the delete phase.","example":10},"authoritative":{"type":"boolean","description":"When true indicates the source is referenced by an IdentityProfile.","example":false},"managementWorkgroup":{"description":"Reference to Management Workgroup for this Source","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["GOVERNANCE_GROUP"],"example":"GOVERNANCE_GROUP"},"id":{"type":"string","description":"ID of the management workgroup","example":"2c91808568c529c60168cca6f90c2222"},"name":{"type":"string","description":"Human-readable display name of the management workgroup","example":"My Management Workgroup"}}},"healthy":{"type":"boolean","description":"When true indicates a healthy source","example":true},"status":{"type":"string","description":"A status identifier, giving specific information on why a source is healthy or not","example":"SOURCE_STATE_HEALTHY"},"since":{"type":"string","description":"Timestamp showing when a source health check was last performed","example":"2021-09-28T15:48:29.3801666300Z"},"connectorId":{"type":"string","description":"The id of connector","example":"active-directory"},"connectorName":{"type":"string","description":"The name of the connector that was chosen on source creation","example":"Active Directory"},"connectionType":{"type":"string","description":"The type of connection (direct or file)","example":"file"},"connectorImplementstionId":{"type":"string","description":"The connector implementstion id","example":"delimited-file"}},"required":["name","owner","connector"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sources/{sourceId}/upload-connector-file","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Upload connector file to source","description":{"content":"This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":sourceId","upload-connector-file"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[]},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Upload connector file to source' (import-source-connector-file)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Upload connector file to source + + + +This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events. +A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
Request Body required
+ +Uploaded the file successfully and sent all post-upload events + +
Schema
    owner object
    + +Reference to an owning Identity Object + +
    cluster object
    + +Reference to the associated Cluster + +
    accountCorrelationConfig object
    + +Reference to an Account Correlation Config object + +
    accountCorrelationRule object
    + +Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used. + +
    managerCorrelationMapping object
    + +Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + +
    managerCorrelationRule object
    + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
    beforeProvisioningRule object
    + +Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + +
    schemas object[]
    + +List of references to Schema objects + +
    passwordPolicies object[]
    + +List of references to the associated PasswordPolicy objects. + +
    managementWorkgroup object
    + +Reference to Management Workgroup for this Source + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/import-source-entitlements-schema.api.mdx b/products/idn/api/beta/import-source-entitlements-schema.api.mdx new file mode 100644 index 000000000..280f17fde --- /dev/null +++ b/products/idn/api/beta/import-source-entitlements-schema.api.mdx @@ -0,0 +1,83 @@ +--- +id: import-source-entitlements-schema +sidebar_label: Uploads source entitlements schema template +hide_title: true +hide_table_of_contents: true +api: {"tags":["Sources"],"description":"This API uploads a source schema template file to configure a source's entitlement attributes.","operationId":"importSourceEntitlementsSchema","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"The Source id","example":"8c190e6787aa4ed9a90bd9d5344523fb"},{"in":"query","name":"schemaName","schema":{"type":"string"},"description":"Name of entitlement schema","example":"?schemaName=group"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Successfully uploaded the file","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Schema.","example":"2c9180835d191a86015d28455b4a2329"},"name":{"type":"string","description":"The name of the Schema.","example":"account"},"nativeObjectType":{"type":"string","description":"The name of the object type on the native system that the schema represents.","example":"User"},"identityAttribute":{"type":"string","description":"The name of the attribute used to calculate the unique identifier for an object in the schema.","example":"sAMAccountName"},"displayAttribute":{"type":"string","description":"The name of the attribute used to calculate the display value for an object in the schema.","example":"distinguishedName"},"hierarchyAttribute":{"type":"string","description":"The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.","example":"memberOf"},"includePermissions":{"type":"boolean","description":"Flag indicating whether or not the include permissions with the object data when aggregating the schema.","example":false},"features":{"type":"array","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING."},"description":"The features that the schema supports.","example":["PROVISIONING","NO_PERMISSIONS_PROVISIONING","GROUPS_HAVE_MEMBERS"]},"configuration":{"type":"object","description":"Holds any extra configuration data that the schema may require.","example":{"groupMemberAttribute":"member"}},"attributes":{"type":"array","description":"The attribute definitions which form the schema.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"sAMAccountName"},"type":{"type":"string","enum":["STRING","LONG","INT","BOOLEAN"],"description":"The underlying type of the value which an AttributeDefinition represents.","example":"STRING"},"schema":{"description":"A reference to the schema on the source to the attribute values map to.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"The object ID this reference applies to.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The human-readable display name of the object.","example":"group"}}},"description":{"type":"string","description":"A human-readable description of the attribute.","example":"The sAMAccountName attribute"},"isMulti":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","example":false},"isEntitlement":{"type":"boolean","description":"Flag indicating whether or not the attribute is an entitlement.","example":false},"isGroup":{"type":"boolean","description":"Flag indicating whether or not the attribute represents a group.\nThis can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute..\n","example":false}}},"example":[{"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":{"type":"string","description":"The date the Schema was created.","format":"date-time","example":"2019-12-24T22:32:58.104Z"},"modified":{"type":"string","description":"The date the Schema was last modified.","format":"date-time","example":"2019-12-31T20:22:28.104Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:source-schema:manage"]}],"method":"post","path":"/sources/{id}/schemas/entitlements","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Uploads source entitlements schema template","description":{"content":"This API uploads a source schema template file to configure a source's entitlement attributes.","type":"text/plain"},"url":{"path":["sources",":id","schemas","entitlements"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Name of entitlement schema","type":"text/plain"},"key":"schemaName","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[]},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Uploads source entitlements schema template' (import-source-entitlements-schema)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Uploads source entitlements schema template + + + +This API uploads a source schema template file to configure a source's entitlement attributes. + +
Path Parameters
Query Parameters
Request Body required
+ +Successfully uploaded the file + +
Schema
    attributes object[]
    + +The attribute definitions which form the schema. + +
    schema object
    + +A reference to the schema on the source to the attribute values map to. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/import-sp-config.api.mdx b/products/idn/api/beta/import-sp-config.api.mdx new file mode 100644 index 000000000..a0bbea518 --- /dev/null +++ b/products/idn/api/beta/import-sp-config.api.mdx @@ -0,0 +1,164 @@ +--- +id: import-sp-config +sidebar_label: Initiates configuration objects import job +hide_title: true +hide_table_of_contents: true +api: {"operationId":"importSpConfig","tags":["SP-Config"],"description":"This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the /sp-config/export/{exportJobId}/download endpoint.\nYou cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. \nFor more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).\nThe request will need the following security scope:\n- sp:config:manage","parameters":[{"in":"query","name":"preview","schema":{"type":"boolean","default":false},"required":false,"description":"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.","example":"true"}],"requestBody":{"description":"The form-data \"name\" attribute for the file content must be \"data\".\n\n__Example__\n\n data: \"config_export_0340b957-5caa-44f6-ada2-d3c4c5bd0b19.json\",\n options: {\n \"excludeTypes\": [],\n \"includeTypes\": [\"TRIGGER_SUBSCRIPTION\"],\n \"objectOptions\": {\n \"TRIGGER_SUBSCRIPTION\": {\n \"includedIds\": [ \"193446a1-c431-4326-8ba7-d6eebf922948\"],\n \"includedNames\":[]\n }\n },\n \"defaultReferences\": [\n {\n \"type\": \"TRIGGER_SUBSCRIPTION\",\n \"id\": \"be9e116d-08e1-49fc-ab7f-fa585e96c9e4\",\n \"name\": \"Test Trigger\"\n }\n ],\n \"excludeBackup\": false\n }\n\n__Sample Import File__\n\n {\n \t\"version\": 1,\n \t\"timestamp\": \"2021-05-10T15:19:23.425041-05:00\",\n \t\"tenant\": \"sampleTenant\",\n \t\"options\": {\n \t\t\"excludeTypes\": [],\n \t\t\"includeTypes\": [\"TRIGGER_SUBSCRIPTION\"],\n \t\t\"objectOptions\": null\n \t},\n \t\"objects\": [{\n \t\t\t\"version\": 1,\n \t\t\t\"self\": {\n \t\t\t\t\"type\": \"TRIGGER_SUBSCRIPTION\",\n \t\t\t\t\"name\": \"test trigger\",\n \t\t\t\t\"id\": \"193446a1-c431-4326-8ba7-d6eebf922948\"\n \t\t\t},\n \t\t\t\"object\": {\n \t\t\t\t\"type\": \"HTTP\",\n \t\t\t\t\"enabled\": true,\n \t\t\t\t\"httpConfig\": {\n \t\t\t\t\t\"url\": \"https://localhost\",\n \t\t\t\t\t\"httpAuthenticationType\": \"NO_AUTH\",\n \t\t\t\t\t\"basicAuthConfig\": null,\n \t\t\t\t\t\"bearerTokenAuthConfig\": null,\n \t\t\t\t\t\"httpDispatchMode\": \"SYNC\"\n \t\t\t\t},\n \t\t\t\t\"triggerName\": \"Access Request Submitted\",\n \t\t\t\t\"responseDeadline\": \"PT1H\",\n \t\t\t\t\"name\": \"test trigger\",\n \t\t\t\t\"triggerId\": \"idn:access-request-pre-approval\"\n \t\t\t}\n \t\t}\n \t]\n }\n","required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"data":{"type":"string","format":"binary","description":"JSON file containing the objects to be imported."},"options":{"type":"object","properties":{"excludeTypes":{"description":"Object type names to be excluded from an sp-config export command.","type":"array","items":{"type":"string","enum":["IDENTITY_PROFILE","RULE","SOURCE","TRANSFORM","TRIGGER_SUBSCRIPTION"],"example":"SOURCE"}},"includeTypes":{"description":"Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes.","type":"array","items":{"type":"string","enum":["IDENTITY_PROFILE","RULE","SOURCE","TRANSFORM","TRIGGER_SUBSCRIPTION"],"example":"TRIGGER_SUBSCRIPTION"}},"objectOptions":{"description":"Additional options targeting specific objects related to each item in the includeTypes field","type":"object","additionalProperties":{"type":"object","properties":{"includedIds":{"description":"Object ids to be included in an import or export.","type":"array","items":{"type":"string","example":"be9e116d-08e1-49fc-ab7f-fa585e96c9e4"}},"includedNames":{"description":"Object names to be included in an import or export.","type":"array","items":{"type":"string","example":"Test Object"}}}},"example":{"TRIGGER_SUBSCRIPTION":{"includedIds":["be9e116d-08e1-49fc-ab7f-fa585e96c9e4"],"includedNames":["Test 2"]}}},"defaultReferences":{"description":"List of BaseRefenceDtos that can be used to resolve references on import.","type":"array","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}},"excludeBackup":{"description":"By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. If excludeBackup is true, the backup will not be performed.","type":"boolean","default":false,"example":"false"}}}},"required":["data"]},"example":{"data":"config_export_0340b957-5caa-44f6-ada2-d3c4c5bd0b19.json","options":{"excludeTypes":[],"includeTypes":["TRIGGER_SUBSCRIPTION"],"objectOptions":{"TRIGGER_SUBSCRIPTION":{"includedIds":["be9e116d-08e1-49fc-ab7f-fa585e96c9e4"],"includedNames":["Lori Test 2"]}},"defaultReferences":[{"type":"TRIGGER_SUBSCRIPTION","id":"be9e116d-08e1-49fc-ab7f-fa585e96c9e4","name":"Test Trigger"}],"excludeBackup":false}}}}},"responses":{"202":{"description":"Import job accepted and queued for processing.","content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"type":"string","description":"Unique id assigned to this job.","example":"3469b87d-48ca-439a-868f-2160001da8c1"},"status":{"type":"string","description":"Status of the job.","enum":["NOT_STARTED","IN_PROGRESS","COMPLETE","CANCELLED","FAILED"],"example":"COMPLETE"},"type":{"type":"string","description":"Type of the job, either export or import.","enum":["EXPORT","IMPORT"],"example":"IMPORT"},"message":{"type":"string","description":"This message contains additional information about the overall status of the job.","example":"Download import results for details."},"description":{"type":"string","description":"Optional user defined description/name for export job.","example":"ETS configuration objects from Acme-Solar sandbox"},"expiration":{"type":"string","format":"date-time","description":"The time until which the artifacts will be available for download.","example":"2021-05-11T22:23:16Z"},"created":{"type":"string","format":"date-time","description":"The time the job was started.","example":"2021-05-11T22:23:16Z"},"modified":{"type":"string","format":"date-time","description":"The time of the last update to the job.","example":"2021-05-11T22:23:16Z"},"completed":{"type":"string","format":"date-time","description":"The time the job was completed.","example":"2021-05-11T22:23:16Z"}},"required":["jobId","status","type","message","description","expiration","created","modified","completed"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.\n","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sp-config/import","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Initiates configuration objects import job","description":{"content":"This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the /sp-config/export/{exportJobId}/download endpoint.\nYou cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. \nFor more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).\nThe request will need the following security scope:\n- sp:config:manage","type":"text/plain"},"url":{"path":["sp-config","import"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"preview","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Initiates configuration objects import job' (import-sp-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Initiates configuration objects import job + + + +This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting "excludeBackup" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the "exportJobId". This can be downloaded using the /sp-config/export/{exportJobId}/download endpoint. +You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. +For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). +The request will need the following security scope: +- sp:config:manage + +
Query Parameters
Request Body required
+ +The form-data "name" attribute for the file content must be "data". + +__Example__ + + data: "config_export_0340b957-5caa-44f6-ada2-d3c4c5bd0b19.json", + options: { + "excludeTypes": [], + "includeTypes": ["TRIGGER_SUBSCRIPTION"], + "objectOptions": { + "TRIGGER_SUBSCRIPTION": { + "includedIds": [ "193446a1-c431-4326-8ba7-d6eebf922948"], + "includedNames":[] + } + }, + "defaultReferences": [ + { + "type": "TRIGGER_SUBSCRIPTION", + "id": "be9e116d-08e1-49fc-ab7f-fa585e96c9e4", + "name": "Test Trigger" + } + ], + "excludeBackup": false + } + +__Sample Import File__ + + { + "version": 1, + "timestamp": "2021-05-10T15:19:23.425041-05:00", + "tenant": "sampleTenant", + "options": { + "excludeTypes": [], + "includeTypes": ["TRIGGER_SUBSCRIPTION"], + "objectOptions": null + }, + "objects": [{ + "version": 1, + "self": { + "type": "TRIGGER_SUBSCRIPTION", + "name": "test trigger", + "id": "193446a1-c431-4326-8ba7-d6eebf922948" + }, + "object": { + "type": "HTTP", + "enabled": true, + "httpConfig": { + "url": "https://localhost", + "httpAuthenticationType": "NO_AUTH", + "basicAuthConfig": null, + "bearerTokenAuthConfig": null, + "httpDispatchMode": "SYNC" + }, + "triggerName": "Access Request Submitted", + "responseDeadline": "PT1H", + "name": "test trigger", + "triggerId": "idn:access-request-pre-approval" + } + } + ] + } + + +
    options object
    objectOptions object
    + +Additional options targeting specific objects related to each item in the includeTypes field + +
  • property name* object
    • defaultReferences object[]
    + +List of BaseRefenceDtos that can be used to resolve references on import. + +
+ +Import job accepted and queued for processing. + +
Schema
+ +Client Error - Returned if the request body is invalid. + + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/lifecycle-states.tag.mdx b/products/idn/api/beta/lifecycle-states.tag.mdx new file mode 100644 index 000000000..51bf4a31a --- /dev/null +++ b/products/idn/api/beta/lifecycle-states.tag.mdx @@ -0,0 +1,56 @@ +--- +id: lifecycle-states +title: "Lifecycle States" +description: "Lifecycle States" +custom_edit_url: null +--- + + + +Use this API to implement and customize lifecycle state functionality. +With this functionality in place, administrators can view and configure custom lifecycle states for use across their organizations, which is key to controlling which users have access, when they have access, and the access they have. + +A lifecycle state describes a user's status in a company. For example, two lifecycle states come by default with IdentityNow: 'Active' and 'Inactive.' +When an active employee takes an extended leave of absence from a company, his or her lifecycle state may change to 'Inactive,' for security purposes. +The inactive employee would lose access to all the applications, sources, and sensitive data during the leave of absence, but when the employee returns and becomes active again, all that access would be restored. +This saves administrators the time that would otherwise be spent provisioning the employee's access to each individual tool, reviewing the employee's certification history, etc. + +Administrators must define the criteria for being in each lifecycle state, and they must define how IdentityNow manages users' access to apps and sources for each lifecycle state. + +In IdentityNow, administrators can manage lifecycle states by going to Admin > Identities > Identity Profile, selecting the identity profile whose lifecycle states they want to manage, selecting the 'Provisioning' tab, and using the left panel to select the lifecycle state they want to modify. + +In the 'Provisioning' tab, administrators can make the following access changes to an identity profile's lifecycle state: + +- Enable/disable the lifecycle state for the identity profile. + +- Enable/disable source accounts for the identity profile's lifecycle state. + +- Add existing access profiles to grant to the identity profiles in that lifecycle state. + +- Create a new access profile to grant to the identity profile in that lifecycle state. + +Access profiles granted in a previous lifecycle state are automatically revoked when the identity moves to a new lifecycle state. +To maintain access across multiple lifecycle states, administrators must grant the access profiles in each lifecycle state. +For example, if an administrator wants users with the 'HR Employee' identity profile to maintain their building access in both the 'Active' and 'Leave of Absence' lifecycle states, the administrator must grant the access profile for that building access to both lifecycle states. + +During scheduled refreshes, IdentityNow evaluates lifecycle states to determine whether their assigned identities have the access defined in the lifecycle states' access profiles. +If the identities are missing access, IdentityNow provisions that access. + +Administrators can also use the 'Provisioning' tab to configure email notifications for IdentityNow to send whenever an identity with that identity profile has a lifecycle state change. +Refer to [Configuring Lifecycle State Notifications](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#configuring-lifecycle-state-notifications) for more information on how to do so. + +An identity's lifecycle state can have four different statuses: the lifecycle state's status can be 'Active,' it can be 'Not Set,' it can be 'Not Valid,' or it 'Does Not Match Technical Name Case.' +Refer to [Moving Identities into Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#moving-identities-into-lifecycle-states) for more information about these different lifecycle state statuses. + +Refer to [Setting Up Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html) for more information about lifecycle states. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/list-access-profiles.api.mdx b/products/idn/api/beta/list-access-profiles.api.mdx new file mode 100644 index 000000000..d4a547717 --- /dev/null +++ b/products/idn/api/beta/list-access-profiles.api.mdx @@ -0,0 +1,113 @@ +--- +id: list-access-profiles +sidebar_label: List Access Profiles +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listAccessProfiles","tags":["Access Profiles"],"description":"This API returns a list of Access Profiles.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","parameters":[{"in":"query","name":"for-subadmin","schema":{"type":"string"},"description":"If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID.\n\nA 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.","example":"8c190e6787aa4ed9a90bd9d5344523fb","required":false},{"in":"query","name":"limit","description":"Note that for this API the maximum value for limit is 50.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":50,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":50,"default":50}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**requestable**: *eq*\n\n**source.id**: *eq, in*","example":"name eq \"SailPoint Support\"","required":false},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name, created, modified**","example":"name,-modified","required":false},{"in":"query","name":"for-segment-ids","schema":{"type":"string","format":"comma-separated"},"description":"If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.","example":"0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d","required":false},{"in":"query","name":"include-unsegmented","schema":{"type":"boolean","default":true},"description":"Whether or not the response list should contain unsegmented Access Profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.","example":false,"required":false}],"responses":{"200":{"description":"List of Access Profiles","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Access Profile","example":"2c91808a7190d06e01719938fcd20792","readOnly":true},"name":{"type":"string","description":"Name of the Access Profile","example":"Employee-database-read-write"},"description":{"type":"string","nullable":true,"description":"Information about the Access Profile","example":"Collection of entitlements to read/write the employee database"},"created":{"type":"string","description":"Date the Access Profile was created","format":"date-time","example":"2021-03-01T22:32:58.104Z","readOnly":true},"modified":{"type":"string","description":"Date the Access Profile was last modified.","format":"date-time","example":"2021-03-02T20:22:28.104Z","readOnly":true},"enabled":{"type":"boolean","description":"Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement.","example":true},"owner":{"description":"Owner of the Access Profile","type":"object","nullable":true,"properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"source":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Source with with which the Access Profile is associated","example":"2c91809773dee3610173fdb0b6061ef4"},"type":{"type":"string","enum":["SOURCE"],"description":"The type of the Source, will always be SOURCE","example":"SOURCE"},"name":{"type":"string","description":"The display name of the associated Source","example":"ODS-AD-SOURCE"}}},"entitlements":{"type":"array","description":"A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement.","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Entitlement","example":"2c91809773dee32014e13e122092014e"},"type":{"type":"string","enum":["ENTITLEMENT"],"description":"The type of the Entitlement, will always be ENTITLEMENT","example":"ENTITLEMENT"},"name":{"type":"string","description":"The display name of the Entitlement","example":"CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"}}}},"requestable":{"type":"boolean","description":"Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error.","example":true},"accessRequestConfig":{"nullable":true,"description":"Access request configuration for this object","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":true},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":true},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"revocationRequestConfig":{"nullable":true,"description":"Revocation request configuration for this object.","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":false,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":false,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the revocation request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"segments":{"type":"array","nullable":true,"items":{"type":"string"},"description":"List of IDs of segments, if any, to which this Access Profile is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]},"provisioningCriteria":{"description":"When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression is evaluated against those Accounts to choose one to provision with the Access Profile.","nullable":true,"example":{"operation":"OR","children":[{"operation":"AND","children":[{"attribute":"dn","operation":"CONTAINS","value":"useast"},{"attribute":"manager","operation":"CONTAINS","value":"Scott.Clark"}]},{"operation":"AND","children":[{"attribute":"dn","operation":"EQUALS","value":"Gibson"},{"attribute":"telephoneNumber","operation":"CONTAINS","value":"512"}]}]},"type":"object","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","nullable":true,"description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines matching criteria for an Account to be provisioned with a specific Access Profile","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","nullable":true,"description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines matching criteria for an Account to be provisioned with a specific Access Profile","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.","example":null}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.","example":null}}}},"required":["owner","name","source"]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:access-profile:read","idn:access-profile:manage"]}],"method":"get","path":"/access-profiles","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Access Profiles","description":{"content":"This API returns a list of Access Profiles.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["access-profiles"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID.\n\nA 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.","type":"text/plain"},"key":"for-subadmin","value":""},{"disabled":false,"description":{"content":"Note that for this API the maximum value for limit is 50.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**requestable**: *eq*\n\n**source.id**: *eq, in*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name, created, modified**","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.","type":"text/plain"},"key":"for-segment-ids","value":""},{"disabled":false,"description":{"content":"Whether or not the response list should contain unsegmented Access Profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.","type":"text/plain"},"key":"include-unsegmented","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Access Profiles' (list-access-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Access Profiles + + + +This API returns a list of Access Profiles. + +A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +
Query Parameters
+ +List of Access Profiles + +
Schema array
    owner object
    + +Owner of the Access Profile + +
    source object
    entitlements object[]
    + +A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. + +
    accessRequestConfig object
    + +Access request configuration for this object + +
    approvalSchemes object[]
    + +List describing the steps in approving the request + +
    revocationRequestConfig object
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]
    + +List describing the steps in approving the revocation request + +
    provisioningCriteria object
    + +When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression is evaluated against those Accounts to choose one to provision with the Access Profile. + +
    children object[]
    + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + +
    children object[]
    + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-access-request-status.api.mdx b/products/idn/api/beta/list-access-request-status.api.mdx new file mode 100644 index 000000000..c68c81c05 --- /dev/null +++ b/products/idn/api/beta/list-access-request-status.api.mdx @@ -0,0 +1,172 @@ +--- +id: list-access-request-status +sidebar_label: Access Request Status +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listAccessRequestStatus","tags":["Access Requests"],"description":"The Access Request Status API returns a list of access request statuses based on the specified query parameters.\nAny token with any authority can request their own status. A token with ORG_ADMIN authority is required to call this API to get a list of statuses for other users.","parameters":[{"in":"query","name":"requested-for","schema":{"type":"string"},"example":"2c9180877b2b6ea4017b2c545f971429","description":"Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","required":false},{"in":"query","name":"requested-by","schema":{"type":"string"},"example":"2c9180877b2b6ea4017b2c545f971429","description":"Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","required":false},{"in":"query","name":"regarding-identity","schema":{"type":"string"},"example":"2c9180877b2b6ea4017b2c545f971429","description":"Filter the results by the specified identity which is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*.","required":false},{"in":"query","name":"count","description":"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.","required":false,"schema":{"type":"boolean","default":false},"example":false},{"in":"query","name":"limit","description":"Max number of results to return.","required":false,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250},"example":100},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.","required":false,"schema":{"type":"integer","format":"int32","minimum":0},"example":10},{"in":"query","name":"filters","schema":{"type":"string"},"example":"accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**accountActivityItemId**: *eq, in*","required":false},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created, modified, accountActivityItemId**","example":"created","required":false}],"responses":{"200":{"description":"List of requested item status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Human-readable display name of the item being requested.","example":"AccessProfile1"},"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"Type of requested object.","example":"ACCESS_PROFILE"},"cancelledRequestDetails":{"nullable":true,"type":"object","properties":{"comment":{"type":"string","description":"Comment made by the owner when cancelling the associated request.","example":"Nisl quis ipsum quam quisque condimentum nunc ut dolor nunc."},"owner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"modified":{"type":"string","format":"date-time","description":"Date comment was added by the owner when cancelling the associated request","example":"2019-12-20T09:17:12.192Z"}},"description":"Provides additional details for a request that has been cancelled."},"errorMessages":{"type":"array","nullable":true,"items":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"description":"List of list of localized error messages, if any, encountered during the approval/provisioning process."},"state":{"type":"string","enum":["EXECUTING","REQUEST_COMPLETED","CANCELLED","TERMINATED","PROVISIONING_VERIFICATION_PENDING","REJECTED","PROVISIONING_FAILED","NOT_ALL_ITEMS_PROVISIONED","ERROR"],"description":"Indicates the state of an access request:\n* EXECUTING: The request is executing, which indicates the system is doing some processing.\n* REQUEST_COMPLETED: Indicates the request has been completed.\n* CANCELLED: The request was cancelled with no user input.\n* TERMINATED: The request has been terminated before it was able to complete.\n* PROVISIONING_VERIFICATION_PENDING: The request has finished any approval steps and provisioning is waiting to be verified.\n* REJECTED: The request was rejected.\n* PROVISIONING_FAILED: The request has failed to complete.\n* NOT_ALL_ITEMS_PROVISIONED: One or more of the requested items failed to complete, but there were one or more successes.\n* ERROR: An error occurred during request processing.","example":"EXECUTING"},"approvalDetails":{"type":"array","items":{"type":"object","properties":{"forwarded":{"type":"boolean","description":"True if the request for this item was forwarded from one owner to another.","example":false},"originalOwner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Base identity/workgroup reference object representing the original owner, if forwarded."},"currentOwner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Base reference of approver that will make decision."},"reviewedBy":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The identity who has reviewed the approval."},"modified":{"type":"string","format":"date-time","description":"Time at which item was modified.","example":"2019-08-23T18:52:57.398Z"},"status":{"type":"string","enum":["PENDING","APPROVED","REJECTED","EXPIRED","CANCELLED","ARCHIVED"],"description":"Indicates the state of the request processing for this item:\n* PENDING: The request for this item is awaiting processing.\n* APPROVED: The request for this item has been approved.\n* REJECTED: The request for this item was rejected.\n* EXPIRED: The request for this item expired with no action taken.\n* CANCELLED: The request for this item was cancelled with no user action.\n* ARCHIVED: The request for this item has been archived after completion.","example":"PENDING"},"scheme":{"type":"string","enum":["APP_OWNER","SOURCE_OWNER","MANAGER","ROLE_OWNER","ACCESS_PROFILE_OWNER","ENTITLEMENT_OWNER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step.","example":"MANAGER"},"errorMessages":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}},"description":"If the request failed, includes any error messages that were generated."},"comment":{"type":"string","description":"Comment, if any, provided by the approver.","example":"I approve this request"},"removeDate":{"type":"string","description":"The date the role or access profile is no longer assigned to the specified identity.","format":"date-time","example":"2020-07-11T00:00:00Z"}}},"description":"Approval details for each item."},"manualWorkItemDetails":{"type":"array","nullable":true,"items":{"type":"object","properties":{"forwarded":{"type":"boolean","description":"True if the request for this item was forwarded from one owner to another.","example":true},"originalOwner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Base identity/workgroup reference object representing the original owner, if forwarded."},"currentOwner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Base reference of approver that will make decision."},"modified":{"type":"string","format":"date-time","description":"Time at which item was modified.","example":"2019-08-23T18:52:57.398Z"},"status":{"type":"string","enum":["PENDING","APPROVED","REJECTED","EXPIRED","CANCELLED","ARCHIVED"],"description":"Indicates the state of the request processing for this item:\n* PENDING: The request for this item is awaiting processing.\n* APPROVED: The request for this item has been approved.\n* REJECTED: The request for this item was rejected.\n* EXPIRED: The request for this item expired with no action taken.\n* CANCELLED: The request for this item was cancelled with no user action.\n* ARCHIVED: The request for this item has been archived after completion.","example":"PENDING"},"forwardHistory":{"type":"array","items":{"type":"object","properties":{"oldApproverName":{"type":"string","description":"Display name of approver from whom the approval was forwarded.","example":"Frank Mir"},"newApproverName":{"type":"string","description":"Display name of approver to whom the approval was forwarded.","example":"Al Volta"},"comment":{"type":"string","nullable":true,"description":"Comment made while forwarding.","example":"Forwarding from Frank to Al"},"modified":{"type":"string","format":"date-time","description":"Time at which approval was forwarded.","example":"2019-08-23T18:52:57.398Z"},"forwarderName":{"type":"string","nullable":true,"description":"Display name of forwarder who forwarded the approval.","example":"William Wilson"},"reassignmentType":{"description":"The approval reassignment type. \n* MANUAL_REASSIGNMENT: An approval with this reassignment type has been specifically reassigned by the approval task's owner, from their queue to someone else's. \n* AUTOMATIC_REASSIGNMENT: An approval with this reassignment type has been automatically reassigned from another approver's queue, according to that approver's reassignment configuration. The approver's reassignment configuration may be set up to automatically reassign approval tasks for a defined (or possibly open-ended) period of time.\n* AUTO_ESCALATION: An approval with this reassignment type has been automatically reassigned from another approver's queue, according to the request's escalation configuration. For more information about escalation configuration, refer to [Setting Global Reminders and Escalation Policies](https://documentation.sailpoint.com/saas/help/requests/config_emails.html).\n* SELF_REVIEW_DELEGATION: An approval with this reassignment type has been automatically reassigned by the system to prevent self-review. This helps prevent situations like a requester being tasked with approving their own request. For more information about preventing self-review, refer to [Self-review Prevention](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html#self-review-prevention) and [Preventing Self-approval](https://documentation.sailpoint.com/saas/help/requests/config_ap_roles.html#preventing-self-approval).","example":"AUTOMATIC_REASSIGNMENT","type":"string","enum":["MANUAL_REASSIGNMENT","AUTOMATIC_REASSIGNMENT","AUTO_ESCALATION","SELF_REVIEW_DELEGATION"]}}},"description":"The history of approval forward action."}}},"description":"Manual work items created for provisioning the item."},"accountActivityItemId":{"type":"string","description":"Id of associated account activity item.","example":"2c9180926cbfbddd016cbfc7c3b10010"},"requestType":{"type":"string","enum":["GRANT_ACCESS","REVOKE_ACCESS"],"description":"Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field.","example":"GRANT_ACCESS"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"},"requester":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The identity that requested the item."},"requestedFor":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The identity for whom the Access Request Status is requested for."},"requesterComment":{"nullable":true,"description":"The requester's comment.","type":"object","properties":{"comment":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat"},"author":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the author","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"}}},"created":{"type":"string","format":"date-time","description":"Date and time comment was created","example":"2017-07-11T18:45:37.098Z"}}},"sodViolationContext":{"nullable":true,"description":"The details of the SOD violations for the associated approval.","type":"object","properties":{"state":{"type":"string","enum":["SUCCESS","ERROR"],"description":"The status of SOD violation check","example":"SUCCESS"},"uuid":{"description":"The id of the Violation check event","type":"string","example":"f73d16e9-a038-46c5-b217-1246e15fdbdd"},"violationCheckResult":{"description":"The inner object representing the completed SOD Violation check","type":"object","properties":{"message":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}},"description":"If the request failed, includes any error message that was generated.","example":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An error has occurred during the SOD violation check"}]},"clientMetadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check.","example":{"requestedAppName":"test-app","requestedAppId":"2c91808f7892918f0178b78da4a305a1"}},"violationContexts":{"type":"array","items":{"description":"The contextual information of the violated criteria","type":"object","properties":{"policy":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Reference to the Policy that is being violated."},"conflictingAccessCriteria":{"type":"object","description":"The object which contains the left and right hand side of the entitlements that got violated according to the policy.","properties":{"leftCriteria":{"type":"object","properties":{"criteriaList":{"type":"array","items":{"description":"Details of the Entitlement criteria","type":"object","properties":{"existing":{"type":"boolean","example":true,"description":"If the entitlement already belonged to the user or not."},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Entitlement ID","example":"2c918085771e9d3301773b3cb66f6398"},"name":{"type":"string","description":"Entitlement name","example":"My HR Entitlement"}}}}}},"rightCriteria":{"type":"object","properties":{"criteriaList":{"type":"array","items":{"description":"Details of the Entitlement criteria","type":"object","properties":{"existing":{"type":"boolean","example":true,"description":"If the entitlement already belonged to the user or not."},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Entitlement ID","example":"2c918085771e9d3301773b3cb66f6398"},"name":{"type":"string","description":"Entitlement name","example":"My HR Entitlement"}}}}}}}}}}},"violatedPolicies":{"type":"array","description":"A list of the Policies that were violated","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Reference to the policy that was violated","example":[{"type":"SOD_POLICY","id":"69129440-422d-4a23-aadd-35c828d5bfda","name":"HR Policy"}]}}}}}},"provisioningDetails":{"nullable":true,"type":"object","properties":{"orderedSubPhaseReferences":{"type":"string","description":"Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase.","example":"manualWorkItemDetails"}},"description":"Provides additional details about provisioning for this request."},"preApprovalTriggerDetails":{"nullable":true,"type":"object","properties":{"comment":{"type":"string","description":"Comment left for the pre-approval decision","example":"Access is Approved"},"reviewer":{"type":"string","description":"The reviewer of the pre-approval decision","example":"John Doe"},"decision":{"type":"string","enum":["APPROVED","REJECTED"],"description":"The decision of the pre-approval trigger","example":"APPROVED"}},"description":"Provides additional details about the pre-approval trigger for this request."},"accessRequestPhases":{"type":"array","items":{"type":"object","properties":{"started":{"type":"string","description":"The time that this phase started.","format":"date-time","example":"2020-07-11T00:00:00Z"},"finished":{"type":"string","description":"The time that this phase finished.","format":"date-time","example":"2020-07-12T00:00:00Z"},"name":{"type":"string","description":"The name of this phase.","example":"APPROVAL_PHASE"},"state":{"type":"string","enum":["PENDING","EXECUTING","COMPLETED","CANCELLED"],"description":"The state of this phase.","example":"COMPLETED"},"result":{"type":"string","enum":["SUCCESSFUL","FAILED"],"description":"The state of this phase.","example":"SUCCESSFUL"},"phaseReference":{"type":"string","description":"A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items.","example":"approvalDetails"}},"description":"Provides additional details about this access request phase."},"description":"A list of Phases that the Access Request has gone through in order, to help determine the status of the request."},"description":{"type":"string","description":"Description associated to the requested object.","example":"This is the Engineering role that engineers are granted."},"removeDate":{"type":"string","format":"date-time","nullable":true,"description":"When the role access is scheduled for removal.","example":"2019-10-23T00:00:00.000Z"},"cancelable":{"type":"boolean","description":"True if the request can be canceled.","example":true},"accessRequestId":{"type":"string","format":"string","description":"This is the account activity id.","example":"2b838de9-db9b-abcf-e646-d4f274ad4238"},"clientMetadata":{"nullable":true,"type":"object","additionalProperties":{"type":"string"},"description":"Arbitrary key-value pairs, if any were included in the corresponding access request","example":{"key1":"value1","key2":"value2"}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/access-request-status","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Access Request Status","description":{"content":"The Access Request Status API returns a list of access request statuses based on the specified query parameters.\nAny token with any authority can request their own status. A token with ORG_ADMIN authority is required to call this API to get a list of statuses for other users.","type":"text/plain"},"url":{"path":["access-request-status"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","type":"text/plain"},"key":"requested-for","value":""},{"disabled":false,"description":{"content":"Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","type":"text/plain"},"key":"requested-by","value":""},{"disabled":false,"description":{"content":"Filter the results by the specified identity which is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*.","type":"text/plain"},"key":"regarding-identity","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Max number of results to return.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**accountActivityItemId**: *eq, in*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created, modified, accountActivityItemId**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Access Request Status' (list-access-request-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Access Request Status + + + +The Access Request Status API returns a list of access request statuses based on the specified query parameters. +Any token with any authority can request their own status. A token with ORG_ADMIN authority is required to call this API to get a list of statuses for other users. + +
Query Parameters
+ +List of requested item status. + +
Schema array
    cancelledRequestDetails object
    + +Provides additional details for a request that has been cancelled. + +
    owner object
    approvalDetails object[]
    + +Approval details for each item. + +
    originalOwner object
    + +Base identity/workgroup reference object representing the original owner, if forwarded. + +
    currentOwner object
    + +Base reference of approver that will make decision. + +
    reviewedBy object
    + +The identity who has reviewed the approval. + +
    errorMessages object[]
    + +If the request failed, includes any error messages that were generated. + +
    manualWorkItemDetails object[]
    + +Manual work items created for provisioning the item. + +
    originalOwner object
    + +Base identity/workgroup reference object representing the original owner, if forwarded. + +
    currentOwner object
    + +Base reference of approver that will make decision. + +
    forwardHistory object[]
    + +The history of approval forward action. + +
    requester object
    + +The identity that requested the item. + +
    requestedFor object
    + +The identity for whom the Access Request Status is requested for. + +
    requesterComment object
    + +The requester's comment. + +
    author object
    sodViolationContext object
    + +The details of the SOD violations for the associated approval. + +
    violationCheckResult object
    + +The inner object representing the completed SOD Violation check + +
    message object
    + +If the request failed, includes any error message that was generated. + +
    clientMetadata object
    + +Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. + +
  • property name* string
    • violationContexts object[]
    policy object
    + +Reference to the Policy that is being violated. + +
    conflictingAccessCriteria object
    + +The object which contains the left and right hand side of the entitlements that got violated according to the policy. + +
    leftCriteria object
    criteriaList object[]
    rightCriteria object
    criteriaList object[]
    violatedPolicies object[]
    + +A list of the Policies that were violated + +
    provisioningDetails object
    + +Provides additional details about provisioning for this request. + +
    preApprovalTriggerDetails object
    + +Provides additional details about the pre-approval trigger for this request. + +
    accessRequestPhases object[]
    + +A list of Phases that the Access Request has gone through in order, to help determine the status of the request. + +
    clientMetadata object
    + +Arbitrary key-value pairs, if any were included in the corresponding access request + +
  • property name* string
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-account-activities.api.mdx b/products/idn/api/beta/list-account-activities.api.mdx new file mode 100644 index 000000000..ca615b090 --- /dev/null +++ b/products/idn/api/beta/list-account-activities.api.mdx @@ -0,0 +1,87 @@ +--- +id: list-account-activities +sidebar_label: List Account Activities +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listAccountActivities","tags":["Account Activities"],"description":"This gets a collection of account activities that satisfy the given query parameters.","parameters":[{"in":"query","name":"requested-for","schema":{"type":"string"},"description":"The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","required":false},{"in":"query","name":"requested-by","schema":{"type":"string"},"description":"The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","required":false},{"in":"query","name":"regarding-identity","schema":{"type":"string"},"description":"The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*.","required":false},{"in":"query","name":"type","schema":{"type":"string"},"description":"The type of account activity.","required":false},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**type**: *eq, in*\n\n**created**: *gt, lt, ge, le*\n\n**modified**: *gt, lt, ge, le*"},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **type, created, modified**"}],"responses":{"200":{"description":"List of account activities","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the account activity itself","example":"2c9180835d2e5168015d32f890ca1581"},"name":{"type":"string","example":"2c9180835d2e5168015d32f890ca1581"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z"},"completed":{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z"},"completionStatus":{"nullable":true,"type":"string","description":"The status after completion.","enum":["SUCCESS","FAILURE","INCOMPLETE","PENDING"],"example":"SUCCESS"},"type":{"type":"string","example":"appRequest"},"requesterIdentitySummary":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"ID of this identity summary","example":"ff80818155fe8c080155fe8d925b0316"},"name":{"type":"string","description":"Human-readable display name of identity","example":"SailPoint Services"},"identityId":{"type":"string","description":"ID of the identity that this summary represents","example":"c15b9f5cca5a4e9599eaa0e64fa921bd"},"completed":{"type":"boolean","description":"Indicates if all access items for this summary have been decided on","example":true}}},"targetIdentitySummary":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"ID of this identity summary","example":"ff80818155fe8c080155fe8d925b0316"},"name":{"type":"string","description":"Human-readable display name of identity","example":"SailPoint Services"},"identityId":{"type":"string","description":"ID of the identity that this summary represents","example":"c15b9f5cca5a4e9599eaa0e64fa921bd"},"completed":{"type":"boolean","description":"Indicates if all access items for this summary have been decided on","example":true}}},"errors":{"type":"array","items":{"type":"string"},"example":["sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds."]},"warnings":{"type":"array","items":{"type":"string"},"example":null},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Item id","example":"48c545831b264409a81befcabb0e3c5a"},"name":{"type":"string","description":"Human-readable display name of item","example":"48c545831b264409a81befcabb0e3c5a"},"requested":{"type":"string","format":"date-time","description":"Date and time item was requested","example":"2017-07-11T18:45:37.098Z"},"approvalStatus":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item","nullable":true},"provisioningStatus":{"type":"string","enum":["PENDING","FINISHED","UNVERIFIABLE","COMMITED","FAILED","RETRY"],"description":"Provisioning state of an account activity item","example":"PENDING"},"requesterComment":{"type":"object","nullable":true,"properties":{"commenterId":{"type":"string","description":"Id of the identity making the comment","example":"2c918084660f45d6016617daa9210584"},"commenterName":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"},"body":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat."},"date":{"type":"string","format":"date-time","description":"Date and time comment was made","example":"2017-07-11T18:45:37.098Z"}}},"reviewerIdentitySummary":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"ID of this identity summary","example":"ff80818155fe8c080155fe8d925b0316"},"name":{"type":"string","description":"Human-readable display name of identity","example":"SailPoint Services"},"identityId":{"type":"string","description":"ID of the identity that this summary represents","example":"c15b9f5cca5a4e9599eaa0e64fa921bd"},"completed":{"type":"boolean","description":"Indicates if all access items for this summary have been decided on","example":true}}},"reviewerComment":{"type":"object","nullable":true,"properties":{"commenterId":{"type":"string","description":"Id of the identity making the comment","example":"2c918084660f45d6016617daa9210584"},"commenterName":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"},"body":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat."},"date":{"type":"string","format":"date-time","description":"Date and time comment was made","example":"2017-07-11T18:45:37.098Z"}}},"operation":{"nullable":true,"type":"string","enum":["ADD","CREATE","MODIFY","DELETE","DISABLE","ENABLE","UNLOCK","LOCK","REMOVE"],"description":"Represents an operation in an account activity item","example":"ADD"},"attribute":{"type":"string","description":"Attribute to which account activity applies","nullable":true,"example":"detectedRoles"},"value":{"type":"string","description":"Value of attribute","nullable":true,"example":"Treasury Analyst [AccessProfile-1529010191212]"},"nativeIdentity":{"nullable":true,"type":"string","description":"Native identity in the target system to which the account activity applies","example":"Sandie.Camero"},"sourceId":{"type":"string","description":"Id of Source to which account activity applies","example":"2c91808363ef85290164000587130c0c"},"accountRequestInfo":{"type":"object","nullable":true,"properties":{"requestedObjectId":{"type":"string","description":"Id of requested object","example":"2c91808563ef85690164001c31140c0c"},"requestedObjectName":{"type":"string","description":"Human-readable name of requested object","example":"Treasury Analyst"},"requestedObjectType":{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"Enum represented the currently supported requestable object types. Additional values may be added in the future without notice.","example":"ACCESS_PROFILE"}},"description":"If an account activity item is associated with an access request, captures details of that request."},"clientMetadata":{"nullable":true,"type":"object","additionalProperties":{"type":"string"},"description":"Arbitrary key-value pairs, if any were included in the corresponding access request item","example":{"customKey1":"custom value 1","customKey2":"custom value 2"}},"removeDate":{"nullable":true,"type":"string","description":"The date the role or access profile is no longer assigned to the specified identity.","format":"date-time","example":"2020-07-11T00:00:00Z"}}}},"executionStatus":{"type":"string","description":"The current state of execution.","enum":["EXECUTING","VERIFYING","TERMINATED","COMPLETED"],"example":"COMPLETED"},"clientMetadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Arbitrary key-value pairs, if any were included in the corresponding access request"},"cancelable":{"type":"boolean","description":"Whether the account activity can be canceled before completion"},"cancelComment":{"type":"object","nullable":true,"properties":{"commenterId":{"type":"string","description":"Id of the identity making the comment","example":"2c918084660f45d6016617daa9210584"},"commenterName":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"},"body":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat."},"date":{"type":"string","format":"date-time","description":"Date and time comment was made","example":"2017-07-11T18:45:37.098Z"}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/account-activities","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Account Activities","description":{"content":"This gets a collection of account activities that satisfy the given query parameters.","type":"text/plain"},"url":{"path":["account-activities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","type":"text/plain"},"key":"requested-for","value":""},{"disabled":false,"description":{"content":"The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","type":"text/plain"},"key":"requested-by","value":""},{"disabled":false,"description":{"content":"The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*.","type":"text/plain"},"key":"regarding-identity","value":""},{"disabled":false,"description":{"content":"The type of account activity.","type":"text/plain"},"key":"type","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**type**: *eq, in*\n\n**created**: *gt, lt, ge, le*\n\n**modified**: *gt, lt, ge, le*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **type, created, modified**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Account Activities' (list-account-activities)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Account Activities + + + +This gets a collection of account activities that satisfy the given query parameters. + +
Query Parameters
+ +List of account activities + +
Schema array
    requesterIdentitySummary object
    targetIdentitySummary object
    items object[]
    requesterComment object
    reviewerIdentitySummary object
    reviewerComment object
    accountRequestInfo object
    + +If an account activity item is associated with an access request, captures details of that request. + +
    clientMetadata object
    + +Arbitrary key-value pairs, if any were included in the corresponding access request item + +
  • property name* string
    • clientMetadata object
    + +Arbitrary key-value pairs, if any were included in the corresponding access request + +
  • property name* string
    • cancelComment object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-accounts.api.mdx b/products/idn/api/beta/list-accounts.api.mdx new file mode 100644 index 000000000..872ed7d57 --- /dev/null +++ b/products/idn/api/beta/list-accounts.api.mdx @@ -0,0 +1,84 @@ +--- +id: list-accounts +sidebar_label: Accounts List +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listAccounts","tags":["Accounts"],"description":"This returns a list of accounts. \nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:accounts:read","idn:accounts:manage"]}],"parameters":[{"in":"query","name":"detailLevel","schema":{"type":"string","enum":["SLIM","FULL"]},"description":"Determines whether Slim, or increased level of detail is provided for each account in the returned list. FULL is the default behavior.","example":"FULL"},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"example":"identityId eq \"2c9180858082150f0180893dbaf44201\"","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**identityId**: *eq*\n\n**name**: *eq, in*\n\n**nativeIdentity**: *eq, in*\n\n**sourceId**: *eq, in*\n\n**uncorrelated**: *eq*"},{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"example":"id,name","description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **id**, **name**, **created**, **modified**"}],"responses":{"200":{"description":"List of account objects","content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"type":"object","title":"Slim Account","allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"},"modified":{"description":"Last modification date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}},{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"Unique ID from the owning source","example":"2c9180857893f12901789445619b0366","nullable":true},"nativeIdentity":{"type":"string","description":"The native identifier of the account","example":"brandin.gray"},"description":{"type":"string","description":"The description for the account","example":"Brandin Gray the CEO of Silly Inc.","nullable":true},"disabled":{"type":"boolean","description":"Whether the account is disabled","example":false},"locked":{"type":"boolean","description":"Whether the account is locked","example":false},"manuallyCorrelated":{"type":"boolean","description":"Whether the account was manually correlated","example":false},"hasEntitlements":{"type":"boolean","description":"Whether the account has any entitlements associated with it","example":true},"sourceId":{"type":"string","description":"The ID of the source for which this account belongs","example":"2c9180835d2e5168015d32f890ca1581"},"sourceName":{"type":"string","description":"The name of the source","example":"Large Source"},"identityId":{"type":"string","description":"The ID of the identity for which this account is correlated to if not uncorrelated","example":"4b9163835d2e5168015d32f890ca5936"},"attributes":{"type":"object","description":"A map containing attributes associated with the account","additionalProperties":true,"example":{"firstName":"SailPoint","lastName":"Support","displayName":"SailPoint Support"}}}}]},{"type":"object","title":"Full Account","allOf":[{"type":"object","title":"Slim Account","allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"},"modified":{"description":"Last modification date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}},{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"Unique ID from the owning source","example":"2c9180857893f12901789445619b0366","nullable":true},"nativeIdentity":{"type":"string","description":"The native identifier of the account","example":"brandin.gray"},"description":{"type":"string","description":"The description for the account","example":"Brandin Gray the CEO of Silly Inc.","nullable":true},"disabled":{"type":"boolean","description":"Whether the account is disabled","example":false},"locked":{"type":"boolean","description":"Whether the account is locked","example":false},"manuallyCorrelated":{"type":"boolean","description":"Whether the account was manually correlated","example":false},"hasEntitlements":{"type":"boolean","description":"Whether the account has any entitlements associated with it","example":true},"sourceId":{"type":"string","description":"The ID of the source for which this account belongs","example":"2c9180835d2e5168015d32f890ca1581"},"sourceName":{"type":"string","description":"The name of the source","example":"Large Source"},"identityId":{"type":"string","description":"The ID of the identity for which this account is correlated to if not uncorrelated","example":"4b9163835d2e5168015d32f890ca5936"},"attributes":{"type":"object","description":"A map containing attributes associated with the account","additionalProperties":true,"example":{"firstName":"SailPoint","lastName":"Support","displayName":"SailPoint Support"}}}}]},{"type":"object","properties":{"authoritative":{"type":"boolean","description":"Whether this account belongs to an authoritative source","example":false},"systemAccount":{"type":"boolean","description":"Whether this account is for the IdentityNow source","example":false},"uncorrelated":{"type":"boolean","description":"True if this account is not correlated to an identity","example":false},"features":{"type":"string","description":"A string list containing the owning source's features","example":"ENABLE"}}}]}]}},"examples":{"SlimAccounts":{"description":"List of slim accounts that would result with *detailLevel = SLIM*","value":[{"attributes":null,"created":"2021-09-28T02:15:44.644Z","description":null,"disabled":false,"features":"PROVISIONING, GROUP_PROVISIONING, SYNC_PROVISIONING, AUTHENTICATE","hasEntitlements":true,"id":"2c9180867c184ff6017c2a2fbf031667","identityId":"2c9180867c184ff6017c2a2fbf031666","locked":false,"manuallyCorrelated":false,"modified":"2021-09-28T02:16:12.207Z","name":"Geovanni.0a7cad6df","nativeIdentity":"CN=Geovanni 0a7cad6df,OU=hpun,OU=org-data-service,DC=TestAutomationAD,DC=local","sourceId":"2c91808b7c28b350017c2a2ec5790aa1","uuid":"{e4218fa4-da52-4bb0-aa41-d2dcc08a7ad8}"}]},"FullAccounts":{"description":"List of slim accounts that would result with *detailLevel = FULL* or not specifying it","value":[{"attributes":null,"authoritative":true,"created":"2021-09-28T02:15:44.644Z","description":null,"disabled":false,"features":"PROVISIONING, GROUP_PROVISIONING, SYNC_PROVISIONING, AUTHENTICATE","hasEntitlements":true,"id":"2c9180867c184ff6017c2a2fbf031667","identityId":"2c9180867c184ff6017c2a2fbf031666","locked":false,"manuallyCorrelated":false,"modified":"2021-09-28T02:16:12.207Z","name":"Geovanni.0a7cad6df","nativeIdentity":"CN=Geovanni 0a7cad6df,OU=hpun,OU=org-data-service,DC=TestAutomationAD,DC=local","sourceId":"2c91808b7c28b350017c2a2ec5790aa1","systemAccount":false,"uncorrelated":false,"uuid":"{e4218fa4-da52-4bb0-aa41-d2dcc08a7ad8}"}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/accounts","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Accounts List","description":{"content":"This returns a list of accounts. \nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Determines whether Slim, or increased level of detail is provided for each account in the returned list. FULL is the default behavior.","type":"text/plain"},"key":"detailLevel","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**identityId**: *eq*\n\n**name**: *eq, in*\n\n**nativeIdentity**: *eq, in*\n\n**sourceId**: *eq, in*\n\n**uncorrelated**: *eq*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **id**, **name**, **created**, **modified**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Accounts List' (list-accounts)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Accounts List + + + +This returns a list of accounts. +A token with ORG_ADMIN authority is required to call this API. + +
Query Parameters
+ +List of account objects + +
Schema array
    anyOf
    attributes object
    + +A map containing attributes associated with the account + +
    attributes object
    + +A map containing attributes associated with the account + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-campaign-templates.api.mdx b/products/idn/api/beta/list-campaign-templates.api.mdx new file mode 100644 index 000000000..f03dedb13 --- /dev/null +++ b/products/idn/api/beta/list-campaign-templates.api.mdx @@ -0,0 +1,123 @@ +--- +id: list-campaign-templates +sidebar_label: List Campaign Templates +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listCampaignTemplates","tags":["Certification Campaigns"],"parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name, created, modified**"},{"in":"query","name":"filters","schema":{"type":"string","format":"comma-separated"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields: **name, id**"}],"responses":{"200":{"description":"List of campaign template objects","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Campaign Template","properties":{"id":{"type":"string","description":"Id of the campaign template","example":"2c9079b270a266a60170a277bb960008"},"name":{"type":"string","description":"This template's name. Has no bearing on generated campaigns' names.","example":"Manager Campaign Template"},"description":{"type":"string","description":"This template's description. Has no bearing on generated campaigns' descriptions.","example":"Template for the annual manager campaign."},"created":{"type":"string","description":"Creation date of Campaign Template","readOnly":true,"format":"date-time","example":"2020-03-05T22:44:00.364Z"},"modified":{"type":"string","description":"Modification date of Campaign Template","readOnly":true,"format":"date-time","example":"2020-03-05T22:52:09.969Z"},"scheduled":{"type":"boolean","readOnly":true,"description":"Indicates if this campaign template has been scheduled.","example":false},"ownerRef":{"type":"object","description":"The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user.","properties":{"id":{"type":"string","description":"Id of the owner","example":"2c918086676d3e0601677611dbde220f"},"type":{"type":"string","enum":["IDENTITY"],"description":"Type of the owner","example":"IDENTITY"},"name":{"type":"string","description":"Name of the owner","example":"Mister Manager"},"email":{"type":"string","description":"Email of the owner","example":"mr.manager@example.com"}}},"deadlineDuration":{"type":"string","description":"The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign's deadline would be 2020-01-15 (the current date plus 14 days).","example":"P2W"},"campaign":{"type":"object","title":"Campaign","allOf":[{"type":"object","title":"Slim Campaign","required":["name","description","type"],"properties":{"id":{"type":"string","readOnly":true,"description":"Id of the campaign","example":"2c9079b270a266a60170a2779fcb0007"},"name":{"description":"The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","type":"string","example":"Manager Campaign"},"description":{"type":"string","description":"The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","example":"Everyone needs to be reviewed by their manager"},"deadline":{"type":"string","format":"date-time","description":"The campaign's completion deadline.","example":"2020-03-15T10:00:01.456Z"},"type":{"type":"string","description":"The type of campaign. Could be extended in the future.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"},"emailNotificationEnabled":{"type":"boolean","description":"Enables email notification for this campaign","default":false,"example":false},"autoRevokeAllowed":{"type":"boolean","description":"Allows auto revoke for this campaign","default":false,"example":false},"recommendationsEnabled":{"type":"boolean","description":"Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.","default":false,"example":true},"status":{"type":"string","description":"The campaign's current status.","readOnly":true,"enum":["PENDING","STAGED","CANCELING","ACTIVATING","ACTIVE","COMPLETING","COMPLETED","ERROR","ARCHIVED"],"example":"ACTIVE"},"correlatedStatus":{"type":"string","description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"}}},{"type":"object","properties":{"created":{"type":"string","readOnly":true,"format":"date-time","description":"Created time of the campaign","example":"2020-03-03T22:15:13.611Z"},"modified":{"type":"string","readOnly":true,"format":"date-time","description":"Modified time of the campaign","example":"2020-03-03T22:20:12.674Z"},"correlatedStatus":{"description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"},"filter":{"type":"object","description":"Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank.","properties":{"id":{"type":"string","description":"The ID of whatever type of filter is being used.","example":"0fbe863c063c4c88a35fd7f17e8a3df5"},"type":{"type":"string","description":"Type of the filter","enum":["CAMPAIGN_FILTER","RULE"],"example":"CAMPAIGN_FILTER"},"name":{"type":"string","description":"Name of the filter","example":"Test Filter"}}},"sunsetCommentsRequired":{"type":"boolean","description":"Determines if comments on sunset date changes are required.","default":true,"example":true},"sourceOwnerCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SOURCE_OWNER.","properties":{"sourceIds":{"type":"array","description":"The list of sources to be included in the campaign.","items":{"type":"string"},"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]}}},"searchCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SEARCH.","properties":{"type":{"type":"string","description":"The type of search campaign represented.","enum":["IDENTITY","ACCESS"],"example":"ACCESS"},"description":{"type":"string","description":"Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available.","example":"Search Campaign description"},"reviewer":{"description":"If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"query":{"type":"string","description":"The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set.","example":"Search Campaign query description"},"identityIds":{"type":"array","description":"A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set.","items":{"type":"string"},"maxItems":1000,"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]},"accessConstraints":{"type":"array","description":"Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT","ACCESS_PROFILE","ROLE"],"description":"Type of Access","example":"ENTITLEMENT"},"ids":{"description":"Must be set only if operator is SELECTED.","type":"array","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"operator":{"type":"string","enum":["ALL","SELECTED"],"description":"Used to determine whether the scope of the campaign should be reduced for selected ids or all.","example":"SELECTED"}},"required":["type","operator"]},"maxItems":1000}},"required":["type"]},"roleCompositionCampaignInfo":{"type":"object","description":"Optional configuration options for role composition campaigns.","properties":{"reviewer":{"description":"If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"roleIds":{"type":"array","description":"Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"remediatorRef":{"type":"object","description":"This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin.","properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Legal Remediator Type","example":"IDENTITY"},"id":{"type":"string","description":"The ID of the remediator.","example":"2c90ad2a70ace7d50170acf22ca90010"},"name":{"type":"string","description":"The name of the remediator.","readOnly":true,"example":"Role Admin"}},"required":["type","id"]},"query":{"type":"string","description":"Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","example":"Search Query"},"description":{"type":"string","description":"Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available.","example":"Role Composition Description"}},"required":["remediatorRef"]},"alerts":{"type":"array","description":"A list of errors and warnings that have accumulated.","readOnly":true,"items":{"type":"object","properties":{"level":{"type":"string","enum":["ERROR","WARN","INFO"],"description":"Denotes the level of the message","example":"ERROR"},"localizations":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}},"totalCertifications":{"type":"integer","description":"The total number of certifications in this campaign.","readOnly":true,"example":100},"completedCertifications":{"type":"integer","description":"The number of completed certifications in this campaign.","readOnly":true,"example":10},"sourcesWithOrphanEntitlements":{"type":"array","description":"A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented).","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the source","example":"2c90ad2a70ace7d50170acf22ca90010"},"type":{"type":"string","enum":["SOURCE"],"description":"Type","example":"SOURCE"},"name":{"type":"string","description":"Name of the source","example":"Source with orphan entitlements"}}}},"mandatoryCommentRequirement":{"type":"string","description":"Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.","enum":["ALL_DECISIONS","REVOKE_ONLY_DECISIONS","NO_DECISIONS"],"example":"NO_DECISIONS"}}}]}},"required":["name","description","created","modified","campaign"]}},"example":[{"id":"e7dbec99d49349c8951bd84f58a05120","name":"Manager Review","created":"2022-08-02T19:16:42.632Z","modified":null,"description":"A review of everyone's access by their manager.","deadlineDuration":"P14D","ownerRef":{"email":"support@testmail.identitysoon.com","type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"scheduled":false,"campaign":{"created":null,"modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c","name":"Test Manager Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":null,"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":null,"completedCertifications":null,"sourcesWithOrphanEntitlements":null,"id":null,"name":"Manager Review","description":"Review everyone's access.","deadline":null,"type":"MANAGER","status":null,"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"mandatoryCommentRequirement":"NO_DECISIONS"}},{"id":"b7e6459eed5247ac8b98a5fed81fe27f","name":"Reporting Access Review","created":"2022-07-28T19:19:40.035Z","modified":null,"description":"A review of everyone's access to the reporting system.","deadlineDuration":"P14D","ownerRef":{"email":"support@testmail.identitysoon.com","type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"scheduled":false,"campaign":{"created":null,"modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c","name":"Test Search Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":{"type":"ACCESS","description":"Identities with reporting abilities","reviewerId":null,"reviewer":null,"query":"@access(name: (\"reporter\"))","identityIds":null,"accessConstraints":[]},"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":null,"completedCertifications":null,"sourcesWithOrphanEntitlements":null,"id":null,"name":"Search Campaign","description":"Review everyone's access to the reporting system.","deadline":null,"type":"SEARCH","status":null,"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"mandatoryCommentRequirement":"NO_DECISIONS"}},{"id":"b9f41bc69e7a4291b9de0630396d030d","name":"Campaign With Admin Role","created":"2022-08-02T13:40:36.857Z","modified":null,"description":"Campaign With Admin Role","deadlineDuration":null,"ownerRef":{"email":"support@testmail.identitysoon.com","type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"scheduled":false,"campaign":{"created":null,"modified":null,"filter":null,"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":null,"roleCompositionCampaignInfo":{"remediatorRef":{"type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"reviewerId":null,"reviewer":null,"roleIds":["b15d609fc5c8434b865fe552315fda8f"],"query":null,"description":null},"alerts":null,"totalCertifications":null,"completedCertifications":null,"sourcesWithOrphanEntitlements":null,"id":null,"name":"Campaign With Admin Role","description":"Campaign With Admin Role","deadline":null,"type":"ROLE_COMPOSITION","status":null,"emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"mandatoryCommentRequirement":"NO_DECISIONS"}},{"id":"b9f41bc69e7a4291b9de0630396d030d","name":"AD Source Review","created":"2022-08-02T13:40:36.857Z","modified":null,"description":"A review of our AD source.","deadlineDuration":"P1M","ownerRef":{"email":"support@testmail.identitysoon.com","type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"scheduled":false,"campaign":{"created":null,"modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c","name":"Test Source Owner Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":{"sourceIds":["2c918084707deba501709d45ce4e5569"]},"searchCampaignInfo":null,"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":null,"completedCertifications":null,"sourcesWithOrphanEntitlements":null,"id":null,"name":"AD Source Review","description":"Review everyone's access.","deadline":null,"type":"SOURCE_OWNER","status":null,"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"}}]}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"description":"List Campaign Templates","method":"get","path":"/campaign-templates","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Campaign Templates","description":{"type":"text/plain"},"url":{"path":["campaign-templates"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name, created, modified**","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields: **name, id**","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Campaign Templates' (list-campaign-templates)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Campaign Templates + + + +List Campaign Templates + +
Query Parameters
+ +List of campaign template objects + +
Schema array
    ownerRef object
    + +The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user. + +
    campaign object
    filter object
    + +Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank. + +
    sourceOwnerCampaignInfo object
    + +Must be set only if the campaign type is SOURCE_OWNER. + +
    searchCampaignInfo object
    + +Must be set only if the campaign type is SEARCH. + +
    reviewer object
    + +If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP + +
    accessConstraints object[]
    + +**Possible values:** `<= 1000` + +
    + +Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. + +
    roleCompositionCampaignInfo object
    + +Optional configuration options for role composition campaigns. + +
    reviewer object
    + +If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP + +
    remediatorRef object
    + +This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin. + +
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
    localizations object[]
    sourcesWithOrphanEntitlements object[]
    + +A list of sources in the campaign that contain \"orphan entitlements\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-certification-reviewers.api.mdx b/products/idn/api/beta/list-certification-reviewers.api.mdx new file mode 100644 index 000000000..def6304a4 --- /dev/null +++ b/products/idn/api/beta/list-certification-reviewers.api.mdx @@ -0,0 +1,87 @@ +--- +id: list-certification-reviewers +sidebar_label: List of Reviewers for the certification +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listCertificationReviewers","tags":["Certifications"],"description":"This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The certification ID","example":"ef38f94347e94562b5bb8424a56397d8"},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators (Filtering is done by reviewer's fields):\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**email**: *eq, sw*"},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name, email**"}],"responses":{"200":{"description":"A list of reviewers","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"},"id":{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"},"name":{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"},"email":{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/certifications/{id}/reviewers","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List of Reviewers for the certification","description":{"content":"This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.","type":"text/plain"},"url":{"path":["certifications",":id","reviewers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators (Filtering is done by reviewer's fields):\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**email**: *eq, sw*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name, email**","type":"text/plain"},"key":"sorters","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The certification ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List of Reviewers for the certification' (list-certification-reviewers)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List of Reviewers for the certification + + + +This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +
Path Parameters
Query Parameters
+ +A list of reviewers + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-complete-workflow-library.api.mdx b/products/idn/api/beta/list-complete-workflow-library.api.mdx new file mode 100644 index 000000000..451e97d31 --- /dev/null +++ b/products/idn/api/beta/list-complete-workflow-library.api.mdx @@ -0,0 +1,87 @@ +--- +id: list-complete-workflow-library +sidebar_label: List Complete Workflow Library +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listCompleteWorkflowLibrary","tags":["Workflows"],"description":"This lists all triggers, actions, and operators in the library","externalDocs":{"description":"Additional documentation for workflows","url":"https://documentation.sailpoint.com/saas/help/workflows/workflow-steps.html"},"parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}],"security":[{"oauth2":["sp:workflow:read"]}],"responses":{"200":{"description":"List of workflow steps","content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"title":"Workflow Action","type":"object","properties":{"id":{"type":"string","description":"Action ID. This is a static namespaced ID for the action","example":"sp:create-campaign"},"name":{"type":"string","description":"Action Name","example":"Create Certification Campaign"},"type":{"type":"string","description":"Action type","example":"ACTION"},"description":{"type":"string","description":"Action Description","example":"Generates a certification campaign."},"formFields":{"type":"array","description":"One or more inputs that the action accepts","items":{"type":"object","properties":{"helpText":{"type":"string","description":"Describes the form field in the UI","example":"The name to give to this certification campaign."},"label":{"type":"string","description":"A human readable name for this form field in the UI","example":"Campaign Name"},"name":{"type":"string","description":"The name of the input attribute","example":"name"},"required":{"type":"boolean","description":"Denotes if this field is a required attribute","example":false},"type":{"description":"The type of the form field","nullable":true,"enum":["text","textarea","boolean","email","url","number","json","checkbox","jsonpath","select","multiType","duration","toggle","identityPicker","governanceGroupPicker","string","object","array","secret","keyValuePairs","emailPicker","advancedToggle"],"example":"text"}}}},"isDynamicSchema":{"type":"boolean","description":"Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields.","example":false},"outputSchema":{"type":"object","description":"Defines the output schema, if any, that this action produces.","example":{"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"}}}},{"title":"Workflow Trigger","type":"object","properties":{"id":{"type":"string","description":"Trigger ID. This is a static namespaced ID for the trigger.","example":"idn:identity-attributes-changed"},"type":{"description":"Trigger type","enum":["EVENT","SCHEDULED","EXTERNAL"],"example":"EVENT"},"name":{"type":"string","description":"Trigger Name","example":"Identity Attributes Changed"},"description":{"type":"string","description":"Trigger Description","example":"One or more identity attributes changed."},"isDynamicSchema":{"type":"boolean","description":"Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields.","example":false},"inputExample":{"type":"object","description":"Example trigger payload if applicable","nullable":true,"externalDocs":{"description":"List of triggers and their input schemas","url":"https://developer.sailpoint.com/idn/docs/event-triggers/available"},"example":{"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":{"type":"array","nullable":true,"description":"One or more inputs that the trigger accepts","example":[],"items":{"type":"object","properties":{"helpText":{"type":"string","description":"Describes the form field in the UI","example":"The name to give to this certification campaign."},"label":{"type":"string","description":"A human readable name for this form field in the UI","example":"Campaign Name"},"name":{"type":"string","description":"The name of the input attribute","example":"name"},"required":{"type":"boolean","description":"Denotes if this field is a required attribute","example":false},"type":{"description":"The type of the form field","nullable":true,"enum":["text","textarea","boolean","email","url","number","json","checkbox","jsonpath","select","multiType","duration","toggle","identityPicker","governanceGroupPicker","string","object","array","secret","keyValuePairs","emailPicker","advancedToggle"],"example":"text"}}}}}},{"title":"Workflow Operator","type":"object","properties":{"id":{"type":"string","description":"Operator ID.","example":"sp:compare-boolean"},"name":{"type":"string","description":"Operator friendly name","example":"Compare Boolean Values"},"type":{"description":"Operator type","type":"string","example":"OPERATOR"},"description":{"type":"string","description":"Description of the operator","example":"Compare two boolean values and decide what happens based on the result."},"formFields":{"type":"array","description":"One or more inputs that the operator accepts","items":{"type":"object","properties":{"helpText":{"type":"string","description":"Describes the form field in the UI","example":"The name to give to this certification campaign."},"label":{"type":"string","description":"A human readable name for this form field in the UI","example":"Campaign Name"},"name":{"type":"string","description":"The name of the input attribute","example":"name"},"required":{"type":"boolean","description":"Denotes if this field is a required attribute","example":false},"type":{"description":"The type of the form field","nullable":true,"enum":["text","textarea","boolean","email","url","number","json","checkbox","jsonpath","select","multiType","duration","toggle","identityPicker","governanceGroupPicker","string","object","array","secret","keyValuePairs","emailPicker","advancedToggle"],"example":"text"}}},"example":[{"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"}]}}}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/workflow-library","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Complete Workflow Library","description":{"content":"This lists all triggers, actions, and operators in the library","type":"text/plain"},"url":{"path":["workflow-library"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Complete Workflow Library' (list-complete-workflow-library)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Complete Workflow Library + + + +This lists all triggers, actions, and operators in the library + +
Query Parameters
+ +List of workflow steps + +
Schema array
    anyOf
    formFields object[]
    + +One or more inputs that the action accepts + +
    formFields object[]
    + +One or more inputs that the trigger accepts + +
    formFields object[]
    + +One or more inputs that the operator accepts + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-completed-approvals.api.mdx b/products/idn/api/beta/list-completed-approvals.api.mdx new file mode 100644 index 000000000..55129b281 --- /dev/null +++ b/products/idn/api/beta/list-completed-approvals.api.mdx @@ -0,0 +1,127 @@ +--- +id: list-completed-approvals +sidebar_label: Completed Access Request Approvals List +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listCompletedApprovals","tags":["Access Request Approvals"],"description":"This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info.","parameters":[{"in":"query","name":"owner-id","schema":{"type":"string"},"description":"If present, the value returns only completed approvals for the specified identity.\n * ORG_ADMIN users can call this with any identity ID value.\n * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used.\n * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value."},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**requestedFor.id**: *eq, in*\n\n**modified**: *gt, lt, ge, le*"},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created, modified**"}],"responses":{"200":{"description":"List of Completed Approvals.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c938083633d259901633d25c68c00fa","description":"The approval id."},"name":{"type":"string","example":"Approval Name","description":"The name of the approval."},"created":{"type":"string","format":"date-time","description":"When the approval was created.","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","description":"When the approval was modified last time.","example":"2018-07-25T20:22:28.104Z"},"requestCreated":{"type":"string","format":"date-time","description":"When the access-request was created.","example":"2017-07-11T18:45:35.098Z"},"requestType":{"type":"string","enum":["GRANT_ACCESS","REVOKE_ACCESS"],"description":"Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field.","example":"GRANT_ACCESS"},"requester":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The identity that requested the item."},"requestedFor":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The identity for whom the item is requested for."},"reviewedBy":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The identity who has reviewed the approval."},"owner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The owner or approver of the approval."},"requestedObject":{"description":"The requested access item.","type":"object","properties":{"id":{"type":"string","example":"2c938083633d259901633d25c68c00fa","description":"Id of the object."},"name":{"type":"string","example":"Object Name","description":"Name of the object."},"description":{"type":"string","example":"Object Description","description":"Description of the object."},"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"Type of the object.","example":"ROLE"}}},"requesterComment":{"type":"object","properties":{"comment":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat"},"author":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the author","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"}}},"created":{"type":"string","format":"date-time","description":"Date and time comment was created","example":"2017-07-11T18:45:37.098Z"}},"description":"The requester's comment."},"reviewerComment":{"type":"object","properties":{"comment":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat"},"author":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the author","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"}}},"created":{"type":"string","format":"date-time","description":"Date and time comment was created","example":"2017-07-11T18:45:37.098Z"}},"description":"The approval's reviewer's comment."},"previousReviewersComments":{"type":"array","items":{"type":"object","properties":{"comment":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat"},"author":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the author","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"}}},"created":{"type":"string","format":"date-time","description":"Date and time comment was created","example":"2017-07-11T18:45:37.098Z"}}},"description":"The history of the previous reviewers comments."},"forwardHistory":{"type":"array","items":{"type":"object","properties":{"oldApproverName":{"type":"string","description":"Display name of approver from whom the approval was forwarded.","example":"Frank Mir"},"newApproverName":{"type":"string","description":"Display name of approver to whom the approval was forwarded.","example":"Al Volta"},"comment":{"type":"string","nullable":true,"description":"Comment made while forwarding.","example":"Forwarding from Frank to Al"},"modified":{"type":"string","format":"date-time","description":"Time at which approval was forwarded.","example":"2019-08-23T18:52:57.398Z"},"forwarderName":{"type":"string","nullable":true,"description":"Display name of forwarder who forwarded the approval.","example":"William Wilson"},"reassignmentType":{"description":"The approval reassignment type. \n* MANUAL_REASSIGNMENT: An approval with this reassignment type has been specifically reassigned by the approval task's owner, from their queue to someone else's. \n* AUTOMATIC_REASSIGNMENT: An approval with this reassignment type has been automatically reassigned from another approver's queue, according to that approver's reassignment configuration. The approver's reassignment configuration may be set up to automatically reassign approval tasks for a defined (or possibly open-ended) period of time.\n* AUTO_ESCALATION: An approval with this reassignment type has been automatically reassigned from another approver's queue, according to the request's escalation configuration. For more information about escalation configuration, refer to [Setting Global Reminders and Escalation Policies](https://documentation.sailpoint.com/saas/help/requests/config_emails.html).\n* SELF_REVIEW_DELEGATION: An approval with this reassignment type has been automatically reassigned by the system to prevent self-review. This helps prevent situations like a requester being tasked with approving their own request. For more information about preventing self-review, refer to [Self-review Prevention](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html#self-review-prevention) and [Preventing Self-approval](https://documentation.sailpoint.com/saas/help/requests/config_ap_roles.html#preventing-self-approval).","example":"AUTOMATIC_REASSIGNMENT","type":"string","enum":["MANUAL_REASSIGNMENT","AUTOMATIC_REASSIGNMENT","AUTO_ESCALATION","SELF_REVIEW_DELEGATION"]}}},"description":"The history of approval forward action."},"commentRequiredWhenRejected":{"type":"boolean","example":true,"description":"When true the rejector has to provide comments when rejecting"},"state":{"description":"The final state of the approval","type":"string","enum":["APPROVED","REJECTED"],"example":"APPROVED"},"removeDate":{"type":"string","description":"The date the role or access profile is no longer assigned to the specified identity.","format":"date-time","example":"2020-07-11T00:00:00Z"},"removeDateUpdateRequested":{"type":"boolean","example":true,"description":"If true, then the request was to change the remove date or sunset date."},"currentRemoveDate":{"type":"string","description":"The remove date or sunset date that was assigned at the time of the request.","format":"date-time","example":"2020-07-11T00:00:00Z"},"sodViolationContext":{"description":"The details of the SOD violations for the associated approval.","type":"object","properties":{"state":{"type":"string","enum":["SUCCESS","ERROR"],"description":"The status of SOD violation check","example":"SUCCESS"},"uuid":{"description":"The id of the Violation check event","type":"string","example":"f73d16e9-a038-46c5-b217-1246e15fdbdd"},"violationCheckResult":{"description":"The inner object representing the completed SOD Violation check","type":"object","properties":{"message":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}},"description":"If the request failed, includes any error message that was generated.","example":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An error has occurred during the SOD violation check"}]},"clientMetadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check.","example":{"requestedAppName":"test-app","requestedAppId":"2c91808f7892918f0178b78da4a305a1"}},"violationContexts":{"type":"array","items":{"description":"The contextual information of the violated criteria","type":"object","properties":{"policy":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Reference to the Policy that is being violated."},"conflictingAccessCriteria":{"type":"object","description":"The object which contains the left and right hand side of the entitlements that got violated according to the policy.","properties":{"leftCriteria":{"type":"object","properties":{"criteriaList":{"type":"array","items":{"description":"Details of the Entitlement criteria","type":"object","properties":{"existing":{"type":"boolean","example":true,"description":"If the entitlement already belonged to the user or not."},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Entitlement ID","example":"2c918085771e9d3301773b3cb66f6398"},"name":{"type":"string","description":"Entitlement name","example":"My HR Entitlement"}}}}}},"rightCriteria":{"type":"object","properties":{"criteriaList":{"type":"array","items":{"description":"Details of the Entitlement criteria","type":"object","properties":{"existing":{"type":"boolean","example":true,"description":"If the entitlement already belonged to the user or not."},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Entitlement ID","example":"2c918085771e9d3301773b3cb66f6398"},"name":{"type":"string","description":"Entitlement name","example":"My HR Entitlement"}}}}}}}}}}},"violatedPolicies":{"type":"array","description":"A list of the Policies that were violated","items":{"description":"Reference to the policy that was violated","example":[{"type":"SOD_POLICY","id":"69129440-422d-4a23-aadd-35c828d5bfda","name":"HR Policy"}],"type":"object","properties":{"id":{"type":"string","description":"the application ID","example":"ff8081814d977c21014da056804a0af3"},"name":{"type":"string","description":"the application name","example":"Github"}}}}}}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/access-request-approvals/completed","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Completed Access Request Approvals List","description":{"content":"This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info.","type":"text/plain"},"url":{"path":["access-request-approvals","completed"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If present, the value returns only completed approvals for the specified identity.\n * ORG_ADMIN users can call this with any identity ID value.\n * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used.\n * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value.","type":"text/plain"},"key":"owner-id","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**requestedFor.id**: *eq, in*\n\n**modified**: *gt, lt, ge, le*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created, modified**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Completed Access Request Approvals List' (list-completed-approvals)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Completed Access Request Approvals List + + + +This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. + +
Query Parameters
+ +List of Completed Approvals. + +
Schema array
    requester object
    + +The identity that requested the item. + +
    requestedFor object
    + +The identity for whom the item is requested for. + +
    reviewedBy object
    + +The identity who has reviewed the approval. + +
    owner object
    + +The owner or approver of the approval. + +
    requestedObject object
    + +The requested access item. + +
    requesterComment object
    + +The requester's comment. + +
    author object
    reviewerComment object
    + +The approval's reviewer's comment. + +
    author object
    previousReviewersComments object[]
    + +The history of the previous reviewers comments. + +
    author object
    forwardHistory object[]
    + +The history of approval forward action. + +
    sodViolationContext object
    + +The details of the SOD violations for the associated approval. + +
    violationCheckResult object
    + +The inner object representing the completed SOD Violation check + +
    message object
    + +If the request failed, includes any error message that was generated. + +
    clientMetadata object
    + +Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. + +
  • property name* string
    • violationContexts object[]
    policy object
    + +Reference to the Policy that is being violated. + +
    conflictingAccessCriteria object
    + +The object which contains the left and right hand side of the entitlements that got violated according to the policy. + +
    leftCriteria object
    criteriaList object[]
    rightCriteria object
    criteriaList object[]
    violatedPolicies object[]
    + +A list of the Policies that were violated + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-entitlement-children.api.mdx b/products/idn/api/beta/list-entitlement-children.api.mdx new file mode 100644 index 000000000..5d24e6869 --- /dev/null +++ b/products/idn/api/beta/list-entitlement-children.api.mdx @@ -0,0 +1,99 @@ +--- +id: list-entitlement-children +sidebar_label: List of entitlements children +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listEntitlementChildren","tags":["Entitlements"],"description":"This API returns a list of all child entitlements of a given entitlement.","security":[{"oauth2":["idn:entitlement:read"]}],"parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Entitlement Id","example":"2c91808874ff91550175097daaec161c"},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\nSorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id**","example":"name,-modified","required":false,"style":"form","explode":true},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*","example":"attribute eq \"memberOf\"","required":false,"style":"form","explode":true}],"responses":{"200":{"description":"List of entitlements children from an entitlement","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The entitlement id","example":"2c91808874ff91550175097daaec161c"},"name":{"type":"string","description":"The entitlement name","example":"LauncherTest2"},"created":{"type":"string","description":"Time when the entitlement was created","format":"date-time","example":"2020-10-08T18:33:52.029Z"},"modified":{"type":"string","description":"Time when the entitlement was last modified","format":"date-time","example":"2020-10-08T18:33:52.029Z"},"attribute":{"type":"string","description":"The entitlement attribute name","example":"memberOf"},"value":{"type":"string","description":"The value of the entitlement","example":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local"},"sourceSchemaObjectType":{"type":"string","description":"The object type of the entitlement from the source schema","example":"group"},"privileged":{"type":"boolean","default":false,"description":"True if the entitlement is privileged","example":true},"cloudGoverned":{"type":"boolean","default":false,"description":"True if the entitlement is cloud governed","example":true},"description":{"type":"string","description":"The description of the entitlement","example":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local"},"requestable":{"type":"boolean","default":false,"description":"True if the entitlement is requestable","example":true},"attributes":{"type":"object","description":"A map of free-form key-value pairs from the source system","example":{"fieldName":"fieldValue"},"additionalProperties":true},"source":{"type":"object","properties":{"id":{"type":"string","description":"The source ID","example":"2c9180827ca885d7017ca8ce28a000eb"},"type":{"type":"string","description":"The source type, will always be \"SOURCE\"","example":"SOURCE"},"name":{"type":"string","description":"The source name","example":"ODS-AD-Source"}}},"owner":{"type":"object","description":"Simplified DTO for the owner object of the entitlement","properties":{"id":{"type":"string","description":"The owner id for the entitlement","example":"2a2fdacca5e345f18bf7970cfbb8fec2"},"name":{"type":"string","description":"The owner name for the entitlement","example":"identity 1"},"type":{"type":"string","enum":["IDENTITY"],"description":"The type of the owner. Initially only type IDENTITY is supported","example":"IDENTITY"}}},"directPermissions":{"type":"array","items":{"type":"object","description":"Simplified DTO for the Permission objects stored in SailPoint's database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers.","properties":{"rights":{"type":"array","description":"All the rights (e.g. actions) that this permission allows on the target","readOnly":true,"items":{"type":"string","example":"SELECT"}},"target":{"type":"string","description":"The target the permission would grants rights on.","readOnly":true,"example":"SYS.GV_$TRANSACTION"}}}},"segments":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of IDs of segments, if any, to which this Entitlement is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]},"manuallyUpdatedFields":{"description":"Object contains entitlement manually updated fields. Field value is true if is was updated manually via entitlement import csv or patch endpoint. Field value is false if that property value has not been changed after first entitlement aggregation. Values for all manually updatable fields must be specified. For now only two entitlement fields support this: DISPLAY_NAME and DESCRIPTION.","example":{"DISPLAY_NAME":true,"DESCRIPTION":true},"type":"object","properties":{"DISPLAY_NAME":{"type":"boolean","default":false,"description":"True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation.\nField refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property.","example":true},"DESCRIPTION":{"type":"boolean","default":false,"description":"True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation.\nField refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property.","example":true}}}}}},"example":[{"sourceSchemaObjectType":"group","attribute":"memberOf","attributes":{"GroupType":"Security","sAMAccountName":"LauncherTest1","GroupScope":"Global","objectguid":"{01a6e70b-9705-4155-a5c6-492a9bcc8c64}","objectSid":"S-1-5-21-3585869415-1648031554-2909195034-1633","cn":"LauncherTest1","msDS-PrincipalName":"AUTOMATIONAD\\LauncherTest1"},"value":"CN=LauncherTest1,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local","description":"some description","privileged":false,"cloudGoverned":false,"source":{"type":"SOURCE","id":"2c9180877504c40e0175097d5ce707c8","name":"EndToEnd-ADSource"},"owner":{"id":"2a2fdacca5e345f18bf7970cfbb8fec2","name":"identity 1","type":"IDENTITY"},"segments":["1d126fe0-45e2-4aea-bc64-a07e9344ef26"],"manuallyUpdatedFields":{"DISPLAY_NAME":true,"DESCRIPTION":true},"id":"2c91808c74ff913f0175097daa9d59cd","name":"LauncherTest1","created":"2020-10-08T18:33:52.029Z","modified":"2021-01-19T16:53:35.707Z"}]}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/entitlements/{id}/children","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List of entitlements children","description":{"content":"This API returns a list of all child entitlements of a given entitlement.","type":"text/plain"},"url":{"path":["entitlements",":id","children"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\nSorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id**","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*","type":"text/plain"},"key":"filters","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Entitlement Id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List of entitlements children' (list-entitlement-children)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List of entitlements children + + + +This API returns a list of all child entitlements of a given entitlement. + +
Path Parameters
Query Parameters
+ +List of entitlements children from an entitlement + +
Schema array
    attributes object
    + +A map of free-form key-value pairs from the source system + +
    source object
    owner object
    + +Simplified DTO for the owner object of the entitlement + +
    directPermissions object[]
    manuallyUpdatedFields object
    + +Object contains entitlement manually updated fields. Field value is true if is was updated manually via entitlement import csv or patch endpoint. Field value is false if that property value has not been changed after first entitlement aggregation. Values for all manually updatable fields must be specified. For now only two entitlement fields support this: DISPLAY_NAME and DESCRIPTION. + +
    `name` property."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}> `description` property."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-entitlement-parents.api.mdx b/products/idn/api/beta/list-entitlement-parents.api.mdx new file mode 100644 index 000000000..b9ef26bd4 --- /dev/null +++ b/products/idn/api/beta/list-entitlement-parents.api.mdx @@ -0,0 +1,99 @@ +--- +id: list-entitlement-parents +sidebar_label: List of entitlements parents +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listEntitlementParents","tags":["Entitlements"],"description":"This API returns a list of all parent entitlements of a given entitlement.","security":[{"oauth2":["idn:entitlement:read","idn:entitlement:manage"]}],"parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Entitlement Id","example":"2c91808c74ff913f0175097daa9d59cd"},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\nSorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id**","example":"name,-modified","required":false,"style":"form","explode":true},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*","example":"attribute eq \"memberOf\"","required":false,"style":"form","explode":true}],"responses":{"200":{"description":"List of entitlements parents from an entitlement","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The entitlement id","example":"2c91808874ff91550175097daaec161c"},"name":{"type":"string","description":"The entitlement name","example":"LauncherTest2"},"created":{"type":"string","description":"Time when the entitlement was created","format":"date-time","example":"2020-10-08T18:33:52.029Z"},"modified":{"type":"string","description":"Time when the entitlement was last modified","format":"date-time","example":"2020-10-08T18:33:52.029Z"},"attribute":{"type":"string","description":"The entitlement attribute name","example":"memberOf"},"value":{"type":"string","description":"The value of the entitlement","example":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local"},"sourceSchemaObjectType":{"type":"string","description":"The object type of the entitlement from the source schema","example":"group"},"privileged":{"type":"boolean","default":false,"description":"True if the entitlement is privileged","example":true},"cloudGoverned":{"type":"boolean","default":false,"description":"True if the entitlement is cloud governed","example":true},"description":{"type":"string","description":"The description of the entitlement","example":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local"},"requestable":{"type":"boolean","default":false,"description":"True if the entitlement is requestable","example":true},"attributes":{"type":"object","description":"A map of free-form key-value pairs from the source system","example":{"fieldName":"fieldValue"},"additionalProperties":true},"source":{"type":"object","properties":{"id":{"type":"string","description":"The source ID","example":"2c9180827ca885d7017ca8ce28a000eb"},"type":{"type":"string","description":"The source type, will always be \"SOURCE\"","example":"SOURCE"},"name":{"type":"string","description":"The source name","example":"ODS-AD-Source"}}},"owner":{"type":"object","description":"Simplified DTO for the owner object of the entitlement","properties":{"id":{"type":"string","description":"The owner id for the entitlement","example":"2a2fdacca5e345f18bf7970cfbb8fec2"},"name":{"type":"string","description":"The owner name for the entitlement","example":"identity 1"},"type":{"type":"string","enum":["IDENTITY"],"description":"The type of the owner. Initially only type IDENTITY is supported","example":"IDENTITY"}}},"directPermissions":{"type":"array","items":{"type":"object","description":"Simplified DTO for the Permission objects stored in SailPoint's database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers.","properties":{"rights":{"type":"array","description":"All the rights (e.g. actions) that this permission allows on the target","readOnly":true,"items":{"type":"string","example":"SELECT"}},"target":{"type":"string","description":"The target the permission would grants rights on.","readOnly":true,"example":"SYS.GV_$TRANSACTION"}}}},"segments":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of IDs of segments, if any, to which this Entitlement is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]},"manuallyUpdatedFields":{"description":"Object contains entitlement manually updated fields. Field value is true if is was updated manually via entitlement import csv or patch endpoint. Field value is false if that property value has not been changed after first entitlement aggregation. Values for all manually updatable fields must be specified. For now only two entitlement fields support this: DISPLAY_NAME and DESCRIPTION.","example":{"DISPLAY_NAME":true,"DESCRIPTION":true},"type":"object","properties":{"DISPLAY_NAME":{"type":"boolean","default":false,"description":"True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation.\nField refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property.","example":true},"DESCRIPTION":{"type":"boolean","default":false,"description":"True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation.\nField refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property.","example":true}}}}}},"example":[{"sourceSchemaObjectType":"group","attribute":"memberOf","attributes":{"GroupType":"Security","sAMAccountName":"LauncherTest1","GroupScope":"Global","objectguid":"{01a6e70b-9705-4155-a5c6-492a9bcc8c64}","objectSid":"S-1-5-21-3585869415-1648031554-2909195034-1633","cn":"LauncherTest1","msDS-PrincipalName":"AUTOMATIONAD\\LauncherTest1"},"value":"CN=LauncherTest1,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local","description":"some description","privileged":false,"cloudGoverned":false,"source":{"type":"SOURCE","id":"2c9180877504c40e0175097d5ce707c8","name":"EndToEnd-ADSource"},"owner":{"id":"2a2fdacca5e345f18bf7970cfbb8fec2","name":"identity 1","type":"IDENTITY"},"segments":["1d126fe0-45e2-4aea-bc64-a07e9344ef26"],"manuallyUpdatedFields":{"DISPLAY_NAME":true,"DESCRIPTION":true},"id":"2c91808c74ff913f0175097daa9d59cd","name":"LauncherTest1","created":"2020-10-08T18:33:52.029Z","modified":"2021-01-19T16:53:35.707Z"}]}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/entitlements/{id}/parents","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List of entitlements parents","description":{"content":"This API returns a list of all parent entitlements of a given entitlement.","type":"text/plain"},"url":{"path":["entitlements",":id","parents"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\nSorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id**","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*","type":"text/plain"},"key":"filters","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Entitlement Id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List of entitlements parents' (list-entitlement-parents)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List of entitlements parents + + + +This API returns a list of all parent entitlements of a given entitlement. + +
Path Parameters
Query Parameters
+ +List of entitlements parents from an entitlement + +
Schema array
    attributes object
    + +A map of free-form key-value pairs from the source system + +
    source object
    owner object
    + +Simplified DTO for the owner object of the entitlement + +
    directPermissions object[]
    manuallyUpdatedFields object
    + +Object contains entitlement manually updated fields. Field value is true if is was updated manually via entitlement import csv or patch endpoint. Field value is false if that property value has not been changed after first entitlement aggregation. Values for all manually updatable fields must be specified. For now only two entitlement fields support this: DISPLAY_NAME and DESCRIPTION. + +
    `name` property."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}> `description` property."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-entitlements.api.mdx b/products/idn/api/beta/list-entitlements.api.mdx new file mode 100644 index 000000000..2232cfd58 --- /dev/null +++ b/products/idn/api/beta/list-entitlements.api.mdx @@ -0,0 +1,91 @@ +--- +id: list-entitlements +sidebar_label: Gets a list of entitlements. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listEntitlements","tags":["Entitlements"],"security":[{"oauth2":["idn:entitlement:read","idn:entitlement:manage"]}],"description":"This API returns a list of entitlements.\n\nThis API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive).\n\nAny authenticated token can call this API.","parameters":[{"in":"query","name":"account-id","schema":{"type":"string"},"description":"The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s).","example":"ef38f94347e94562b5bb8424a56397d8","required":false},{"in":"query","name":"segmented-for-identity","schema":{"type":"string"},"description":"If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID.\nCannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity.","example":"me","required":false},{"in":"query","name":"for-segment-ids","schema":{"type":"string","format":"comma-separated"},"description":"If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\nCannot be specified with the **account-id** or **segmented-for-identity** param(s).","example":"041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649","required":false},{"in":"query","name":"include-unsegmented","schema":{"type":"boolean","default":true},"description":"Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error.","example":true,"required":false},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\nSorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id**","example":"name,-modified","required":false,"style":"form","explode":true},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*","example":"attribute eq \"memberOf\"","required":false,"style":"form","explode":true}],"responses":{"200":{"description":"List of entitlements","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The entitlement id","example":"2c91808874ff91550175097daaec161c"},"name":{"type":"string","description":"The entitlement name","example":"LauncherTest2"},"created":{"type":"string","description":"Time when the entitlement was created","format":"date-time","example":"2020-10-08T18:33:52.029Z"},"modified":{"type":"string","description":"Time when the entitlement was last modified","format":"date-time","example":"2020-10-08T18:33:52.029Z"},"attribute":{"type":"string","description":"The entitlement attribute name","example":"memberOf"},"value":{"type":"string","description":"The value of the entitlement","example":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local"},"sourceSchemaObjectType":{"type":"string","description":"The object type of the entitlement from the source schema","example":"group"},"privileged":{"type":"boolean","default":false,"description":"True if the entitlement is privileged","example":true},"cloudGoverned":{"type":"boolean","default":false,"description":"True if the entitlement is cloud governed","example":true},"description":{"type":"string","description":"The description of the entitlement","example":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local"},"requestable":{"type":"boolean","default":false,"description":"True if the entitlement is requestable","example":true},"attributes":{"type":"object","description":"A map of free-form key-value pairs from the source system","example":{"fieldName":"fieldValue"},"additionalProperties":true},"source":{"type":"object","properties":{"id":{"type":"string","description":"The source ID","example":"2c9180827ca885d7017ca8ce28a000eb"},"type":{"type":"string","description":"The source type, will always be \"SOURCE\"","example":"SOURCE"},"name":{"type":"string","description":"The source name","example":"ODS-AD-Source"}}},"owner":{"type":"object","description":"Simplified DTO for the owner object of the entitlement","properties":{"id":{"type":"string","description":"The owner id for the entitlement","example":"2a2fdacca5e345f18bf7970cfbb8fec2"},"name":{"type":"string","description":"The owner name for the entitlement","example":"identity 1"},"type":{"type":"string","enum":["IDENTITY"],"description":"The type of the owner. Initially only type IDENTITY is supported","example":"IDENTITY"}}},"directPermissions":{"type":"array","items":{"type":"object","description":"Simplified DTO for the Permission objects stored in SailPoint's database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers.","properties":{"rights":{"type":"array","description":"All the rights (e.g. actions) that this permission allows on the target","readOnly":true,"items":{"type":"string","example":"SELECT"}},"target":{"type":"string","description":"The target the permission would grants rights on.","readOnly":true,"example":"SYS.GV_$TRANSACTION"}}}},"segments":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of IDs of segments, if any, to which this Entitlement is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]},"manuallyUpdatedFields":{"description":"Object contains entitlement manually updated fields. Field value is true if is was updated manually via entitlement import csv or patch endpoint. Field value is false if that property value has not been changed after first entitlement aggregation. Values for all manually updatable fields must be specified. For now only two entitlement fields support this: DISPLAY_NAME and DESCRIPTION.","example":{"DISPLAY_NAME":true,"DESCRIPTION":true},"type":"object","properties":{"DISPLAY_NAME":{"type":"boolean","default":false,"description":"True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation.\nField refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property.","example":true},"DESCRIPTION":{"type":"boolean","default":false,"description":"True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation.\nField refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property.","example":true}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/entitlements","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Gets a list of entitlements.","description":{"content":"This API returns a list of entitlements.\n\nThis API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive).\n\nAny authenticated token can call this API.","type":"text/plain"},"url":{"path":["entitlements"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s).","type":"text/plain"},"key":"account-id","value":""},{"disabled":false,"description":{"content":"If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID.\nCannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity.","type":"text/plain"},"key":"segmented-for-identity","value":""},{"disabled":false,"description":{"content":"If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\nCannot be specified with the **account-id** or **segmented-for-identity** param(s).","type":"text/plain"},"key":"for-segment-ids","value":""},{"disabled":false,"description":{"content":"Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error.","type":"text/plain"},"key":"include-unsegmented","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\nSorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id**","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n\n**type**: *eq, in*\n\n**attribute**: *eq, in*\n\n**value**: *eq, in, sw*\n\n**source.id**: *eq, in*\n\n**requestable**: *eq*\n**created**: *gt, lt, ge, le*\n**modified**: *gt, lt, ge, le*","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Gets a list of entitlements.' (list-entitlements)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Gets a list of entitlements. + + + +This API returns a list of entitlements. + +This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). + +Any authenticated token can call this API. + +
Query Parameters
+ +List of entitlements + +
Schema array
    attributes object
    + +A map of free-form key-value pairs from the source system + +
    source object
    owner object
    + +Simplified DTO for the owner object of the entitlement + +
    directPermissions object[]
    manuallyUpdatedFields object
    + +Object contains entitlement manually updated fields. Field value is true if is was updated manually via entitlement import csv or patch endpoint. Field value is false if that property value has not been changed after first entitlement aggregation. Values for all manually updatable fields must be specified. For now only two entitlement fields support this: DISPLAY_NAME and DESCRIPTION. + +
    `name` property."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}> `description` property."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-from-addresses.api.mdx b/products/idn/api/beta/list-from-addresses.api.mdx new file mode 100644 index 000000000..ae038ba35 --- /dev/null +++ b/products/idn/api/beta/list-from-addresses.api.mdx @@ -0,0 +1,63 @@ +--- +id: list-from-addresses +sidebar_label: List From Addresses +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listFromAddresses","tags":["Notifications"],"description":"Retrieve a list of sender email addresses and their verification statuses","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**email**: *eq*"},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields:\n\n**email**"}],"responses":{"200":{"description":"List of Email Status","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string","example":"sender@example.com"},"verificationStatus":{"type":"string","enum":["PENDING","SUCCESS","FAILED"]}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/verified-from-addresses","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List From Addresses","description":{"content":"Retrieve a list of sender email addresses and their verification statuses","type":"text/plain"},"url":{"path":["verified-from-addresses"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**email**: *eq*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields:\n\n**email**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List From Addresses' (list-from-addresses)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List From Addresses + + + +Retrieve a list of sender email addresses and their verification statuses + +
Query Parameters
+ +List of Email Status + +
Schema array
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-historical-identities.api.mdx b/products/idn/api/beta/list-historical-identities.api.mdx new file mode 100644 index 000000000..3f48727eb --- /dev/null +++ b/products/idn/api/beta/list-historical-identities.api.mdx @@ -0,0 +1,75 @@ +--- +id: list-historical-identities +sidebar_label: Lists all the identities +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listHistoricalIdentities","description":"This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of 'idn:identity-history:read'","security":[{"oauth2":["idn:identity-history:read"]}],"tags":["Identity History"],"parameters":[{"in":"query","name":"starts-with-query","schema":{"type":"string"},"description":"This param is used for starts-with search for first, last and display name of the identity","example":"Ada"},{"in":"query","name":"is-deleted","schema":{"type":"boolean"},"description":"Indicates if we want to only list down deleted identities or not.","example":true},{"in":"query","name":"is-active","schema":{"type":"boolean"},"description":"Indicates if we want to only list active or inactive identities.","example":true},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}],"responses":{"200":{"description":"List of identities for the customer.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"the identity ID","example":"bc693f07e7b645539626c25954c58554"},"displayName":{"type":"string","description":"the display name of the identity","example":"Adam Zampa"},"firstName":{"type":"string","description":"the first name of the identity","example":"Adam"},"lastName":{"type":"string","description":"the last name of the identity","example":"Zampa"},"active":{"type":"boolean","default":true,"description":"indicates if an identity is active or not","example":true},"deletedDate":{"type":"string","nullable":true,"description":"the date when the identity was deleted","example":"2007-03-01T13:00:00.000Z"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/historical-identities","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Lists all the identities","description":{"content":"This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of 'idn:identity-history:read'","type":"text/plain"},"url":{"path":["historical-identities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This param is used for starts-with search for first, last and display name of the identity","type":"text/plain"},"key":"starts-with-query","value":""},{"disabled":false,"description":{"content":"Indicates if we want to only list down deleted identities or not.","type":"text/plain"},"key":"is-deleted","value":""},{"disabled":false,"description":{"content":"Indicates if we want to only list active or inactive identities.","type":"text/plain"},"key":"is-active","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Lists all the identities' (list-historical-identities)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Lists all the identities + + + +This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of 'idn:identity-history:read' + +
Query Parameters
+ +List of identities for the customer. + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-identities.api.mdx b/products/idn/api/beta/list-identities.api.mdx new file mode 100644 index 000000000..d6d73f40f --- /dev/null +++ b/products/idn/api/beta/list-identities.api.mdx @@ -0,0 +1,79 @@ +--- +id: list-identities +sidebar_label: List Identities +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listIdentities","tags":["Identities"],"description":"This API returns a list of identities.","parameters":[{"in":"query","name":"filters","schema":{"type":"string"},"required":false,"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**alias**: *eq, sw*\n\n**firstname**: *eq, sw*\n\n**lastname**: *eq, sw*\n\n**email**: *eq, sw*\n\n**cloudStatus**: *eq*\n\n**processingState**: *eq*\n\n**correlated**: *eq*\n\n**protected**: *eq*","example":"id eq \"6c9079b270a266a60170a2779fcb0006\" or correlated eq false"},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"required":false,"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/#sorting-results)\n\nSorting is supported for the following fields: **name, alias, cloudStatus**","example":"name,-cloudStatus"},{"in":"query","name":"defaultFilter","schema":{"type":"string","enum":["CORRELATED_ONLY","NONE"],"default":"CORRELATED_ONLY"},"required":false,"description":"Adds additional filter to filters query parameter.\n\nCORRELATED_ONLY adds correlated=true and returns only identities that are correlated.\n\nNONE does not add any and returns all identities that satisfy filters query parameter.","example":"NONE"},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}],"responses":{"200":{"description":"List of identities.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"},"modified":{"description":"Last modification date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}},{"type":"object","title":"IdentityDto","properties":{"alias":{"type":"string","description":"Alternate unique identifier for the identity","example":"walter.white"},"emailAddress":{"type":"string","description":"The email address of the identity","example":"sender@example.com"},"processingState":{"type":"string","nullable":true,"description":"The processing state of the identity","enum":["ERROR","OK"],"example":"ERROR"},"identityStatus":{"type":"string","description":"The identity's status in the system","enum":["UNREGISTERED","REGISTERED","PENDING","WARNING","DISABLED","ACTIVE","DEACTIVATED","TERMINATED","ERROR","LOCKED"],"example":"LOCKED"},"managerRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"isManager":{"type":"boolean","description":"Whether this identity is a manager of another identity","default":false,"example":true},"lastRefresh":{"type":"string","format":"date-time","description":"The last time the identity was refreshed by the system","example":"2020-11-22T15:42:31.123Z"},"attributes":{"type":"object","description":"A map with the identity attributes for the identity","example":"{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}"},"lifecycleState":{"description":"Lifecycle state details that include lifecycle state name and whether this lifecycle state has been set manually","type":"object","properties":{"stateName":{"type":"string","description":"The name of the lifecycle state","example":"active"},"manuallyUpdated":{"type":"boolean","description":"Whether the lifecycle state has been manually or automatically set","example":true}},"required":["stateName","manuallyUpdated"]}}}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/identities","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Identities","description":{"content":"This API returns a list of identities.","type":"text/plain"},"url":{"path":["identities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**alias**: *eq, sw*\n\n**firstname**: *eq, sw*\n\n**lastname**: *eq, sw*\n\n**email**: *eq, sw*\n\n**cloudStatus**: *eq*\n\n**processingState**: *eq*\n\n**correlated**: *eq*\n\n**protected**: *eq*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/#sorting-results)\n\nSorting is supported for the following fields: **name, alias, cloudStatus**","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"Adds additional filter to filters query parameter.\n\nCORRELATED_ONLY adds correlated=true and returns only identities that are correlated.\n\nNONE does not add any and returns all identities that satisfy filters query parameter.","type":"text/plain"},"key":"defaultFilter","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Identities' (list-identities)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Identities + + + +This API returns a list of identities. + +
Query Parameters
+ +List of identities. + +
Schema array
    managerRef object
    lifecycleState object
    + +Lifecycle state details that include lifecycle state name and whether this lifecycle state has been set manually + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-identity-access-items.api.mdx b/products/idn/api/beta/list-identity-access-items.api.mdx new file mode 100644 index 000000000..ff2b29572 --- /dev/null +++ b/products/idn/api/beta/list-identity-access-items.api.mdx @@ -0,0 +1,83 @@ +--- +id: list-identity-access-items +sidebar_label: Gets a list of access items for the identity filtered by item type +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listIdentityAccessItems","tags":["Identity History"],"description":"This method retrieves a list of access item for the identity filtered by the access item type Requires authorization scope of 'idn:identity-history:read' ","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity id","example":"8c190e6787aa4ed9a90bd9d5344523fb"},{"in":"query","name":"type","schema":{"type":"string"},"description":"The type of access item for the identity. If not provided, it defaults to account","example":"account"}],"responses":{"200":{"description":"The list of access items.","content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"accessType":{"type":"string","example":"accessProfile","description":"the access item type. accessProfile in this case"},"id":{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"},"name":{"type":"string","example":"sample","description":"the access profile name"},"sourceName":{"type":"string","example":"DataScienceDataset","description":"the name of the source"},"sourceId":{"type":"string","example":"2793o32dwd","description":"the id of the source"},"description":{"type":"string","example":"AccessProfile - Workday/Citizenship access","description":"the description for the access profile"},"displayName":{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"},"entitlementCount":{"type":"string","example":12,"description":"the number of entitlements the access profile will create"},"appDisplayName":{"type":"string","example":"AppName","description":"the name of app"}}},{"type":"object","properties":{"accessType":{"type":"string","example":"account","description":"the access item type. account in this case"},"id":{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"},"nativeIdentity":{"type":"string","example":"dr.arden.ogahn.d","description":"the native identifier used to uniquely identify an acccount"},"sourceName":{"type":"string","example":"DataScienceDataset","description":"the name of the source"},"sourceId":{"type":"string","example":"2793o32dwd","description":"the id of the source"},"entitlementCount":{"type":"string","example":12,"description":"the number of entitlements the account will create"},"displayName":{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"}}},{"type":"object","properties":{"accessType":{"type":"string","example":"app","description":"the access item type. entitlement in this case"},"id":{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"},"displayName":{"type":"string","example":"Display Name","description":"the access profile display name"},"sourceName":{"type":"string","example":"appName","description":"the associated source name if it exists"}}},{"type":"object","properties":{"accessType":{"type":"string","example":"entitlement","description":"the access item type. entitlement in this case"},"id":{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"},"attribute":{"type":"string","example":"groups","description":"the entitlement attribute"},"value":{"type":"string","example":"Upward mobility access","description":"the associated value"},"entitlementType":{"type":"string","example":"entitlement","description":"the type of entitlement"},"sourceName":{"type":"string","example":"DataScienceDataset","description":"the name of the source"},"sourceId":{"type":"string","example":"2793o32dwd","description":"the id of the source"},"description":{"type":"string","example":"Entitlement - Workday/Citizenship access","description":"the description for the entitlment"},"displayName":{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"}}},{"type":"object","properties":{"accessType":{"type":"string","example":"role","description":"the access item type. role in this case"},"id":{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"},"displayName":{"type":"string","example":"sample","description":"the role display name"},"description":{"type":"string","example":"Role - Workday/Citizenship access","description":"the description for the role"},"sourceName":{"type":"string","example":"Source Name","description":"the associated source name if it exists"}}}]}},"examples":{"Access Profile":{"description":"An access profile response","value":[{"accessType":"accessProfile","id":"2c918087763e69d901763e72e97f006f","name":"sample","sourceName":"DataScienceDataset","sourceId":"2793o32dwd","description":"AccessProfile - Workday/Citizenship access","displayName":"Dr. Arden Rogahn MD","entitlementCount":12,"appDisplayName":"AppName"}]},"Account":{"description":"An account response","value":[{"accessType":"account","id":"2c918087763e69d901763e72e97f006f","nativeIdentity":"dr.arden.ogahn.d","sourceName":"DataScienceDataset","sourceId":"2793o32dwd","entitlementCount":12,"displayName":"Dr. Arden Rogahn MD"}]},"App":{"description":"An app response","value":[{"accessType":"app","id":"2c918087763e69d901763e72e97f006f","name":"appName"}]},"Entitlement":{"description":"An entitlement event","value":[{"accessType":"entitlement","id":"2c918087763e69d901763e72e97f006f","attribute":"groups","value":"Upward mobility access","type":"group","sourceName":"DataScienceDataset","sourceId":"2793o32dwd","description":"Entitlement - Workday/Citizenship access","displayName":"Dr. Arden Rogahn MD"}]},"Role":{"description":"A role response","value":[{"accessType":"role","id":"2c918087763e69d901763e72e97f006f","name":"sample","description":"Role - Workday/Citizenship access"}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/historical-identities/{id}/access-items","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Gets a list of access items for the identity filtered by item type","description":{"content":"This method retrieves a list of access item for the identity filtered by the access item type Requires authorization scope of 'idn:identity-history:read' ","type":"text/plain"},"url":{"path":["historical-identities",":id","access-items"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The type of access item for the identity. If not provided, it defaults to account","type":"text/plain"},"key":"type","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identity id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Gets a list of access items for the identity filtered by item type' (list-identity-access-items)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Gets a list of access items for the identity filtered by item type + + + +This method retrieves a list of access item for the identity filtered by the access item type Requires authorization scope of 'idn:identity-history:read' + +
Path Parameters
Query Parameters
+ +The list of access items. + +
Schema array
    oneOf
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-identity-profiles.api.mdx b/products/idn/api/beta/list-identity-profiles.api.mdx new file mode 100644 index 000000000..c89ea893a --- /dev/null +++ b/products/idn/api/beta/list-identity-profiles.api.mdx @@ -0,0 +1,92 @@ +--- +id: list-identity-profiles +sidebar_label: Identity Profiles list +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listIdentityProfiles","tags":["Identity Profiles"],"description":"This returns a list of Identity Profiles based on the specified query parameters.\nA token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, ne*\n\n**name**: *eq, ne*\n\n**priority**: *eq, ne*","example":"id eq 8c190e6787aa4ed9a90bd9d5344523fb"},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **id**, **name**, **priority**","example":"name,-priority"}],"responses":{"200":{"description":"List of identityProfiles.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"},"modified":{"description":"Last modification date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}},{"type":"object","required":["authoritativeSource"],"properties":{"description":{"type":"string","nullable":true,"description":"The description of the Identity Profile.","example":"My custom flat file profile"},"owner":{"type":"object","description":"The owner of the Identity Profile.","nullable":true,"properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Type of the object to which this reference applies","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"priority":{"type":"integer","format":"int64","description":"The priority for an Identity Profile.","example":10},"authoritativeSource":{"type":"object","properties":{"type":{"type":"string","enum":["SOURCE"],"description":"Type of the object to which this reference applies","example":"SOURCE"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"HR Active Directory"}},"description":"The authoritative source for this Identity Profile."},"identityRefreshRequired":{"type":"boolean","default":false,"description":"True if a identity refresh is needed. Typically triggered when a change on the source has been made","example":true},"identityCount":{"type":"integer","description":"The number of identities that belong to the Identity Profile.","format":"int32","example":8},"identityAttributeConfig":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If the profile or mapping is enabled","example":true,"default":true},"attributeTransforms":{"type":"array","items":{"type":"object","properties":{"identityAttributeName":{"type":"string","description":"Name of the identity attribute","example":"email"},"transformDefinition":{"description":"The seaspray transformation definition","type":"object","properties":{"type":{"type":"string","description":"The type of the transform definition.","example":"accountAttribute"},"attributes":{"type":"object","nullable":true,"additionalProperties":true,"description":"Arbitrary key-value pairs to store any metadata for the object","example":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}}}}}}}}},"identityExceptionReportReference":{"type":"object","nullable":true,"properties":{"taskResultId":{"type":"string","format":"uuid","description":"The id of the task result","example":"2c918086795cd09201795d5f7d7533df"},"reportName":{"type":"string","example":"My annual report","description":"The name of the report"}}},"hasTimeBasedAttr":{"description":"Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile.","type":"boolean","default":true,"example":true}}}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:identity-profile:read","idn:identity-profile:manage"]}],"method":"get","path":"/identity-profiles","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Identity Profiles list","description":{"content":"This returns a list of Identity Profiles based on the specified query parameters.\nA token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles.","type":"text/plain"},"url":{"path":["identity-profiles"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, ne*\n\n**name**: *eq, ne*\n\n**priority**: *eq, ne*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **id**, **name**, **priority**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Identity Profiles list' (list-identity-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Identity Profiles list + + + +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. + +
Query Parameters
+ +List of identityProfiles. + +
Schema array
    owner object
    + +The owner of the Identity Profile. + +
    authoritativeSource object
    + +The authoritative source for this Identity Profile. + +
    identityAttributeConfig object
    attributeTransforms object[]
    transformDefinition object
    + +The seaspray transformation definition + +
    attributes object
    + +Arbitrary key-value pairs to store any metadata for the object + +
    identityExceptionReportReference object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-identity-snapshot-access-items.api.mdx b/products/idn/api/beta/list-identity-snapshot-access-items.api.mdx new file mode 100644 index 000000000..8b62a8cfe --- /dev/null +++ b/products/idn/api/beta/list-identity-snapshot-access-items.api.mdx @@ -0,0 +1,83 @@ +--- +id: list-identity-snapshot-access-items +sidebar_label: Gets the list of identity access items at a given date filterd by item type +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listIdentitySnapshotAccessItems","tags":["Identity History"],"description":"This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of 'idn:identity-history:read' ","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity id","example":"8c190e6787aa4ed9a90bd9d5344523fb"},{"in":"path","name":"date","schema":{"type":"string"},"required":true,"description":"The specified date","example":"2007-03-01T13:00:00Z"},{"in":"query","name":"type","schema":{"type":"string"},"description":"The access item type","example":"account"}],"responses":{"200":{"description":"The identity object.","content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"accessType":{"type":"string","example":"accessProfile","description":"the access item type. accessProfile in this case"},"id":{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"},"name":{"type":"string","example":"sample","description":"the access profile name"},"sourceName":{"type":"string","example":"DataScienceDataset","description":"the name of the source"},"sourceId":{"type":"string","example":"2793o32dwd","description":"the id of the source"},"description":{"type":"string","example":"AccessProfile - Workday/Citizenship access","description":"the description for the access profile"},"displayName":{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"},"entitlementCount":{"type":"string","example":12,"description":"the number of entitlements the access profile will create"},"appDisplayName":{"type":"string","example":"AppName","description":"the name of app"}}},{"type":"object","properties":{"accessType":{"type":"string","example":"account","description":"the access item type. account in this case"},"id":{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"},"nativeIdentity":{"type":"string","example":"dr.arden.ogahn.d","description":"the native identifier used to uniquely identify an acccount"},"sourceName":{"type":"string","example":"DataScienceDataset","description":"the name of the source"},"sourceId":{"type":"string","example":"2793o32dwd","description":"the id of the source"},"entitlementCount":{"type":"string","example":12,"description":"the number of entitlements the account will create"},"displayName":{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"}}},{"type":"object","properties":{"accessType":{"type":"string","example":"app","description":"the access item type. entitlement in this case"},"id":{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"},"displayName":{"type":"string","example":"Display Name","description":"the access profile display name"},"sourceName":{"type":"string","example":"appName","description":"the associated source name if it exists"}}},{"type":"object","properties":{"accessType":{"type":"string","example":"entitlement","description":"the access item type. entitlement in this case"},"id":{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"},"attribute":{"type":"string","example":"groups","description":"the entitlement attribute"},"value":{"type":"string","example":"Upward mobility access","description":"the associated value"},"entitlementType":{"type":"string","example":"entitlement","description":"the type of entitlement"},"sourceName":{"type":"string","example":"DataScienceDataset","description":"the name of the source"},"sourceId":{"type":"string","example":"2793o32dwd","description":"the id of the source"},"description":{"type":"string","example":"Entitlement - Workday/Citizenship access","description":"the description for the entitlment"},"displayName":{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"}}},{"type":"object","properties":{"accessType":{"type":"string","example":"role","description":"the access item type. role in this case"},"id":{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"},"displayName":{"type":"string","example":"sample","description":"the role display name"},"description":{"type":"string","example":"Role - Workday/Citizenship access","description":"the description for the role"},"sourceName":{"type":"string","example":"Source Name","description":"the associated source name if it exists"}}}]}},"examples":{"Access Item AccessProfile Response":{"description":"An access profile response","value":[{"type":"accessProfile","id":"2c918087763e69d901763e72e97f006f","name":"sample","sourceName":"DataScienceDataset","sourceId":"2793o32dwd","description":"AccessProfile - Workday/Citizenship access","displayName":"Dr. Arden Rogahn MD","entitlementCount":12,"appDisplayName":"AppName"}]},"Access Item Account Response":{"description":"An account response","value":[{"type":"account","id":"2c918087763e69d901763e72e97f006f","nativeIdentity":"dr.arden.ogahn.d","sourceName":"DataScienceDataset","sourceId":"2793o32dwd","entitlementCount":12,"displayName":"Dr. Arden Rogahn MD"}]},"Access Item App Response":{"description":"An app response","value":[{"type":"app","id":"2c918087763e69d901763e72e97f006f","name":"appName"}]},"Access Item Entitlement Response":{"description":"An entitlement event","value":[{"type":"entitlement","id":"2c918087763e69d901763e72e97f006f","attribute":"groups","value":"Upward mobility access","entitlementType":"entitlement","sourceName":"DataScienceDataset","sourceId":"2793o32dwd","description":"Entitlement - Workday/Citizenship access","displayName":"Dr. Arden Rogahn MD"}]},"Access Item Role Response":{"description":"A role response","value":[{"type":"role","id":"2c918087763e69d901763e72e97f006f","name":"sample","description":"Role - Workday/Citizenship access"}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/historical-identities/{id}/snapshots/{date}/access-items","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Gets the list of identity access items at a given date filterd by item type","description":{"content":"This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of 'idn:identity-history:read' ","type":"text/plain"},"url":{"path":["historical-identities",":id","snapshots",":date","access-items"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The access item type","type":"text/plain"},"key":"type","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identity id","type":"text/plain"},"type":"any","value":"","key":"id"},{"disabled":false,"description":{"content":"(Required) The specified date","type":"text/plain"},"type":"any","value":"","key":"date"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Gets the list of identity access items at a given date filterd by item type' (list-identity-snapshot-access-items)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Gets the list of identity access items at a given date filterd by item type + + + +This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of 'idn:identity-history:read' + +
Path Parameters
Query Parameters
+ +The identity object. + +
Schema array
    oneOf
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-identity-snapshots.api.mdx b/products/idn/api/beta/list-identity-snapshots.api.mdx new file mode 100644 index 000000000..c2edef9d7 --- /dev/null +++ b/products/idn/api/beta/list-identity-snapshots.api.mdx @@ -0,0 +1,83 @@ +--- +id: list-identity-snapshots +sidebar_label: Lists all the snapshots for the identity +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listIdentitySnapshots","tags":["Identity History"],"description":"This method retrieves all the snapshots for the identity Requires authorization scope of 'idn:identity-history:read' ","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity id","example":"8c190e6787aa4ed9a90bd9d5344523fb"},{"in":"query","name":"start","schema":{"type":"string"},"description":"The specified start date","example":"2007-03-01T13:00:00Z"},{"in":"query","name":"interval","schema":{"type":"string","enum":["day","month"]},"description":"The interval indicating the range in day or month for the specified interval-name"},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"A list of identity summary for each snapshot.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"snapshot":{"type":"string","description":"the date when the identity record was created","example":"2007-03-01T13:00:00.000Z"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/historical-identities/{id}/snapshots","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Lists all the snapshots for the identity","description":{"content":"This method retrieves all the snapshots for the identity Requires authorization scope of 'idn:identity-history:read' ","type":"text/plain"},"url":{"path":["historical-identities",":id","snapshots"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The specified start date","type":"text/plain"},"key":"start","value":""},{"disabled":false,"description":{"content":"The interval indicating the range in day or month for the specified interval-name","type":"text/plain"},"key":"interval","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identity id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Lists all the snapshots for the identity' (list-identity-snapshots)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Lists all the snapshots for the identity + + + +This method retrieves all the snapshots for the identity Requires authorization scope of 'idn:identity-history:read' + +
Path Parameters
Query Parameters
+ +A list of identity summary for each snapshot. + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-lifecycle-states.api.mdx b/products/idn/api/beta/list-lifecycle-states.api.mdx new file mode 100644 index 000000000..fc52fccae --- /dev/null +++ b/products/idn/api/beta/list-lifecycle-states.api.mdx @@ -0,0 +1,78 @@ +--- +id: list-lifecycle-states +sidebar_label: Lifecycle State +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listLifecycleStates","tags":["Lifecycle States"],"description":"This endpoint returns a lifecycle state.\n\nA token with ORG_ADMIN or API authority is required to call this API.\n","parameters":[{"in":"path","name":"identity-profile-id","description":"Identity Profile ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"lifecycle-state-id","description":"Lifecycle State ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"lifecycle-state","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"2c9180835d2e5168015d32f890ca1581","description":"lifecycle stat id."},"name":{"type":"string","readOnly":true,"example":"Lifecycle Name","description":"Lifecycle-state name."},"technicalName":{"type":"string","readOnly":true,"example":"lifecycleTechnicalName","description":"The technical name for lifecycle state. This is for internal use."},"description":{"type":"string","example":"LifecycleDescription","description":"Lifecycle state description."},"created":{"type":"string","readOnly":true,"format":"date-time","example":"2015-05-28T14:07:17Z","description":"Lifecycle state created date."},"modified":{"type":"string","readOnly":true,"format":"date-time","example":"2015-05-28T14:07:17Z","description":"Lifecycle state modified date."},"enabled":{"type":"boolean","example":true,"description":"Whether the lifecycle state is enabled or disabled."},"identityCount":{"type":"integer","format":"int32","readOnly":true,"example":12,"description":"Number of identities that have the lifecycle state."},"emailNotificationOption":{"type":"object","properties":{"notifyManagers":{"type":"boolean","example":true,"description":"If true, then the manager is notified of the lifecycle state change."},"notifyAllAdmins":{"type":"boolean","example":true,"description":"If true, then all the admins are notified of the lifecycle state change."},"notifySpecificUsers":{"type":"boolean","example":true,"description":"If true, then the users specified in \"emailAddressList\" below are notified of lifecycle state change."},"emailAddressList":{"type":"array","example":["test@test.com","test2@test.com"],"items":{"type":"string"},"description":"List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change."}}},"accountActions":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"ENABLE","description":"Describes if action will be enabled or disabled","enum":["ENABLE","DISABLE"]},"sourceIds":{"type":"array","items":{"example":"2c918084660f45d6016617daa9210584","description":"Source Id","type":"string"},"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"],"description":"List of source IDs. The sources must have the ENABLE feature or flat file source. See \"/sources\" endpoint for source features."}}}},"accessProfileIds":{"type":"array","items":{"type":"string"},"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"],"description":"List of access-profile IDs that are associated with the lifecycle state."}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Lifecycle State","description":{"content":"This endpoint returns a lifecycle state.\n\nA token with ORG_ADMIN or API authority is required to call this API.\n","type":"text/plain"},"url":{"path":["identity-profiles",":identity-profile-id","lifecycle-states",":lifecycle-state-id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Identity Profile ID","type":"text/plain"},"type":"any","value":"","key":"identity-profile-id"},{"disabled":false,"description":{"content":"(Required) Lifecycle State ID","type":"text/plain"},"type":"any","value":"","key":"lifecycle-state-id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Lifecycle State' (list-lifecycle-states)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Lifecycle State + + + +This endpoint returns a lifecycle state. + +A token with ORG_ADMIN or API authority is required to call this API. + + +
Path Parameters
+ +lifecycle-state + +
Schema
    emailNotificationOption object
    accountActions object[]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-non-employee-approval.api.mdx b/products/idn/api/beta/list-non-employee-approval.api.mdx new file mode 100644 index 000000000..5506c51ed --- /dev/null +++ b/products/idn/api/beta/list-non-employee-approval.api.mdx @@ -0,0 +1,79 @@ +--- +id: list-non-employee-approval +sidebar_label: Get List of Non-Employee Approval Requests +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listNonEmployeeApproval","security":[{"oauth2":["idn:nelm:read"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This gets a list of non-employee approval requests.","parameters":[{"in":"query","example":"ac10d20a-841e-1e7d-8184-32d2e22c0179","name":"requested-for","schema":{"type":"string"},"description":"The identity for whom the request was made. *me* indicates the current user.","required":false},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","example":"filters=approvalStatus eq 'PENDING'","name":"filters","schema":{"type":"string"},"description":"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: **approvalStatus**: *eq* *Example:* approvalStatus eq \"PENDING\""},{"in":"query","example":"sorters=-created","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified**"}],"responses":{"200":{"description":"List of approval items.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee approval item id","example":"2c1e388b-1e55-4b0a-ab5c-897f1204159c"},"approver":{"description":"Reference to the associated Identity","type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}},"accountName":{"type":"string","description":"Requested identity account name","example":"test.account"},"approvalStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status"},"approvalOrder":{"type":"number","description":"Approval order","example":1},"comment":{"type":"string","description":"comment of approver"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}},{"type":"object","properties":{"nonEmployeeRequest":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee request id."},"requester":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}},"example":{"type":"IDENTITY","id":"2c9180866166b5b0016167c32ef31a66","name":"William Smith"}}}}}}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-approvals","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get List of Non-Employee Approval Requests","description":{"content":"This gets a list of non-employee approval requests.","type":"text/plain"},"url":{"path":["non-employee-approvals"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The identity for whom the request was made. *me* indicates the current user.","type":"text/plain"},"key":"requested-for","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"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: **approvalStatus**: *eq* *Example:* approvalStatus eq \"PENDING\"","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get List of Non-Employee Approval Requests' (list-non-employee-approval)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get List of Non-Employee Approval Requests + + + +This gets a list of non-employee approval requests. + +
Query Parameters
+ +List of approval items. + +
Schema array
    approver object
    + +Reference to the associated Identity + +
    nonEmployeeRequest object
    requester object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-non-employee-records.api.mdx b/products/idn/api/beta/list-non-employee-records.api.mdx new file mode 100644 index 000000000..f06ce4fc2 --- /dev/null +++ b/products/idn/api/beta/list-non-employee-records.api.mdx @@ -0,0 +1,79 @@ +--- +id: list-non-employee-records +sidebar_label: List Non-Employee Records +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listNonEmployeeRecords","security":[{"oauth2":["idn:nelm:read"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This gets a list of non-employee records.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","required":false,"name":"sorters","schema":{"type":"string","format":"comma-separated"},"example":"accountName,sourceId","description":"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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified**"},{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"example":"sourceId eq \"2c91808568c529c60168cca6f90c1313\"","description":"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: **sourceId**: *eq* *Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\""}],"responses":{"200":{"description":"Non-Employee record objects","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee record id."},"accountName":{"type":"string","description":"Requested identity account name."},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"sourceId":{"type":"string","description":"Non-Employee's source id.","example":"2c91808568c529c60168cca6f90c1313"},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee."},"startDate":{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2019-08-23T18:52:59.162Z"},"endDate":{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2020-08-23T18:52:59.162Z"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-records","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Non-Employee Records","description":{"content":"This gets a list of non-employee records.","type":"text/plain"},"url":{"path":["non-employee-records"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified**","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"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: **sourceId**: *eq* *Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\"","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Non-Employee Records' (list-non-employee-records)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Non-Employee Records + + + +This gets a list of non-employee records. + +
Query Parameters
+ +Non-Employee record objects + +
Schema array
    data object
    + +Attribute blob/bag for a non-employee. + +
  • property name* string
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-non-employee-requests.api.mdx b/products/idn/api/beta/list-non-employee-requests.api.mdx new file mode 100644 index 000000000..1971aeefd --- /dev/null +++ b/products/idn/api/beta/list-non-employee-requests.api.mdx @@ -0,0 +1,87 @@ +--- +id: list-non-employee-requests +sidebar_label: List Non-Employee Requests +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listNonEmployeeRequests","security":[{"oauth2":["idn:nelm:read"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This gets a list of non-employee requests.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"requested-for","required":true,"schema":{"type":"string"},"example":"me","description":"The identity for whom the request was made. *me* indicates the current user."},{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"example":"approvalStatus,firstName","description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate**"},{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"example":"sourceId eq \"2c91808568c529c60168cca6f90c1313\"","description":"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: **sourceId**: *eq* *Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\""}],"responses":{"200":{"description":"List of non-employee request objects.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"},"sourceId":{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"},"description":{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}},{"type":"object","properties":{"accountName":{"type":"string","description":"Requested identity account name.","example":"william.smith"},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"nonEmployeeSource":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"},"sourceId":{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"},"description":{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee."},"approvalItems":{"description":"List of approval item for the request","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee approval item id","example":"2c1e388b-1e55-4b0a-ab5c-897f1204159c"},"approver":{"description":"Reference to the associated Identity","type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}},"accountName":{"type":"string","description":"Requested identity account name","example":"test.account"},"approvalStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status"},"approvalOrder":{"type":"number","description":"Approval order","example":1},"comment":{"type":"string","description":"comment of approver"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}}},"approvalStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status"},"comment":{"type":"string","description":"comment of requester"},"completionDate":{"type":"string","format":"date-time","description":"When the request was completely approved.","example":"2020-03-24T11:11:41.139-05:00"},"startDate":{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2020-03-24T00:00:00-05:00"},"endDate":{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2021-03-25T00:00:00-05:00"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2020-03-24T11:11:41.139-05:00"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2020-03-24T11:11:41.139-05:00"}}}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-requests","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Non-Employee Requests","description":{"content":"This gets a list of non-employee requests.","type":"text/plain"},"url":{"path":["non-employee-requests"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"(Required) The identity for whom the request was made. *me* indicates the current user.","type":"text/plain"},"key":"requested-for","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate**","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"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: **sourceId**: *eq* *Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\"","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Non-Employee Requests' (list-non-employee-requests)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Non-Employee Requests + + + +This gets a list of non-employee requests. + +
Query Parameters
+ +List of non-employee request objects. + +
Schema array
    nonEmployeeSource object
    data object
    + +Attribute blob/bag for a non-employee. + +
  • property name* string
    • approvalItems object[]
    + +List of approval item for the request + +
    approver object
    + +Reference to the associated Identity + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-non-employee-sources.api.mdx b/products/idn/api/beta/list-non-employee-sources.api.mdx new file mode 100644 index 000000000..c0cf47efb --- /dev/null +++ b/products/idn/api/beta/list-non-employee-sources.api.mdx @@ -0,0 +1,83 @@ +--- +id: list-non-employee-sources +sidebar_label: List Non-Employee Sources +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listNonEmployeeSources","security":[{"oauth2":["idn:nelm:read"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This gets a list of non-employee sources.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","required":true,"name":"requested-for","example":"me","schema":{"type":"string"},"description":"The identity for whom the request was made. *me* indicates the current user."},{"in":"query","required":true,"name":"non-employee-count","example":false,"schema":{"type":"boolean"},"description":"The flag to determine whether return a non-employee count associate with source."},{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"example":"name,created","description":"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**"}],"responses":{"200":{"description":"List of non-employee sources objects.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"},"sourceId":{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"},"description":{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}},{"type":"object","properties":{"approvers":{"description":"List of approvers","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}}},"accountManagers":{"description":"List of account managers","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}}},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"},"nonEmployeeCount":{"nullable":true,"type":"integer","description":"The number of non-employee records on all sources that *requested-for* user manages.","example":2,"format":"int32"}}}]},{"type":"object","properties":{"nonEmployeeCount":{"type":"integer","example":2,"format":"int32","description":"Number of non-employee records associated with this source."}}}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-sources","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Non-Employee Sources","description":{"content":"This gets a list of non-employee sources.","type":"text/plain"},"url":{"path":["non-employee-sources"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"(Required) The identity for whom the request was made. *me* indicates the current user.","type":"text/plain"},"key":"requested-for","value":""},{"disabled":false,"description":{"content":"(Required) The flag to determine whether return a non-employee count associate with source.","type":"text/plain"},"key":"non-employee-count","value":""},{"disabled":false,"description":{"content":"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**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Non-Employee Sources' (list-non-employee-sources)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Non-Employee Sources + + + +This gets a list of non-employee sources. + +
Query Parameters
+ +List of non-employee sources objects. + +
Schema array
    approvers object[]
    + +List of approvers + +
    accountManagers object[]
    + +List of account managers + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-notification-template-defaults.api.mdx b/products/idn/api/beta/list-notification-template-defaults.api.mdx new file mode 100644 index 000000000..d34f1b4e4 --- /dev/null +++ b/products/idn/api/beta/list-notification-template-defaults.api.mdx @@ -0,0 +1,75 @@ +--- +id: list-notification-template-defaults +sidebar_label: List Notification Template Defaults +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listNotificationTemplateDefaults","tags":["Notifications"],"description":"This lists the default templates used for notifications, such as emails from IdentityNow. Since this is a beta feature, it doesn't include all the templates.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**key**: *eq, in*\n\n**medium**: *eq*\n\n**locale**: *eq*"}],"responses":{"200":{"description":"A list of the default template objects","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"cloud_manual_work_item_summary"},"name":{"type":"string","example":"Task Manager Subscription"},"medium":{"type":"string","description":"The message medium. More mediums may be added in the future.","enum":["EMAIL","PHONE","SMS","SLACK","TEAMS"],"example":"EMAIL"},"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en"},"subject":{"type":"string","example":"You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}."},"header":{"type":"string","example":"Dear $__recipient.name,"},"body":{"type":"string","example":"Please go to the task manager"},"footer":{"type":"string","example":"Thanks, The $__global.productName Team"},"from":{"type":"string","example":"$__global.emailFromAddress"},"replyTo":{"type":"string","example":"$__global.emailFromAddress"},"description":{"type":"string","example":"Daily digest - sent if number of outstanding tasks for task owner > 0"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/notification-template-defaults","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Notification Template Defaults","description":{"content":"This lists the default templates used for notifications, such as emails from IdentityNow. Since this is a beta feature, it doesn't include all the templates.","type":"text/plain"},"url":{"path":["notification-template-defaults"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**key**: *eq, in*\n\n**medium**: *eq*\n\n**locale**: *eq*","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Notification Template Defaults' (list-notification-template-defaults)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Notification Template Defaults + + + +This lists the default templates used for notifications, such as emails from IdentityNow. Since this is a beta feature, it doesn't include all the templates. + +
Query Parameters
+ +A list of the default template objects + +
Schema array
 0\"\n }\n]"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-notification-templates.api.mdx b/products/idn/api/beta/list-notification-templates.api.mdx new file mode 100644 index 000000000..a5f2b202b --- /dev/null +++ b/products/idn/api/beta/list-notification-templates.api.mdx @@ -0,0 +1,75 @@ +--- +id: list-notification-templates +sidebar_label: List Notification Templates +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listNotificationTemplates","tags":["Notifications"],"description":"This lists the templates that you have modified for your site. Since this is a beta feature, it doesn't include all your modified templates.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**key**: *eq, in*\n\n**medium**: *eq*\n\n**locale**: *eq*","example":"medium eq \"EMAIL\""}],"responses":{"200":{"description":"A list of template objects for your site","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"cloud_manual_work_item_summary"},"name":{"type":"string","example":"Task Manager Subscription"},"medium":{"type":"string","description":"The message medium. More mediums may be added in the future.","enum":["EMAIL","PHONE","SMS","SLACK","TEAMS"],"example":"EMAIL"},"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en"},"subject":{"type":"string","example":"You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}."},"header":{"type":"string","example":"Dear $__recipient.name,"},"body":{"type":"string","example":"Please go to the task manager"},"footer":{"type":"string","example":"Thanks, The $__global.productName Team"},"from":{"type":"string","example":"$__global.emailFromAddress"},"replyTo":{"type":"string","example":"$__global.emailFromAddress"},"description":{"type":"string","example":"Daily digest - sent if number of outstanding tasks for task owner > 0"},"id":{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b","description":"This is auto-generated."},"created":{"type":"string","format":"date-time","description":"The time when this template is created. This is auto-generated.","example":"2020-01-01T00:00:00.000000Z"},"modified":{"type":"string","format":"date-time","description":"The time when this template was last modified. This is auto-generated.","example":"2020-01-01T00:00:00.000000Z"}},"required":["key","medium","locale"]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/notification-templates","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Notification Templates","description":{"content":"This lists the templates that you have modified for your site. Since this is a beta feature, it doesn't include all your modified templates.","type":"text/plain"},"url":{"path":["notification-templates"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**key**: *eq, in*\n\n**medium**: *eq*\n\n**locale**: *eq*","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Notification Templates' (list-notification-templates)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Notification Templates + + + +This lists the templates that you have modified for your site. Since this is a beta feature, it doesn't include all your modified templates. + +
Query Parameters
+ +A list of template objects for your site + +
Schema array
 0\",\n \"id\": \"c17bea3a-574d-453c-9e04-4365fbf5af0b\",\n \"created\": \"2020-01-01T00:00:00.000000Z\",\n \"modified\": \"2020-01-01T00:00:00.000000Z\"\n }\n]"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-oauth-clients.api.mdx b/products/idn/api/beta/list-oauth-clients.api.mdx new file mode 100644 index 000000000..ca607b4e5 --- /dev/null +++ b/products/idn/api/beta/list-oauth-clients.api.mdx @@ -0,0 +1,75 @@ +--- +id: list-oauth-clients +sidebar_label: List OAuth Clients +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listOauthClients","security":[{"oauth2":["sp:oauth-client:manage"]}],"tags":["OAuth Clients"],"description":"This gets a list of OAuth clients.","parameters":[{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**lastUsed**: *le, isnull*","example":"lastUsed le 2023-02-05T10:59:27.214Z"}],"responses":{"200":{"description":"List of OAuth clients.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the OAuth client","example":"2c9180835d2e5168015d32f890ca1581"},"businessName":{"type":"string","nullable":true,"description":"The name of the business the API Client should belong to","example":"Acme-Solar"},"homepageUrl":{"type":"string","nullable":true,"description":"The homepage URL associated with the owner of the API Client","example":"http://localhost:12345"},"name":{"type":"string","description":"A human-readable name for the API Client","example":"Demo API Client"},"description":{"type":"string","nullable":true,"description":"A description of the API Client","example":"An API client used for the authorization_code, refresh_token, and client_credentials flows"},"accessTokenValiditySeconds":{"type":"integer","format":"int32","description":"The number of seconds an access token generated for this API Client is valid for","example":750},"refreshTokenValiditySeconds":{"type":"integer","format":"int32","description":"The number of seconds a refresh token generated for this API Client is valid for","example":86400},"redirectUris":{"type":"array","nullable":true,"items":{"type":"string"},"description":"A list of the approved redirect URIs used with the authorization_code flow","example":["http://localhost:12345"]},"grantTypes":{"type":"array","items":{"description":"OAuth2 Grant Type","type":"string","example":"CLIENT_CREDENTIALS","enum":["CLIENT_CREDENTIALS","AUTHORIZATION_CODE","REFRESH_TOKEN"]},"description":"A list of OAuth 2.0 grant types this API Client can be used with","example":["AUTHORIZATION_CODE","CLIENT_CREDENTIALS","REFRESH_TOKEN"]},"accessType":{"description":"The access type (online or offline) of this API Client","example":"OFFLINE","type":"string","enum":["ONLINE","OFFLINE"]},"type":{"description":"The type of the API Client (public or confidential)","example":"CONFIDENTIAL","type":"string","enum":["CONFIDENTIAL","PUBLIC"]},"internal":{"type":"boolean","description":"An indicator of whether the API Client can be used for requests internal to IDN","example":false},"enabled":{"type":"boolean","description":"An indicator of whether the API Client is enabled for use","example":true},"strongAuthSupported":{"type":"boolean","description":"An indicator of whether the API Client supports strong authentication","example":false},"claimsSupported":{"type":"boolean","description":"An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow","example":false},"created":{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when the API Client was created","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when the API Client was last updated","example":"2018-06-25T20:22:28.104Z"},"lastUsed":{"type":"string","nullable":true,"format":"date-time","description":"The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed.","example":"2017-07-11T18:45:37.098Z"},"scope":{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the API Client.","example":["demo:api-client-scope:first","demo:api-client-scope:second"]}},"required":["id","businessName","homepageUrl","name","description","accessTokenValiditySeconds","refreshTokenValiditySeconds","redirectUris","grantTypes","accessType","type","internal","enabled","strongAuthSupported","claimsSupported","created","modified","scope"]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/oauth-clients","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List OAuth Clients","description":{"content":"This gets a list of OAuth clients.","type":"text/plain"},"url":{"path":["oauth-clients"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**lastUsed**: *le, isnull*","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List OAuth Clients' (list-oauth-clients)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List OAuth Clients + + + +This gets a list of OAuth clients. + +
Query Parameters
+ +List of OAuth clients. + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-pending-approvals.api.mdx b/products/idn/api/beta/list-pending-approvals.api.mdx new file mode 100644 index 000000000..1bda0f183 --- /dev/null +++ b/products/idn/api/beta/list-pending-approvals.api.mdx @@ -0,0 +1,119 @@ +--- +id: list-pending-approvals +sidebar_label: Pending Access Request Approvals List +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listPendingApprovals","tags":["Access Request Approvals"],"description":"This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info.","parameters":[{"in":"query","name":"owner-id","schema":{"type":"string"},"description":"If present, the value returns only pending approvals for the specified identity.\n * ORG_ADMIN users can call this with any identity ID value.\n * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used.\n * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value.","required":false},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**requestedFor.id**: *eq, in*\n\n**modified**: *gt, lt, ge, le*"},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created, modified**"}],"responses":{"200":{"description":"List of Pending Approvals.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c9180835d2e5168015d32f890ca1581","description":"The approval id."},"name":{"type":"string","example":"Pending approval name","description":"The name of the approval."},"created":{"type":"string","format":"date-time","description":"When the approval was created.","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","description":"When the approval was modified last time.","example":"2018-07-25T20:22:28.104Z"},"requestCreated":{"type":"string","format":"date-time","description":"When the access-request was created.","example":"2017-07-11T18:45:35.098Z"},"requestType":{"type":"string","enum":["GRANT_ACCESS","REVOKE_ACCESS"],"description":"Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field.","example":"GRANT_ACCESS"},"requester":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The identity that requested the item."},"requestedFor":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The identity for whom the item is requested for."},"owner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The owner or approver of the approval."},"requestedObject":{"description":"The requested access item.","type":"object","properties":{"id":{"type":"string","example":"2c938083633d259901633d25c68c00fa","description":"Id of the object."},"name":{"type":"string","example":"Object Name","description":"Name of the object."},"description":{"type":"string","example":"Object Description","description":"Description of the object."},"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"Type of the object.","example":"ROLE"}}},"requesterComment":{"description":"The requester's comment.","type":"object","properties":{"comment":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat"},"author":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the author","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"}}},"created":{"type":"string","format":"date-time","description":"Date and time comment was created","example":"2017-07-11T18:45:37.098Z"}}},"previousReviewersComments":{"type":"array","items":{"type":"object","properties":{"comment":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat"},"author":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the author","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"}}},"created":{"type":"string","format":"date-time","description":"Date and time comment was created","example":"2017-07-11T18:45:37.098Z"}}},"description":"The history of the previous reviewers comments."},"forwardHistory":{"type":"array","items":{"type":"object","properties":{"oldApproverName":{"type":"string","description":"Display name of approver from whom the approval was forwarded.","example":"Frank Mir"},"newApproverName":{"type":"string","description":"Display name of approver to whom the approval was forwarded.","example":"Al Volta"},"comment":{"type":"string","nullable":true,"description":"Comment made while forwarding.","example":"Forwarding from Frank to Al"},"modified":{"type":"string","format":"date-time","description":"Time at which approval was forwarded.","example":"2019-08-23T18:52:57.398Z"},"forwarderName":{"type":"string","nullable":true,"description":"Display name of forwarder who forwarded the approval.","example":"William Wilson"},"reassignmentType":{"description":"The approval reassignment type. \n* MANUAL_REASSIGNMENT: An approval with this reassignment type has been specifically reassigned by the approval task's owner, from their queue to someone else's. \n* AUTOMATIC_REASSIGNMENT: An approval with this reassignment type has been automatically reassigned from another approver's queue, according to that approver's reassignment configuration. The approver's reassignment configuration may be set up to automatically reassign approval tasks for a defined (or possibly open-ended) period of time.\n* AUTO_ESCALATION: An approval with this reassignment type has been automatically reassigned from another approver's queue, according to the request's escalation configuration. For more information about escalation configuration, refer to [Setting Global Reminders and Escalation Policies](https://documentation.sailpoint.com/saas/help/requests/config_emails.html).\n* SELF_REVIEW_DELEGATION: An approval with this reassignment type has been automatically reassigned by the system to prevent self-review. This helps prevent situations like a requester being tasked with approving their own request. For more information about preventing self-review, refer to [Self-review Prevention](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html#self-review-prevention) and [Preventing Self-approval](https://documentation.sailpoint.com/saas/help/requests/config_ap_roles.html#preventing-self-approval).","example":"AUTOMATIC_REASSIGNMENT","type":"string","enum":["MANUAL_REASSIGNMENT","AUTOMATIC_REASSIGNMENT","AUTO_ESCALATION","SELF_REVIEW_DELEGATION"]}}},"description":"The history of approval forward action."},"commentRequiredWhenRejected":{"type":"boolean","example":true,"description":"When true the rejector has to provide comments when rejecting"},"actionInProcess":{"description":"Action that is performed on this approval, and system has not finished performing that action yet.","type":"string","enum":["APPROVED","REJECTED","FORWARDED"],"example":"APPROVED"},"removeDate":{"type":"string","description":"The date the role or access profile is no longer assigned to the specified identity.","format":"date-time","example":"2020-07-11T00:00:00Z"},"removeDateUpdateRequested":{"type":"boolean","example":true,"description":"If true, then the request is to change the remove date or sunset date."},"currentRemoveDate":{"type":"string","description":"The remove date or sunset date that was assigned at the time of the request.","format":"date-time","example":"2020-07-11T00:00:00Z"},"sodViolationContext":{"description":"The details of the SOD violations for the associated approval.","type":"object","properties":{"state":{"type":"string","enum":["SUCCESS","ERROR"],"description":"The status of SOD violation check","example":"SUCCESS"},"uuid":{"description":"The id of the Violation check event","type":"string","example":"f73d16e9-a038-46c5-b217-1246e15fdbdd"},"violationCheckResult":{"description":"The inner object representing the completed SOD Violation check","type":"object","properties":{"message":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}},"description":"If the request failed, includes any error message that was generated.","example":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An error has occurred during the SOD violation check"}]},"clientMetadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check.","example":{"requestedAppName":"test-app","requestedAppId":"2c91808f7892918f0178b78da4a305a1"}},"violationContexts":{"type":"array","items":{"description":"The contextual information of the violated criteria","type":"object","properties":{"policy":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Reference to the Policy that is being violated."},"conflictingAccessCriteria":{"type":"object","description":"The object which contains the left and right hand side of the entitlements that got violated according to the policy.","properties":{"leftCriteria":{"type":"object","properties":{"criteriaList":{"type":"array","items":{"description":"Details of the Entitlement criteria","type":"object","properties":{"existing":{"type":"boolean","example":true,"description":"If the entitlement already belonged to the user or not."},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Entitlement ID","example":"2c918085771e9d3301773b3cb66f6398"},"name":{"type":"string","description":"Entitlement name","example":"My HR Entitlement"}}}}}},"rightCriteria":{"type":"object","properties":{"criteriaList":{"type":"array","items":{"description":"Details of the Entitlement criteria","type":"object","properties":{"existing":{"type":"boolean","example":true,"description":"If the entitlement already belonged to the user or not."},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Entitlement ID","example":"2c918085771e9d3301773b3cb66f6398"},"name":{"type":"string","description":"Entitlement name","example":"My HR Entitlement"}}}}}}}}}}},"violatedPolicies":{"type":"array","description":"A list of the Policies that were violated","items":{"description":"Reference to the policy that was violated","example":[{"type":"SOD_POLICY","id":"69129440-422d-4a23-aadd-35c828d5bfda","name":"HR Policy"}],"type":"object","properties":{"id":{"type":"string","description":"the application ID","example":"ff8081814d977c21014da056804a0af3"},"name":{"type":"string","description":"the application name","example":"Github"}}}}}}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/access-request-approvals/pending","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Pending Access Request Approvals List","description":{"content":"This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info.","type":"text/plain"},"url":{"path":["access-request-approvals","pending"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If present, the value returns only pending approvals for the specified identity.\n * ORG_ADMIN users can call this with any identity ID value.\n * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used.\n * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value.","type":"text/plain"},"key":"owner-id","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**requestedFor.id**: *eq, in*\n\n**modified**: *gt, lt, ge, le*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created, modified**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Pending Access Request Approvals List' (list-pending-approvals)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Pending Access Request Approvals List + + + +This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. + +
Query Parameters
+ +List of Pending Approvals. + +
Schema array
    requester object
    + +The identity that requested the item. + +
    requestedFor object
    + +The identity for whom the item is requested for. + +
    owner object
    + +The owner or approver of the approval. + +
    requestedObject object
    + +The requested access item. + +
    requesterComment object
    + +The requester's comment. + +
    author object
    previousReviewersComments object[]
    + +The history of the previous reviewers comments. + +
    author object
    forwardHistory object[]
    + +The history of approval forward action. + +
    sodViolationContext object
    + +The details of the SOD violations for the associated approval. + +
    violationCheckResult object
    + +The inner object representing the completed SOD Violation check + +
    message object
    + +If the request failed, includes any error message that was generated. + +
    clientMetadata object
    + +Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. + +
  • property name* string
    • violationContexts object[]
    policy object
    + +Reference to the Policy that is being violated. + +
    conflictingAccessCriteria object
    + +The object which contains the left and right hand side of the entitlements that got violated according to the policy. + +
    leftCriteria object
    criteriaList object[]
    rightCriteria object
    criteriaList object[]
    violatedPolicies object[]
    + +A list of the Policies that were violated + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-personal-access-tokens.api.mdx b/products/idn/api/beta/list-personal-access-tokens.api.mdx new file mode 100644 index 000000000..417a6d4fe --- /dev/null +++ b/products/idn/api/beta/list-personal-access-tokens.api.mdx @@ -0,0 +1,79 @@ +--- +id: list-personal-access-tokens +sidebar_label: List Personal Access Tokens +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listPersonalAccessTokens","security":[{"oauth2":["sp:my-personal-access-tokens:read","sp:my-personal-access-tokens:manage","sp:all-personal-access-tokens:read","sp:all-personal-access-tokens:manage"]}],"tags":["Personal Access Tokens"],"description":"This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right.","parameters":[{"in":"query","name":"owner-id","description":"The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read'\nIf an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. \nIf the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read'","required":false,"schema":{"type":"string","default":null,"example":"2c9180867b50d088017b554662fb281e"}},{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**lastUsed**: *le, isnull*","example":"lastUsed le 2023-02-05T10:59:27.214Z"}],"responses":{"200":{"description":"List of personal access tokens.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the personal access token (to be used as the username for Basic Auth).","example":"86f1dc6fe8f54414950454cbb11278fa"},"name":{"type":"string","description":"The name of the personal access token. Cannot be the same as other personal access tokens owned by a user.","example":"NodeJS Integration"},"scope":{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the personal access token.","example":["demo:personal-access-token-scope:first","demo:personal-access-token-scope:second"]},"owner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Details about the owner of the personal access token."},"created":{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when this personal access token was created.","example":"2017-07-11T18:45:37.098Z"},"lastUsed":{"type":"string","nullable":true,"format":"date-time","description":"The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed.","example":"2017-07-11T18:45:37.098Z"}},"required":["id","name","scope","owner","created"]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/personal-access-tokens","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Personal Access Tokens","description":{"content":"This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right.","type":"text/plain"},"url":{"path":["personal-access-tokens"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read'\nIf an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. \nIf the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read'","type":"text/plain"},"key":"owner-id","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**lastUsed**: *le, isnull*","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Personal Access Tokens' (list-personal-access-tokens)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Personal Access Tokens + + + +This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. + +
Query Parameters
+ +List of personal access tokens. + +
Schema array
    owner object
    + +Details about the owner of the personal access token. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-provisioning-policies.api.mdx b/products/idn/api/beta/list-provisioning-policies.api.mdx new file mode 100644 index 000000000..4fcc59e79 --- /dev/null +++ b/products/idn/api/beta/list-provisioning-policies.api.mdx @@ -0,0 +1,88 @@ +--- +id: list-provisioning-policies +sidebar_label: Lists ProvisioningPolicies +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listProvisioningPolicies","tags":["Sources"],"description":"This end-point lists all the ProvisioningPolicies in IdentityNow.\nA token with API, or ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:provisioning-policy:read","idn:provisioning-policy:manage"]}],"parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source id","example":"2c9180835d191a86015d28455b4a2329"}],"responses":{"200":{"description":"List of ProvisioningPolicyDto objects","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"the provisioning policy name","example":"example provisioning policy for inactive identities"},"description":{"type":"string","description":"the description of the provisioning policy","example":"this provisioning policy creates access based on an identity going inactive"},"usageType":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"userName"},"transform":{"type":"object","description":"The transform to apply to the field","example":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"default":{}},"attributes":{"type":"object","description":"Attributes required for the transform","example":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"}},"isRequired":{"type":"boolean","readOnly":true,"description":"Flag indicating whether or not the attribute is required.","default":false,"example":false},"type":{"type":"string","description":"The type of the attribute.","example":"string"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","default":false,"example":false}}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sources/{sourceId}/provisioning-policies","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Lists ProvisioningPolicies","description":{"content":"This end-point lists all the ProvisioningPolicies in IdentityNow.\nA token with API, or ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":sourceId","provisioning-policies"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Lists ProvisioningPolicies' (list-provisioning-policies)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Lists ProvisioningPolicies + + + +This end-point lists all the ProvisioningPolicies in IdentityNow. +A token with API, or ORG_ADMIN authority is required to call this API. + +
Path Parameters
+ +List of ProvisioningPolicyDto objects + +
Schema array
    fields object[]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-reassignment-configurations.api.mdx b/products/idn/api/beta/list-reassignment-configurations.api.mdx new file mode 100644 index 000000000..c5836c52f --- /dev/null +++ b/products/idn/api/beta/list-reassignment-configurations.api.mdx @@ -0,0 +1,111 @@ +--- +id: list-reassignment-configurations +sidebar_label: List Reassignment Configurations +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listReassignmentConfigurations","tags":["Work Reassignment"],"description":"Gets all Reassignment configuration for the current org.","security":[{"oauth2":["idn:reassignment-configuration:read"]}],"responses":{"200":{"description":"A list of Reassignment Configurations for an org","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"The response body of a Reassignment Configuration for a single identity","properties":{"identity":{"type":"object","description":"The definition of an Identity according to the Reassignment Configuration service","properties":{"id":{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"},"name":{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}},"configDetails":{"type":"array","description":"Details of how work should be reassigned for an Identity","items":{"type":"object","description":"The request body of Reassignment Configuration Details for a specific identity and config type","properties":{"configType":{"type":"string","description":"Enum list of valid work types that can be selected for a Reassignment Configuration","enum":["ACCESS_REQUESTS","CERTIFICATIONS","MANUAL_TASKS"],"example":"ACCESS_REQUESTS"},"targetIdentity":{"type":"object","description":"The definition of an Identity according to the Reassignment Configuration service","properties":{"id":{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"},"name":{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}},"startDate":{"type":"string","description":"The date from which to start reassigning work items","format":"date-time","example":"2022-07-21T11:13:12.345Z"},"endDate":{"type":"string","description":"The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment.","format":"date-time","example":"0001-01-01T00:00:00Z"},"auditDetails":{"type":"object","description":"Audit details for the reassignment configuration of an identity","properties":{"created":{"type":"string","description":"Initial date and time when the record was created","format":"date-time","example":"2022-07-21T11:13:12.345Z"},"createdBy":{"type":"object","description":"The definition of an Identity according to the Reassignment Configuration service","properties":{"id":{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"},"name":{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}},"modified":{"type":"string","description":"Last modified date and time for the record","format":"date-time","example":"2022-07-21T11:13:12.345Z"},"modifiedBy":{"type":"object","description":"The definition of an Identity according to the Reassignment Configuration service","properties":{"id":{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"},"name":{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}}}}}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/reassignment-configurations","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Reassignment Configurations","description":{"content":"Gets all Reassignment configuration for the current org.","type":"text/plain"},"url":{"path":["reassignment-configurations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Reassignment Configurations' (list-reassignment-configurations)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Reassignment Configurations + + + +Gets all Reassignment configuration for the current org. + +
+ +A list of Reassignment Configurations for an org + +
Schema array
    identity object
    + +The definition of an Identity according to the Reassignment Configuration service + +
    configDetails object[]
    + +Details of how work should be reassigned for an Identity + +
    targetIdentity object
    + +The definition of an Identity according to the Reassignment Configuration service + +
    auditDetails object
    + +Audit details for the reassignment configuration of an identity + +
    createdBy object
    + +The definition of an Identity according to the Reassignment Configuration service + +
    modifiedBy object
    + +The definition of an Identity according to the Reassignment Configuration service + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-requestable-objects.api.mdx b/products/idn/api/beta/list-requestable-objects.api.mdx new file mode 100644 index 000000000..a912f8cfc --- /dev/null +++ b/products/idn/api/beta/list-requestable-objects.api.mdx @@ -0,0 +1,76 @@ +--- +id: list-requestable-objects +sidebar_label: Requestable Objects List +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listRequestableObjects","tags":["Requestable Objects"],"description":"This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param.\nAny authenticated token can call this endpoint to see their requestable access items. A token with ORG_ADMIN authority is required to call this endpoint to return a list of all of the requestable access items for the org or for another identity.","parameters":[{"in":"query","name":"identity-id","required":false,"schema":{"type":"string"},"example":"e7eab60924f64aa284175b9fa3309599","description":"If present, the value returns only requestable objects for the specified identity.\n * Admin users can call this with any identity ID value.\n * Non-admin users can only specify *me* or pass their own identity ID value.\n * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result."},{"in":"query","name":"types","description":"Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"Enum represented the currently supported requestable object types. Additional values may be added in the future without notice.","example":"ACCESS_PROFILE"}},"example":"ROLE,ACCESS_PROFILE","explode":false},{"in":"query","name":"term","required":false,"schema":{"type":"string"},"example":"Finance Role","description":"It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored."},{"in":"query","name":"statuses","description":"Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["AVAILABLE","PENDING","ASSIGNED"],"description":"Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results.","example":"AVAILABLE"}},"explode":false,"example":["ASSIGNED","PENDING"]},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"example":"name sw \"bob\"","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n","required":false},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"required":false,"example":"name","description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**\n"}],"responses":{"200":{"description":"List of requestable objects","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the requestable object itself","example":"2c9180835d2e5168015d32f890ca1581"},"name":{"type":"string","description":"Human-readable display name of the requestable object","example":"Applied Research Access"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z","description":"The time when the requestable object was created"},"modified":{"nullable":true,"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"The time when the requestable object was last modified"},"description":{"type":"string","description":"Description of the requestable object.","example":"Access to research information, lab results, and schematics."},"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"Enum represented the currently supported requestable object types. Additional values may be added in the future without notice.","example":"ACCESS_PROFILE"},"requestStatus":{"type":"string","enum":["AVAILABLE","PENDING","ASSIGNED"],"description":"Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results.","example":"AVAILABLE"},"identityRequestId":{"type":"string","description":"If *requestStatus* is *PENDING*, indicates the id of the associated account activity.","nullable":true,"example":null},"ownerRef":{"type":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"},"id":{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"},"name":{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"},"email":{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}},"requestCommentsRequired":{"type":"boolean","description":"Whether the requester must provide comments when requesting the object.","example":false}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/requestable-objects","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Requestable Objects List","description":{"content":"This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param.\nAny authenticated token can call this endpoint to see their requestable access items. A token with ORG_ADMIN authority is required to call this endpoint to return a list of all of the requestable access items for the org or for another identity.","type":"text/plain"},"url":{"path":["requestable-objects"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If present, the value returns only requestable objects for the specified identity.\n * Admin users can call this with any identity ID value.\n * Non-admin users can only specify *me* or pass their own identity ID value.\n * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result.","type":"text/plain"},"key":"identity-id","value":""},{"disabled":false,"description":{"content":"Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice.","type":"text/plain"},"key":"types","value":""},{"disabled":false,"description":{"content":"It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored.","type":"text/plain"},"key":"term","value":""},{"disabled":false,"description":{"content":"Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice.","type":"text/plain"},"key":"statuses","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**\n","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Requestable Objects List' (list-requestable-objects)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Requestable Objects List + + + +This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param. +Any authenticated token can call this endpoint to see their requestable access items. A token with ORG_ADMIN authority is required to call this endpoint to return a list of all of the requestable access items for the org or for another identity. + +
Query Parameters
+ +List of requestable objects + +
Schema array
    ownerRef object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-roles.api.mdx b/products/idn/api/beta/list-roles.api.mdx new file mode 100644 index 000000000..5dc56974b --- /dev/null +++ b/products/idn/api/beta/list-roles.api.mdx @@ -0,0 +1,133 @@ +--- +id: list-roles +sidebar_label: List Roles +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listRoles","tags":["Roles"],"description":"This API returns a list of Roles.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.","parameters":[{"in":"query","name":"for-subadmin","schema":{"type":"string"},"description":"If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.","example":"5168015d32f890ca15812c9180835d2e","required":false},{"in":"query","name":"limit","description":"Note that for this API the maximum value for limit is 50.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":50,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":50,"default":50}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"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:\n**id**: *eq, in* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*","example":"requestable eq false","required":false},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"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, modified**","example":"name,-modified","required":false},{"in":"query","name":"for-segment-ids","schema":{"type":"string","format":"comma-separated"},"description":"If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.","example":"0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d","required":false},{"in":"query","name":"include-unsegmented","schema":{"type":"boolean","default":true},"description":"Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.","example":false,"required":false}],"responses":{"200":{"description":"List of Roles","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"A Role","properties":{"id":{"type":"string","description":"The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.","example":"2c918086749d78830174a1a40e121518"},"name":{"type":"string","description":"The human-readable display name of the Role","maxLength":128,"example":"Role 2567"},"created":{"type":"string","description":"Date the Role was created","format":"date-time","example":"2021-03-01T22:32:58.104Z","readOnly":true},"modified":{"type":"string","description":"Date the Role was last modified.","format":"date-time","example":"2021-03-02T20:22:28.104Z","readOnly":true},"description":{"type":"string","nullable":true,"description":"A human-readable description of the Role","example":"Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor."},"owner":{"type":"object","nullable":true,"description":"The owner of this object.","properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"accessProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the Access Profile","example":"ff808081751e6e129f1518161919ecca"},"type":{"type":"string","description":"Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result.","enum":["ACCESS_PROFILE"],"example":"ACCESS_PROFILE"},"name":{"type":"string","description":"Human-readable display name of the Access Profile. This field is ignored on input.","example":"Access Profile 2567"}}},"nullable":true},"membership":{"nullable":true,"type":"object","description":"When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.","properties":{"type":{"type":"string","enum":["STANDARD","IDENTITY_LIST"],"description":"This enum characterizes the type of a Role's membership selector. Only the following two are fully supported:\n\nSTANDARD: Indicates that Role membership is defined in terms of a criteria expression\n\nIDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed","example":"IDENTITY_LIST"},"criteria":{"nullable":true,"type":"object","description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","nullable":true,"description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","nullable":true,"description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","nullable":true,"description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa."}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa."}}},"identities":{"type":"array","items":{"type":"object","description":"A reference to an Identity in an IDENTITY_LIST role membership criteria.","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY","nullable":true},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","nullable":true,"description":"Human-readable display name of the Identity.","example":"Thomas Edison"},"aliasName":{"type":"string","nullable":true,"description":"User name of the Identity","example":"t.edison"}}},"nullable":true,"description":"Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST."}}},"legacyMembershipInfo":{"type":"object","nullable":true,"description":"This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.","example":{"type":"IDENTITY_LIST"},"additionalProperties":true},"enabled":{"type":"boolean","description":"Whether the Role is enabled or not.","example":true,"default":false},"requestable":{"type":"boolean","description":"Whether the Role can be the target of access requests.","example":true,"default":false},"accessRequestConfig":{"nullable":true,"description":"Access request configuration for this object","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":true,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":true,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n\n**OWNER**: Owner of the associated Role\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"revocationRequestConfig":{"nullable":true,"default":null,"description":"Revocation request configuration for this object.","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":false,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":false,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the revocation request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"segments":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of IDs of segments, if any, to which this Role is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]}},"required":["name","owner"]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:role-unchecked:read","idn:role-unchecked:manage","idn:role-checked:manage","idn:role-checked:read"]}],"method":"get","path":"/roles","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Roles","description":{"content":"This API returns a list of Roles.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["roles"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.","type":"text/plain"},"key":"for-subadmin","value":""},{"disabled":false,"description":{"content":"Note that for this API the maximum value for limit is 50.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"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:\n**id**: *eq, in* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"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, modified**","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.","type":"text/plain"},"key":"for-segment-ids","value":""},{"disabled":false,"description":{"content":"Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.","type":"text/plain"},"key":"include-unsegmented","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Roles' (list-roles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Roles + + + +This API returns a list of Roles. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + +
Query Parameters
+ +List of Roles + +
Schema array
    owner object
    + +The owner of this object. + +
    accessProfiles object[]
    membership object
    + +When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities. + +
    criteria object
    + +Defines STANDARD type Role membership + +
    key object
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]
    + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + +
    key object
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]
    + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + +
    key object
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    identities object[]
    + +Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. + +
    legacyMembershipInfo object
    + +This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. + +
    accessRequestConfig object
    + +Access request configuration for this object + +
    approvalSchemes object[]
    + +List describing the steps in approving the request + +
    revocationRequestConfig object
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]
    + +List describing the steps in approving the revocation request + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-segments.api.mdx b/products/idn/api/beta/list-segments.api.mdx new file mode 100644 index 000000000..51106d366 --- /dev/null +++ b/products/idn/api/beta/list-segments.api.mdx @@ -0,0 +1,84 @@ +--- +id: list-segments +sidebar_label: List Segments +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listSegments","tags":["Segments"],"description":"This API returns a list of all segments.\nA token with ORG_ADMIN or API authority is required to call this API.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"List of all Segments","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"name":{"type":"string","description":"Segment Business Name","example":"segment-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this Segment is created","example":"2020-01-01T00:00:00.000000Z"},"modified":{"type":"string","format":"date-time","description":"The time when this Segment is modified","example":"2020-01-01T00:00:00.000000Z"},"description":{"type":"string","description":"Optional description of the Segment","example":"This segment represents xyz"},"owner":{"type":"object","nullable":true,"description":"The owner of this object.","properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"visibilityCriteria":{"type":"object","properties":{"expression":{"type":"object","properties":{"operator":{"type":"string","description":"Operator for the expression","enum":["AND","EQUALS"],"example":"EQUALS"},"attribute":{"type":"string","description":"Name for the attribute","example":"location"},"value":{"type":"object","properties":{"type":{"type":"string","description":"The type of attribute value","example":"STRING"},"value":{"type":"string","description":"The attribute value","example":"Austin"}}},"children":{"type":"array","description":"List of expressions","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of attribute value","example":"STRING"},"value":{"type":"string","description":"The attribute value","example":"Austin"}}},"example":[]}}}}},"active":{"type":"boolean","description":"Whether the Segment is currently active. Inactive segments have no effect."}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/segments","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Segments","description":{"content":"This API returns a list of all segments.\nA token with ORG_ADMIN or API authority is required to call this API.","type":"text/plain"},"url":{"path":["segments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Segments' (list-segments)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Segments + + + +This API returns a list of all segments. +A token with ORG_ADMIN or API authority is required to call this API. + +
Query Parameters
+ +List of all Segments + +
Schema array
    owner object
    + +The owner of this object. + +
    visibilityCriteria object
    expression object
    value object
    children object[]
    + +List of expressions + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-sod-policies.api.mdx b/products/idn/api/beta/list-sod-policies.api.mdx new file mode 100644 index 000000000..ea57b5468 --- /dev/null +++ b/products/idn/api/beta/list-sod-policies.api.mdx @@ -0,0 +1,84 @@ +--- +id: list-sod-policies +sidebar_label: List SOD policies +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listSodPolicies","tags":["SOD Policy"],"description":"This gets list of all SOD policies.\nRequires role of ORG_ADMIN","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq* **name**: *eq* **state**: *eq*","example":"id eq \"bc693f07e7b645539626c25954c58554\"","required":false}],"responses":{"200":{"description":"List of all SOD policies.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy id","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"name":{"type":"string","description":"Policy Business Name","example":"policy-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this SOD policy is created.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"modified":{"type":"string","format":"date-time","description":"The time when this SOD policy is modified.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"description":{"type":"string","description":"Optional description of the SOD policy","example":"This policy ensures compliance of xyz","nullable":true},"ownerRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"externalPolicyReference":{"type":"string","description":"Optional External Policy Reference","example":"XYZ policy","nullable":true},"policyQuery":{"type":"string","description":"Search query of the SOD policy","example":"@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)"},"compensatingControls":{"type":"string","description":"Optional compensating controls(Mitigating Controls)","example":"Have a manager review the transaction decisions for their \"out of compliance\" employee","nullable":true},"correctionAdvice":{"type":"string","description":"Optional correction advice","example":"Based on the role of the employee, managers should remove access that is not required for their job function.","nullable":true},"state":{"type":"string","description":"whether the policy is enforced or not","enum":["ENFORCED","NOT_ENFORCED"],"example":"ENFORCED"},"tags":{"type":"array","description":"tags for this policy object","example":["TAG1","TAG2"],"items":{"type":"string"}},"creatorId":{"type":"string","description":"Policy's creator ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"modifierId":{"type":"string","description":"Policy's modifier ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","nullable":true,"readOnly":true},"violationOwnerAssignmentConfig":{"nullable":true,"type":"object","properties":{"assignmentRule":{"type":"string","enum":["MANAGER","STATIC",null],"description":"Details about the violations owner.\nMANAGER - identity's manager\nSTATIC - Governance Group or Identity","example":"MANAGER","nullable":true},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"nullable":true}]}}},"scheduled":{"type":"boolean","description":"defines whether a policy has been scheduled or not","example":true,"default":false},"type":{"type":"string","description":"whether a policy is query based or conflicting access based","default":"GENERAL","enum":["GENERAL","CONFLICTING_ACCESS_BASED"],"example":"GENERAL"},"conflictingAccessCriteria":{"allOf":[{"type":"object","properties":{"leftCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"DTO type","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}},"rightCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"DTO type","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}}}},{"nullable":true}]}}}},"example":[{"id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"Conflicting-Policy-Name","created":"2020-01-01T00:00:00.000000Z","modified":"2020-01-01T00:00:00.000000Z","description":"This policy ensures compliance of xyz","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Owner Name"},"externalPolicyReference":"XYZ policy","policyQuery":"@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)","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":["string"],"creatorId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","modifierId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","violationOwnerAssignmentConfig":{"assignmentRule":"MANAGER","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Violation Owner Name"}},"scheduled":true,"type":"CONFLICTING_ACCESS_BASED","conflictingAccessCriteria":{"leftCriteria":{"name":"money-in","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67"}]},"rightCriteria":{"name":"money-out","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a68"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a69"}]}}},{"description":"Description","ownerRef":{"type":"IDENTITY","id":"2c918087682f9a86016839c05e8f1aff","name":"Owner Name"},"externalPolicyReference":"New policy","policyQuery":"policy query implementation","compensatingControls":"Compensating controls","correctionAdvice":"Correction advice","tags":[],"state":"ENFORCED","scheduled":false,"creatorId":"2c918087682f9a86016839c05e8f1aff","modifierId":null,"violationOwnerAssignmentConfig":null,"type":"GENERAL","conflictingAccessCriteria":null,"id":"52c11db4-733e-4c31-949a-766c95ec95f1","name":"General-Policy-Name","created":"2020-05-12T19:47:38Z","modified":"2020-05-12T19:47:38Z"}]}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sod-policies","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List SOD policies","description":{"content":"This gets list of all SOD policies.\nRequires role of ORG_ADMIN","type":"text/plain"},"url":{"path":["sod-policies"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq* **name**: *eq* **state**: *eq*","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List SOD policies' (list-sod-policies)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List SOD policies + + + +This gets list of all SOD policies. +Requires role of ORG_ADMIN + +
Query Parameters
+ +List of all SOD policies. + +
Schema array
    ownerRef object
    violationOwnerAssignmentConfig object
    ownerRef object
    conflictingAccessCriteria object
    leftCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
    rightCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-source-schemas.api.mdx b/products/idn/api/beta/list-source-schemas.api.mdx new file mode 100644 index 000000000..8ef535d9f --- /dev/null +++ b/products/idn/api/beta/list-source-schemas.api.mdx @@ -0,0 +1,83 @@ +--- +id: list-source-schemas +sidebar_label: Lists the Schemas that exist on the specified Source in IdentityNow. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listSourceSchemas","tags":["Sources"],"parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source id.","example":"2c9180835d191a86015d28455b4a2329"},{"in":"query","name":"include-types","required":false,"schema":{"type":"string"},"description":"If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized.","example":"group"}],"responses":{"200":{"description":"The Schemas were successfully retrieved.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Schema.","example":"2c9180835d191a86015d28455b4a2329"},"name":{"type":"string","description":"The name of the Schema.","example":"account"},"nativeObjectType":{"type":"string","description":"The name of the object type on the native system that the schema represents.","example":"User"},"identityAttribute":{"type":"string","description":"The name of the attribute used to calculate the unique identifier for an object in the schema.","example":"sAMAccountName"},"displayAttribute":{"type":"string","description":"The name of the attribute used to calculate the display value for an object in the schema.","example":"distinguishedName"},"hierarchyAttribute":{"type":"string","description":"The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.","example":"memberOf"},"includePermissions":{"type":"boolean","description":"Flag indicating whether or not the include permissions with the object data when aggregating the schema.","example":false},"features":{"type":"array","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING."},"description":"The features that the schema supports.","example":["PROVISIONING","NO_PERMISSIONS_PROVISIONING","GROUPS_HAVE_MEMBERS"]},"configuration":{"type":"object","description":"Holds any extra configuration data that the schema may require.","example":{"groupMemberAttribute":"member"}},"attributes":{"type":"array","description":"The attribute definitions which form the schema.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"sAMAccountName"},"type":{"type":"string","enum":["STRING","LONG","INT","BOOLEAN"],"description":"The underlying type of the value which an AttributeDefinition represents.","example":"STRING"},"schema":{"description":"A reference to the schema on the source to the attribute values map to.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"The object ID this reference applies to.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The human-readable display name of the object.","example":"group"}}},"description":{"type":"string","description":"A human-readable description of the attribute.","example":"The sAMAccountName attribute"},"isMulti":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","example":false},"isEntitlement":{"type":"boolean","description":"Flag indicating whether or not the attribute is an entitlement.","example":false},"isGroup":{"type":"boolean","description":"Flag indicating whether or not the attribute represents a group.\nThis can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute..\n","example":false}}},"example":[{"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":{"type":"string","description":"The date the Schema was created.","format":"date-time","example":"2019-12-24T22:32:58.104Z"},"modified":{"type":"string","description":"The date the Schema was last modified.","format":"date-time","example":"2019-12-31T20:22:28.104Z"}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"description":"Lists the Schemas that exist on the specified Source in IdentityNow.","method":"get","path":"/sources/{sourceId}/schemas","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Lists the Schemas that exist on the specified Source in IdentityNow.","description":{"type":"text/plain"},"url":{"path":["sources",":sourceId","schemas"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized.","type":"text/plain"},"key":"include-types","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id.","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Lists the Schemas that exist on the specified Source in IdentityNow.' (list-source-schemas)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Lists the Schemas that exist on the specified Source in IdentityNow. + + + +Lists the Schemas that exist on the specified Source in IdentityNow. + +
Path Parameters
Query Parameters
+ +The Schemas were successfully retrieved. + +
Schema array
    attributes object[]
    + +The attribute definitions which form the schema. + +
    schema object
    + +A reference to the schema on the source to the attribute values map to. + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-sources.api.mdx b/products/idn/api/beta/list-sources.api.mdx new file mode 100644 index 000000000..c310fa9ee --- /dev/null +++ b/products/idn/api/beta/list-sources.api.mdx @@ -0,0 +1,128 @@ +--- +id: list-sources +sidebar_label: Lists all sources in IdentityNow. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listSources","security":[{"oauth2":["idn:sources:read"]}],"tags":["Sources"],"description":"This end-point lists all the sources in IdentityNow.\nA token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"example":"name eq \"#Employees\"","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n **id**: *eq, in*\n **name**: *co, eq, in, sw*\n **type**: *eq, in*\n **owner.id**: *eq, in*\n **features**: *ca, co*\n **created**: *eq*\n **modified**: *eq*\n **managementWorkgroup.id**: *eq*\n **description**: *eq*\n **authoritative**: *eq*\n **healthy**: *eq*\n **status**: *eq, in*\n **connectionType**: *eq*\n **connectorName**: *eq*"},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"example":"name","description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\nSorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status**"},{"in":"query","name":"for-subadmin","schema":{"type":"string"},"example":"name","description":"Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user.\nSubadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned."}],"responses":{"200":{"description":"List of Source objects","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"the id of the Source","example":"2c91808568c529c60168cca6f90c1324"},"name":{"type":"string","description":"Human-readable name of the source","example":"My Source"},"description":{"type":"string","description":"Human-readable description of the source","example":"This is the corporate directory."},"owner":{"description":"Reference to an owning Identity Object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity","example":"MyName"}}},"cluster":{"description":"Reference to the associated Cluster","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"type":"string","description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"accountCorrelationConfig":{"description":"Reference to an Account Correlation Config object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG"],"example":"ACCOUNT_CORRELATION_CONFIG"},"id":{"type":"string","description":"ID of the account correlation config","example":"2c9180855d191c59015d28583727245a"},"name":{"type":"string","description":"Human-readable display name of the account correlation config","example":"Directory [source-62867] Account Correlation"}}},"accountCorrelationRule":{"description":"Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"managerCorrelationMapping":{"description":"Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity","type":"object","properties":{"accountAttribute":{"type":"string","description":"Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.","example":"manager"},"identityAttribute":{"type":"string","description":"Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.","example":"manager"}}},"managerCorrelationRule":{"description":"Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"beforeProvisioningRule":{"description":"Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"schemas":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"ID of the schema","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the schema","example":"MySchema"}}},"description":"List of references to Schema objects","example":[{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232a","name":"account"},{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232b","name":"group"}]},"passwordPolicies":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["PASSWORD_POLICY"],"example":"PASSWORD_POLICY"},"id":{"type":"string","description":"ID of the policy","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the policy","example":"My Password Policy"}}},"description":"List of references to the associated PasswordPolicy objects.","example":[{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb053980","name":"Corporate Password Policy"},{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb057777","name":"Vendor Password Policy"}]},"features":{"type":"array","description":"Optional features that can be supported by a source.","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING."},"example":["SYNC_PROVISIONING","MANAGER_LOOKUP","SEARCH","PROVISIONING","AUTHENTICATE","GROUP_PROVISIONING","PASSWORD"]},"type":{"type":"string","description":"Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ","example":"OpenLDAP - Direct"},"connector":{"type":"string","description":"Connector script name.","example":"active-directory"},"connectorClass":{"type":"string","description":"The fully qualified name of the Java class that implements the connector interface.","example":"sailpoint.connector.LDAPConnector"},"connectorAttributes":{"type":"object","description":"Connector specific configuration; will differ from type to type.","example":{"healthCheckTimeout":30,"authSearchAttributes":["cn","uid","mail"]}},"deleteThreshold":{"type":"integer","format":"int32","description":"Number from 0 to 100 that specifies when to skip the delete phase.","example":10},"authoritative":{"type":"boolean","description":"When true indicates the source is referenced by an IdentityProfile.","example":false},"managementWorkgroup":{"description":"Reference to Management Workgroup for this Source","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["GOVERNANCE_GROUP"],"example":"GOVERNANCE_GROUP"},"id":{"type":"string","description":"ID of the management workgroup","example":"2c91808568c529c60168cca6f90c2222"},"name":{"type":"string","description":"Human-readable display name of the management workgroup","example":"My Management Workgroup"}}},"healthy":{"type":"boolean","description":"When true indicates a healthy source","example":true},"status":{"type":"string","description":"A status identifier, giving specific information on why a source is healthy or not","example":"SOURCE_STATE_HEALTHY"},"since":{"type":"string","description":"Timestamp showing when a source health check was last performed","example":"2021-09-28T15:48:29.3801666300Z"},"connectorId":{"type":"string","description":"The id of connector","example":"active-directory"},"connectorName":{"type":"string","description":"The name of the connector that was chosen on source creation","example":"Active Directory"},"connectionType":{"type":"string","description":"The type of connection (direct or file)","example":"file"},"connectorImplementstionId":{"type":"string","description":"The connector implementstion id","example":"delimited-file"}},"required":["name","owner","connector"]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sources","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Lists all sources in IdentityNow.","description":{"content":"This end-point lists all the sources in IdentityNow.\nA token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n **id**: *eq, in*\n **name**: *co, eq, in, sw*\n **type**: *eq, in*\n **owner.id**: *eq, in*\n **features**: *ca, co*\n **created**: *eq*\n **modified**: *eq*\n **managementWorkgroup.id**: *eq*\n **description**: *eq*\n **authoritative**: *eq*\n **healthy**: *eq*\n **status**: *eq, in*\n **connectionType**: *eq*\n **connectorName**: *eq*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\nSorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status**","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user.\nSubadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned.","type":"text/plain"},"key":"for-subadmin","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Lists all sources in IdentityNow.' (list-sources)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Lists all sources in IdentityNow. + + + +This end-point lists all the sources in IdentityNow. +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API. + +
Query Parameters
+ +List of Source objects + +
Schema array
    owner object
    + +Reference to an owning Identity Object + +
    cluster object
    + +Reference to the associated Cluster + +
    accountCorrelationConfig object
    + +Reference to an Account Correlation Config object + +
    accountCorrelationRule object
    + +Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used. + +
    managerCorrelationMapping object
    + +Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + +
    managerCorrelationRule object
    + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
    beforeProvisioningRule object
    + +Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + +
    schemas object[]
    + +List of references to Schema objects + +
    passwordPolicies object[]
    + +List of references to the associated PasswordPolicy objects. + +
    managementWorkgroup object
    + +Reference to Management Workgroup for this Source + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-sp-config-objects.api.mdx b/products/idn/api/beta/list-sp-config-objects.api.mdx new file mode 100644 index 000000000..3a8b583c6 --- /dev/null +++ b/products/idn/api/beta/list-sp-config-objects.api.mdx @@ -0,0 +1,103 @@ +--- +id: list-sp-config-objects +sidebar_label: Get config object details +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listSpConfigObjects","security":[{"oauth2":["sp:config:read","sp:config:manage"]}],"tags":["SP-Config"],"description":"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.","responses":{"200":{"description":"Object configurations returned successfully.","content":{"application/json":{"schema":{"type":"array","items":{"title":"Object Configuration Model","description":"Response model for get object configuration.","type":"object","properties":{"objectType":{"type":"string","description":"The object type this configuration is for.","example":"TRIGGER_SUBSCRIPTION"},"resolveByIdUrl":{"description":"Url and query parameters to be used to resolve this type of object by Id.","type":"object","title":"Resolver URL Format for Object Configuration.","properties":{"url":{"description":"URL for the target object endpoint.","type":"string","example":"ets://trigger-subscriptions/$id"},"query":{"description":"Any query parameters that are needed for the URL.","type":"object","nullable":true,"example":null}}},"resolveByNameUrl":{"type":"array","items":{"type":"object","title":"Resolver URL Format for Object Configuration.","description":"Format of resolver URLs for Object Configurations","properties":{"url":{"description":"URL for the target object endpoint.","type":"string","example":"ets://trigger-subscriptions/$id"},"query":{"description":"Any query parameters that are needed for the URL.","type":"object","nullable":true,"example":null}}},"description":"Url and query parameters to be used to resolve this type of object by name."},"exportUrl":{"type":"object","title":"Resolver URL Format for Object Configuration.","description":"Format of resolver URLs for Object Configurations","properties":{"url":{"description":"URL for the target object endpoint.","type":"string","example":"ets://trigger-subscriptions/$id"},"query":{"description":"Any query parameters that are needed for the URL.","type":"object","nullable":true,"example":null}}},"exportRight":{"type":"string","description":"Rights needed by the invoker of sp-config/export in order to export this type of object.","example":"idn:trigger-service-subscriptions:read"},"exportLimit":{"type":"integer","format":"int32","description":"Pagination limit imposed by the target service for this object type.","example":10},"importUrl":{"type":"object","title":"Resolver URL Format for Object Configuration.","description":"Format of resolver URLs for Object Configurations","properties":{"url":{"description":"URL for the target object endpoint.","type":"string","example":"ets://trigger-subscriptions/$id"},"query":{"description":"Any query parameters that are needed for the URL.","type":"object","nullable":true,"example":null}}},"importRight":{"type":"string","description":"Rights needed by the invoker of sp-config/import in order to import this type of object.","example":"idn:trigger-service-subscriptions:create"},"importLimit":{"type":"integer","format":"int32","description":"Pagination limit imposed by the target service for this object type.","example":10},"referenceExtractors":{"type":"array","nullable":true,"description":"List of json paths within an exported object of this type that represent references that need to be resolved.","items":{"type":"string"},"example":["$.owner"]},"signatureRequired":{"type":"boolean","default":false,"description":"If true, this type of object will be JWS signed and cannot be modified before import.","example":false}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sp-config/config-objects","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Get config object details","description":{"content":"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.","type":"text/plain"},"url":{"path":["sp-config","config-objects"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get config object details' (list-sp-config-objects)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get config object details + + + +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. + +
+ +Object configurations returned successfully. + +
Schema array
    resolveByIdUrl object
    + +Url and query parameters to be used to resolve this type of object by Id. + +
    resolveByNameUrl object[]
    + +Url and query parameters to be used to resolve this type of object by name. + +
    exportUrl object
    + +Format of resolver URLs for Object Configurations + +
    importUrl object
    + +Format of resolver URLs for Object Configurations + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-subscriptions.api.mdx b/products/idn/api/beta/list-subscriptions.api.mdx new file mode 100644 index 000000000..082c2f882 --- /dev/null +++ b/products/idn/api/beta/list-subscriptions.api.mdx @@ -0,0 +1,91 @@ +--- +id: list-subscriptions +sidebar_label: List Subscriptions +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listSubscriptions","tags":["Triggers"],"description":"Gets a list of all trigger subscriptions.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","required":false,"name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq*\n\n**triggerId**: *eq*\n\n**type**: *eq*","example":"id eq \"12cff757-c0c0-413b-8ad7-2a47956d1e89\""},{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields:\n\n**triggerId** **triggerName**","example":"triggerName"}],"responses":{"200":{"description":"List of subscriptions.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["id","triggerId","type","name","triggerName","enabled","responseDeadline"],"properties":{"id":{"type":"string","description":"Subscription ID.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"name":{"type":"string","description":"Subscription name.","example":"Access request subscription"},"description":{"type":"string","description":"Subscription description.","example":"Access requested to site xyz"},"triggerId":{"type":"string","description":"ID of trigger subscribed to.","example":"idn:access-requested"},"triggerName":{"type":"string","description":"Trigger name of trigger subscribed to.","example":"Access Requested"},"type":{"type":"string","enum":["HTTP","EVENTBRIDGE","INLINE","SCRIPT","WORKFLOW"],"description":"Subscription type. **NOTE** If type is EVENTBRIDGE, then eventBridgeConfig is required. If type is HTTP, then httpConfig is required.","example":"HTTP"},"responseDeadline":{"type":"string","description":"Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format.","example":"PT1H","default":"PT1H"},"httpConfig":{"description":"Config required if HTTP subscription type is used.","type":"object","properties":{"url":{"type":"string","description":"URL of the external/custom integration.","example":"https://www.example.com"},"httpDispatchMode":{"type":"string","description":"HTTP response modes, i.e. SYNC, ASYNC, or DYNAMIC.","enum":["SYNC","ASYNC","DYNAMIC"],"example":"SYNC"},"httpAuthenticationType":{"type":"string","description":"Defines the HTTP Authentication type. Additional values may be added in the future.\n\nIf *NO_AUTH* is selected, no extra information will be in HttpConfig.\n\nIf *BASIC_AUTH* is selected, HttpConfig will include BasicAuthConfig with Username and Password as strings.\n\nIf *BEARER_TOKEN* is selected, HttpConfig will include BearerTokenAuthConfig with Token as string.","enum":["NO_AUTH","BASIC_AUTH","BEARER_TOKEN"],"default":"NO_AUTH","example":"BASIC_AUTH"},"basicAuthConfig":{"type":"object","properties":{"userName":{"type":"string","description":"The username to authenticate.","example":"user@example.com"},"password":{"type":"string","nullable":true,"description":"The password to authenticate. On response, this field is set to null as to not return secrets.","example":null}},"nullable":true,"description":"Config required if BASIC_AUTH is used."},"bearerTokenAuthConfig":{"type":"object","properties":{"bearerToken":{"type":"string","nullable":true,"description":"Bearer token","example":null}},"nullable":true,"description":"Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets."}},"required":["url","httpDispatchMode"]},"eventBridgeConfig":{"description":"Config required if EVENTBRIDGE subscription type is used.","type":"object","properties":{"awsAccount":{"type":"string","description":"AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource.","example":"123456789012"},"awsRegion":{"type":"string","description":"AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values.","example":"us-west-1"}},"required":["awsAccount","awsRegion"]},"enabled":{"type":"boolean","description":"Whether subscription should receive real-time trigger invocations or not.\nTest trigger invocations are always enabled regardless of this option.","default":true,"example":true},"filter":{"type":"string","description":"JSONPath filter to conditionally invoke trigger when expression evaluates to true.","example":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]","externalDocs":{"description":"JSONPath filter documentation","url":"https://developer.sailpoint.com/idn/docs/event-triggers/filtering-events"}}}}},"examples":{"HTTP Subscription":{"value":[{"id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"Access request subscription","description":"Access requested to site xyz","triggerId":"idn:access-requested","triggerName":"Access Requested","type":"HTTP","httpConfig":{"url":"https://www.example.com","httpDispatchMode":"SYNC","httpAuthenticationType":"BASIC_AUTH","basicAuthConfig":{"userName":"user@example.com","password":null}},"enabled":true,"filter":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]"}]},"HTTP Async Subscription":{"value":{"name":"Access request subscription","description":"Access requested to site xyz","triggerId":"idn:access-requested","triggerName":"Access Requested","type":"HTTP","responseDeadline":"PT1H","httpConfig":{"url":"https://www.example.com","httpDispatchMode":"ASYNC","httpAuthenticationType":"BASIC_AUTH","basicAuthConfig":{"userName":"user@example.com","password":null}},"enabled":true,"filter":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]"}},"EventBridge Subscription":{"value":[{"id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"Access request subscription","description":"Access requested to site xyz","triggerId":"idn:access-requested","triggerName":"Access Requested","type":"EVENTBRIDGE","eventBridgeConfig":{"awsAccount":"123456789012","awsRegion":"us-west-1"},"enabled":true,"filter":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]"}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["sp:trigger-service-subscriptions:read"]}],"method":"get","path":"/trigger-subscriptions","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Subscriptions","description":{"content":"Gets a list of all trigger subscriptions.","type":"text/plain"},"url":{"path":["trigger-subscriptions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq*\n\n**triggerId**: *eq*\n\n**type**: *eq*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields:\n\n**triggerId** **triggerName**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Subscriptions' (list-subscriptions)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Subscriptions + + + +Gets a list of all trigger subscriptions. + +
Query Parameters
+ +List of subscriptions. + +
Schema array
    httpConfig object
    + +Config required if HTTP subscription type is used. + +
    basicAuthConfig object
    + +Config required if BASIC_AUTH is used. + +
    bearerTokenAuthConfig object
    + +Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets. + +
    eventBridgeConfig object
    + +Config required if EVENTBRIDGE subscription type is used. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-tagged-objects-by-type.api.mdx b/products/idn/api/beta/list-tagged-objects-by-type.api.mdx new file mode 100644 index 000000000..e9d03c2e1 --- /dev/null +++ b/products/idn/api/beta/list-tagged-objects-by-type.api.mdx @@ -0,0 +1,77 @@ +--- +id: list-tagged-objects-by-type +sidebar_label: List Tagged Objects +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listTaggedObjectsByType","security":[{"oauth2":["idn:tag:read","idn:tag:manage"]}],"tags":["Tagged Objects"],"description":"This API returns a list of all tagged objects by type.\n\nAny authenticated token may be used to call this API.","parameters":[{"in":"path","name":"type","schema":{"type":"string","enum":["ROLE","IDENTITY","SOD_POLICY"]},"required":true,"description":"The type of tagged object to retrieve.","example":"ROLE"},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**objectRef.id**: *eq*\n\n**objectRef.type**: *eq*","example":"objectRef.id eq \"2c91808568c529c60168cca6f90c1313\"","required":false}],"responses":{"200":{"description":"List of all tagged objects for specified type.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"objectRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"tags":{"type":"array","items":{"type":"string"},"description":"Labels to be applied to an Object","example":["BU_FINANCE","PCI"]}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/tagged-objects/{type}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Tagged Objects","description":{"content":"This API returns a list of all tagged objects by type.\n\nAny authenticated token may be used to call this API.","type":"text/plain"},"url":{"path":["tagged-objects",":type"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**objectRef.id**: *eq*\n\n**objectRef.type**: *eq*","type":"text/plain"},"key":"filters","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The type of tagged object to retrieve.","type":"text/plain"},"type":"any","value":"","key":"type"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Tagged Objects' (list-tagged-objects-by-type)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Tagged Objects + + + +This API returns a list of all tagged objects by type. + +Any authenticated token may be used to call this API. + +
Path Parameters
Query Parameters
+ +List of all tagged objects for specified type. + +
Schema array
    objectRef object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-tagged-objects.api.mdx b/products/idn/api/beta/list-tagged-objects.api.mdx new file mode 100644 index 000000000..7d5065f09 --- /dev/null +++ b/products/idn/api/beta/list-tagged-objects.api.mdx @@ -0,0 +1,77 @@ +--- +id: list-tagged-objects +sidebar_label: List Tagged Objects +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listTaggedObjects","security":[{"oauth2":["idn:tag:read","idn:tag:manage"]}],"tags":["Tagged Objects"],"description":"This API returns a list of all tagged objects.\n\nAny authenticated token may be used to call this API.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**objectRef.id**: *eq, in*\n\n**objectRef.type**: *eq, in*\n\n**tagName**: *eq, in*","example":"tagName eq \"BU_FINANCE\"","required":false}],"responses":{"200":{"description":"List of all tagged objects.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"objectRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"tags":{"type":"array","items":{"type":"string"},"description":"Labels to be applied to an Object","example":["BU_FINANCE","PCI"]}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/tagged-objects","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Tagged Objects","description":{"content":"This API returns a list of all tagged objects.\n\nAny authenticated token may be used to call this API.","type":"text/plain"},"url":{"path":["tagged-objects"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**objectRef.id**: *eq, in*\n\n**objectRef.type**: *eq, in*\n\n**tagName**: *eq, in*","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Tagged Objects' (list-tagged-objects)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Tagged Objects + + + +This API returns a list of all tagged objects. + +Any authenticated token may be used to call this API. + +
Query Parameters
+ +List of all tagged objects. + +
Schema array
    objectRef object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-transforms.api.mdx b/products/idn/api/beta/list-transforms.api.mdx new file mode 100644 index 000000000..ed22374f4 --- /dev/null +++ b/products/idn/api/beta/list-transforms.api.mdx @@ -0,0 +1,76 @@ +--- +id: list-transforms +sidebar_label: List transforms +hide_title: true +hide_table_of_contents: true +api: {"tags":["Transforms"],"description":"Gets a list of all saved transform objects.\nA token with transforms-list read authority is required to call this API.","operationId":"listTransforms","parameters":[{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"name":"name","in":"query","description":"Name of the transform to retrieve from the list.","required":false,"style":"form","schema":{"type":"string","example":"ExampleTransformName123"}},{"name":"filters","in":"query","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n**internal**: *eq*\n**name**: *eq*, *sw*","example":"name eq ExampleTransformName123","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of transforms matching the given criteria.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"DTO for representing an internally- or customer-defined transform.","required":["name","type","attributes"],"properties":{"id":{"type":"string","description":"Unique ID of this transform","example":"2cd78adghjkja34jh2b1hkjhasuecd"},"name":{"type":"string","description":"Unique name of this transform","example":"Timestamp To Date"},"type":{"type":"string","description":"The transform type (see [Transformations in IdentityNow Using Seaspray](https://community.sailpoint.com/docs/DOC-4629)).","example":"concat"},"attributes":{"type":"object","nullable":true,"description":"Meta-data about the transform. Values in this list are specific to the type of transform to be executed.","example":{"inputFormat":"MMM dd yyyy, HH:mm:ss.SSS","outputFormat":"yyyy/dd/MM"}},"internal":{"type":"boolean","default":false,"readOnly":true,"description":"Indicates whether this is an internal SailPoint-created transform or a customer-created transform","example":false}}}},"example":[{"id":"2cd78adghjkja34jh2b1hkjhasuecd","name":"Timestamp To Date","type":"dateFormat","attributes":{"inputFormat":"MMM-dd-yyyy, HH:mm:ss.SSS","outputFormat":"yyyy/dd/MM"},"internal":false},{"id":"2lkas8dhj4bkuakja77giih7l4ashh","name":"PrefixSubstring","type":"substring","attributes":{"begin":0,"end":3},"internal":true}]}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:transform:read","idn:transform:manage"]}],"method":"get","path":"/transforms","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List transforms","description":{"content":"Gets a list of all saved transform objects.\nA token with transforms-list read authority is required to call this API.","type":"text/plain"},"url":{"path":["transforms"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Name of the transform to retrieve from the list.","type":"text/plain"},"key":"name","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n**internal**: *eq*\n**name**: *eq*, *sw*","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List transforms' (list-transforms)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List transforms + + + +Gets a list of all saved transform objects. +A token with transforms-list read authority is required to call this API. + +
Query Parameters
+ +A list of transforms matching the given criteria. + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-trigger-invocation-status.api.mdx b/products/idn/api/beta/list-trigger-invocation-status.api.mdx new file mode 100644 index 000000000..27b27ef58 --- /dev/null +++ b/products/idn/api/beta/list-trigger-invocation-status.api.mdx @@ -0,0 +1,89 @@ +--- +id: list-trigger-invocation-status +sidebar_label: List Latest Invocation Statuses +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listTriggerInvocationStatus","tags":["Triggers"],"description":"Gets a list of latest invocation statuses.\nStatuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours.\nThis endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**triggerId**: *eq* **subscriptionId**: *eq*","example":"triggerId eq \"idn:access-request-dynamic-approver\""},{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields:\n\n**triggerId** **subscriptionName** **created** **completed**","example":"created"}],"responses":{"200":{"description":"List of latest invocation statuses.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["id","triggerId","subscriptionId","startInvocationInput","type","subscriptionName","created"],"properties":{"id":{"type":"string","description":"Invocation ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"triggerId":{"type":"string","description":"Trigger ID","example":"idn:access-requested"},"subscriptionId":{"type":"string","description":"Subscription ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"type":{"type":"string","description":"Defines the Invocation type.\n\n**TEST** The trigger was invocated as a test, either via the test subscription button in the UI or via the start test invocation API.\n\n**REAL_TIME** The trigger subscription is live and was invocated by a real event in IdentityNow.","enum":["TEST","REAL_TIME"],"example":"TEST"},"created":{"type":"string","format":"date-time","description":"Invocation created timestamp. ISO-8601 in UTC.","example":"2020-03-27T20:40:10.738Z"},"completed":{"type":"string","format":"date-time","description":"Invocation completed timestamp; empty fields imply invocation is in-flight or not completed. ISO-8601 in UTC.","example":"2020-03-27T20:42:14.738Z"},"startInvocationInput":{"description":"Data related to start of trigger invocation.","type":"object","properties":{"triggerId":{"type":"string","description":"Trigger ID","example":"idn:access-requested"},"input":{"type":"object","example":{"identityId":"201327fda1c44704ac01181e963d463c"},"description":"Trigger input payload. Its schema is defined in the trigger definition."},"contentJson":{"type":"object","example":{"workflowId":1234},"description":"JSON map of invocation metadata"}}},"completeInvocationInput":{"description":"Data related to end of trigger invocation.","type":"object","properties":{"localizedError":{"type":"object","description":"Localized error message to indicate a failed invocation or error if any.","required":["locale","message"],"properties":{"locale":{"description":"Message locale","type":"string","example":"An error has occurred!"},"message":{"description":"Message text","type":"string","example":"Error has occurred!"}}},"output":{"type":"object","example":{"approved":false},"description":"Trigger output that completed the invocation. Its schema is defined in the trigger definition."}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["sp:trigger-service-invocation-status:read","sp:trigger-service-invocation-status:manage"]}],"method":"get","path":"/trigger-invocations/status","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Latest Invocation Statuses","description":{"content":"Gets a list of latest invocation statuses.\nStatuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours.\nThis endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations.","type":"text/plain"},"url":{"path":["trigger-invocations","status"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**triggerId**: *eq* **subscriptionId**: *eq*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields:\n\n**triggerId** **subscriptionName** **created** **completed**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Latest Invocation Statuses' (list-trigger-invocation-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Latest Invocation Statuses + + + +Gets a list of latest invocation statuses. +Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. +This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. + +
Query Parameters
+ +List of latest invocation statuses. + +
Schema array
    startInvocationInput object
    + +Data related to start of trigger invocation. + +
    completeInvocationInput object
    + +Data related to end of trigger invocation. + +
    localizedError object
    + +Localized error message to indicate a failed invocation or error if any. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-triggers.api.mdx b/products/idn/api/beta/list-triggers.api.mdx new file mode 100644 index 000000000..88e111689 --- /dev/null +++ b/products/idn/api/beta/list-triggers.api.mdx @@ -0,0 +1,259 @@ +--- +id: list-triggers +sidebar_label: List Triggers +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listTriggers","tags":["Triggers"],"description":"Gets a list of triggers that are available in the tenant.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq*","example":"id eq \"idn:access-request-post-approval\""},{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields:\n\n**id** **name**","example":"name"}],"responses":{"200":{"description":"List of triggers.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["id","name","type","inputSchema","exampleInput"],"properties":{"id":{"type":"string","description":"Unique identifier of the trigger.","example":"idn:access-request-dynamic-approver"},"name":{"type":"string","description":"Trigger Name.","example":"Access Request Dynamic Approver"},"type":{"example":"REQUEST_RESPONSE","type":"string","description":"The type of trigger.","enum":["REQUEST_RESPONSE","FIRE_AND_FORGET"]},"description":{"type":"string","description":"Trigger Description.","example":"Trigger for getting a dynamic approver."},"inputSchema":{"type":"string","description":"The JSON schema of the payload that will be sent by the trigger to the subscribed service.","example":"{\"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":{"description":"An example of the JSON payload that will be sent by the trigger to the subscribed service.","oneOf":[{"title":"Access Request Dynamic Approver","type":"object","required":["accessRequestId","requestedFor","requestedItems","requestedBy"],"properties":{"accessRequestId":{"type":"string","description":"The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the status of the request.\n","example":"4b4d982dddff4267ab12f0f1e72b5a6d"},"requestedFor":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity for whom the access is requested for.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}},"requestedItems":{"description":"The access items that are being requested.","type":"array","items":{"type":"object","required":["id","name","type","operation"],"properties":{"id":{"type":"string","description":"The unique ID of the access item.","example":"2c91808b6ef1d43e016efba0ce470904"},"name":{"type":"string","description":"Human friendly name of the access item.","example":"Engineering Access"},"description":{"nullable":true,"type":"string","description":"Extended description of the access item.","example":"Engineering Access"},"type":{"enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"The type of access item being requested.","example":"ACCESS_PROFILE"},"operation":{"enum":["Add","Remove"],"description":"Grant or revoke the access item","example":"Add"},"comment":{"nullable":true,"type":"string","description":"A comment from the requestor on why the access is needed.","example":"William needs this access for his day to day job activities."}}}},"requestedBy":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that initiated the access request.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}}}},{"title":"Access Request Post Approval","type":"object","required":["accessRequestId","requestedFor","requestedItemsStatus","requestedBy"],"properties":{"accessRequestId":{"type":"string","description":"The unique ID of the access request.","example":"2c91808b6ef1d43e016efba0ce470904"},"requestedFor":{"required":["id","type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity who the access request is for.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}},"requestedItemsStatus":{"description":"Details on the outcome of each access item.","type":"array","items":{"type":"object","required":["id","name","type","operation","approvalInfo"],"properties":{"id":{"type":"string","description":"The unique ID of the access item being requested.","example":"2c91808b6ef1d43e016efba0ce470904"},"name":{"type":"string","description":"The human friendly name of the access item.","example":"Engineering Access"},"description":{"nullable":true,"type":"string","description":"Detailed description of the access item.","example":"Access to engineering database"},"type":{"enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"The type of access item.","example":"ACCESS_PROFILE"},"operation":{"enum":["Add","Remove"],"description":"The action to perform on the access item.","example":"Add"},"comment":{"nullable":true,"type":"string","description":"A comment from the identity requesting the access.","example":"William needs this access to do his job."},"clientMetadata":{"description":"Additional customer defined metadata about the access item.","nullable":true,"type":"object","additionalProperties":true,"example":{"applicationName":"My application"}},"approvalInfo":{"description":"A list of one or more approvers for the access request.","type":"array","items":{"type":"object","required":["approvalDecision","approverName","approver"],"properties":{"approvalComment":{"nullable":true,"type":"string","description":"A comment left by the approver.","example":"This access looks good. Approved."},"approvalDecision":{"enum":["APPROVED","DENIED"],"description":"The final decision of the approver.","example":"APPROVED"},"approverName":{"type":"string","description":"The name of the approver","example":"Stephen.Austin"},"approver":{"required":["id","type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity of the approver.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}}}}}}}},"requestedBy":{"required":["id","type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that initiated the access request.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}}}},{"title":"Access Request Pre Approval","type":"object","required":["accessRequestId","requestedFor","requestedItems","requestedBy"],"properties":{"accessRequestId":{"type":"string","description":"The unique ID of the access request.","example":"2c91808b6ef1d43e016efba0ce470904"},"requestedFor":{"required":["id","type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity who the access request is for.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}},"requestedItems":{"description":"Details of the access items being requested.","type":"array","items":{"type":"object","required":["id","name","type","operation"],"properties":{"id":{"type":"string","description":"The unique ID of the access item being requested.","example":"2c91808b6ef1d43e016efba0ce470904"},"name":{"type":"string","description":"The human friendly name of the access item.","example":"Engineering Access"},"description":{"nullable":true,"type":"string","description":"Detailed description of the access item.","example":"Access to engineering database"},"type":{"enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"The type of access item.","example":"ACCESS_PROFILE"},"operation":{"enum":["Add","Remove"],"description":"The action to perform on the access item.","example":"Add"},"comment":{"nullable":true,"type":"string","description":"A comment from the identity requesting the access.","example":"William needs this access to do his job."}}}},"requestedBy":{"required":["id","type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that initiated the access request.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}}}},{"title":"Account Aggregation Completed","type":"object","required":["source","status","started","completed","errors","warnings","stats"],"properties":{"source":{"required":["type","name","id"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The source from which the accounts were aggregated.","properties":{"type":{"enum":["SOURCE"],"description":"The type of object that is referenced","example":"SOURCE"}}},"status":{"description":"The overall status of the aggregation.","enum":["Success","Failed","Terminated"],"example":"Success"},"started":{"type":"string","format":"date-time","description":"The date and time when the account aggregation started.","example":"2020-06-29T22:01:50.474Z"},"completed":{"type":"string","format":"date-time","description":"The date and time when the account aggregation finished.","example":"2020-06-29T22:02:04.090Z"},"errors":{"nullable":true,"description":"A list of errors that occurred during the aggregation.","type":"array","items":{"type":"string","description":"A descriptive error message.","example":"Accounts unable to be aggregated."}},"warnings":{"nullable":true,"description":"A list of warnings that occurred during the aggregation.","type":"array","items":{"type":"string","description":"A descriptive warning message.","example":"Account Skipped"}},"stats":{"type":"object","description":"Overall statistics about the account aggregation.","required":["scanned","unchanged","changed","added","removed"],"properties":{"scanned":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"description":"The number of accounts which were scanned / iterated over.","example":200},"unchanged":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"description":"The number of accounts which existed before, but had no changes.","example":190},"changed":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"description":"The number of accounts which existed before, but had changes.","example":6},"added":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"description":"The number of accounts which are new - have not existed before.","example":4},"removed":{"type":"integer","minimum":0,"maximum":2147483647,"format":"int32","description":"The number accounts which existed before, but no longer exist (thus getting removed).","example":3}}}}},{"title":"Account Attributes Changed","type":"object","required":["identity","source","account","changes"],"properties":{"identity":{"required":["id","type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity whose account attributes changed.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}},"source":{"required":["id","type","name"],"type":"object","description":"The source that contains the account.","properties":{"id":{"description":"ID of the object to which this reference applies","type":"string","example":"4e4d982dddff4267ab12f0f1e72b5a6d"},"type":{"type":"string","enum":["SOURCE"],"example":"SOURCE","description":"The type of object that is referenced"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"Corporate Active Directory"}}},"account":{"type":"object","description":"Details of the account where the attributes changed.","required":["id","uuid","name","nativeIdentity","type"],"properties":{"id":{"type":"string","description":"SailPoint generated unique identifier.","example":"52170a74-ca89-11ea-87d0-0242ac130003"},"uuid":{"nullable":true,"type":"string","description":"The source's unique identifier for the account. UUID is generated by the source system.","example":"1cb1f07d-3e5a-4431-becd-234fa4306108"},"name":{"type":"string","description":"Name of the account.","example":"john.doe"},"nativeIdentity":{"type":"string","description":"Unique ID of the account on the source.","example":"cn=john.doe,ou=users,dc=acme,dc=com"},"type":{"enum":["ACCOUNT"],"description":"The type of the account","example":"ACCOUNT"}}},"changes":{"type":"array","description":"A list of attributes that changed.","items":{"type":"object","required":["attribute","oldValue","newValue"],"properties":{"attribute":{"type":"string","description":"The name of the attribute.","example":"sn"},"oldValue":{"description":"The previous value of the attribute.","nullable":true,"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"array","items":{"nullable":true,"type":"string"}}],"example":"doe"},"newValue":{"description":"The new value of the attribute.","nullable":true,"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"array","items":{"nullable":true,"type":"string"}}],"example":"ryans"}}}}}},{"title":"Account Correlated","type":"object","required":["identity","source","account","attributes"],"properties":{"identity":{"required":["type","name","id"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that the account correlated with.","properties":{"type":{"enum":["IDENTITY"],"description":"The type of object that is referenced","example":"IDENTITY"}}},"source":{"required":["id","type","name"],"type":"object","description":"The source from which the account came from.","properties":{"id":{"description":"ID of the object to which this reference applies","type":"string","example":"4e4d982dddff4267ab12f0f1e72b5a6d"},"type":{"type":"string","enum":["SOURCE"],"example":"SOURCE","description":"The type of object that is referenced"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"Corporate Active Directory"}}},"account":{"required":["id","name","nativeIdentity","type"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The account that was correlated.","properties":{"type":{"enum":["ACCOUNT"],"description":"The type of object that is referenced","example":"ACCOUNT"},"nativeIdentity":{"type":"string","description":"Unique ID of the account on the source.","example":"cn=john.doe,ou=users,dc=acme,dc=com"},"uuid":{"nullable":true,"type":"string","description":"The source's unique identifier for the account. UUID is generated by the source system.","example":"1cb1f07d-3e5a-4431-becd-234fa4306108"}}},"attributes":{"type":"object","description":"The attributes associated with the account. Attributes are unique per source.","additionalProperties":true,"example":{"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":{"type":"integer","format":"int32","description":"The number of entitlements associated with this account.","example":0}}},{"title":"Accounts Collected for Aggregation","type":"object","required":["source","status","started","completed","errors","warnings","stats"],"properties":{"source":{"required":["id","type","name"],"type":"object","description":"Reference to the source that has been aggregated.","properties":{"id":{"description":"ID of the object to which this reference applies","type":"string","example":"4e4d982dddff4267ab12f0f1e72b5a6d"},"type":{"type":"string","enum":["SOURCE"],"example":"SOURCE","description":"The type of object that is referenced"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"Corporate Active Directory"}}},"status":{"description":"The overall status of the collection.","enum":["Success","Failed","Terminated"],"example":"Success"},"started":{"type":"string","format":"date-time","description":"The date and time when the account collection started.","example":"2020-06-29T22:01:50.474Z"},"completed":{"type":"string","format":"date-time","description":"The date and time when the account collection finished.","example":"2020-06-29T22:02:04.090Z"},"errors":{"nullable":true,"description":"A list of errors that occurred during the collection.","type":"array","items":{"type":"string","description":"A descriptive error message.","example":"Unable to collect accounts for aggregation."}},"warnings":{"nullable":true,"description":"A list of warnings that occurred during the collection.","type":"array","items":{"type":"string","description":"A descriptive warning message.","example":"Account Skipped"}},"stats":{"type":"object","description":"Overall statistics about the account collection.","required":["scanned","unchanged","changed","added","removed"],"properties":{"scanned":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"description":"The number of accounts which were scanned / iterated over.","example":200},"unchanged":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"description":"The number of accounts which existed before, but had no changes.","example":190},"changed":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"description":"The number of accounts which existed before, but had changes.","example":6},"added":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"description":"The number of accounts which are new - have not existed before.","example":4},"removed":{"type":"integer","minimum":0,"maximum":2147483647,"format":"int32","description":"The number accounts which existed before, but no longer exist (thus getting removed).","example":3}}}}},{"title":"Account Uncorrelated","type":"object","required":["identity","source","account"],"properties":{"identity":{"required":["type","name","id"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that the account uncorrelated with.","properties":{"type":{"enum":["IDENTITY"],"description":"The type of object that is referenced","example":"IDENTITY"}}},"source":{"required":["type","name","id"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The source from which the account came from.","properties":{"type":{"enum":["SOURCE"],"description":"The type of object that is referenced","example":"SOURCE"}}},"account":{"required":["id","name","nativeIdentity","type"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The account that was uncorrelated.","properties":{"type":{"enum":["ACCOUNT"],"description":"The type of object that is referenced","example":"ACCOUNT"},"nativeIdentity":{"type":"string","description":"Unique ID of the account on the source.","example":"cn=john.doe,ou=users,dc=acme,dc=com"},"uuid":{"nullable":true,"type":"string","description":"The source's unique identifier for the account. UUID is generated by the source system.","example":"1cb1f07d-3e5a-4431-becd-234fa4306108"}}},"entitlementCount":{"type":"integer","format":"int32","description":"The number of entitlements associated with this account.","example":0}}},{"title":"Campaign Activated","type":"object","required":["campaign"],"properties":{"campaign":{"type":"object","description":"Details about the certification campaign that was activated.","required":["id","name","description","created","deadline","type","campaignOwner","status"],"properties":{"id":{"type":"string","description":"Unique ID for the campaign.","example":"2c91808576f886190176f88cac5a0010"},"name":{"type":"string","description":"The human friendly name of the campaign.","example":"Manager Access Campaign"},"description":{"type":"string","description":"Extended description of the campaign.","example":"Audit access for all employees."},"created":{"type":"string","format":"date-time","description":"The date and time the campaign was created.","example":"2021-02-16T03:04:45.815Z"},"modified":{"nullable":true,"type":"string","format":"date-time","description":"The date and time the campaign was last modified.","example":"2021-02-16T03:06:45.815Z"},"deadline":{"type":"string","format":"date-time","description":"The date and time the campaign is due.","example":"2021-03-16T03:04:45.815Z"},"type":{"description":"The type of campaign.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"},"campaignOwner":{"type":"object","description":"Details of the identity that owns the campaign.","required":["id","displayName","email"],"properties":{"id":{"type":"string","description":"The unique ID of the identity.","example":"37f080867702c1910177031320c40n27"},"displayName":{"type":"string","description":"The human friendly name of the identity.","example":"John Snow"},"email":{"type":"string","description":"The primary email address of the identity.","example":"john.snow@example.com"}}},"status":{"enum":["ACTIVE"],"description":"The current status of the campaign.","example":"ACTIVE"}}}}},{"title":"Campaign Ended","type":"object","required":["campaign"],"properties":{"campaign":{"type":"object","description":"Details about the certification campaign that ended.","required":["id","name","description","created","deadline","type","campaignOwner","status"],"properties":{"id":{"type":"string","description":"Unique ID for the campaign.","example":"2c91808576f886190176f88cac5a0010"},"name":{"type":"string","description":"The human friendly name of the campaign.","example":"Manager Access Campaign"},"description":{"type":"string","description":"Extended description of the campaign.","example":"Audit access for all employees."},"created":{"type":"string","format":"date-time","description":"The date and time the campaign was created.","example":"2021-02-16T03:04:45.815Z"},"modified":{"nullable":true,"type":"string","format":"date-time","description":"The date and time the campaign was last modified.","example":"2021-03-16T03:06:45.815Z"},"deadline":{"type":"string","format":"date-time","description":"The date and time the campaign is due.","example":"2021-03-16T03:04:45.815Z"},"type":{"description":"The type of campaign.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"},"campaignOwner":{"type":"object","description":"Details of the identity that owns the campaign.","required":["id","displayName","email"],"properties":{"id":{"type":"string","description":"The unique ID of the identity.","example":"37f080867702c1910177031320c40n27"},"displayName":{"type":"string","description":"The human friendly name of the identity.","example":"John Snow"},"email":{"type":"string","description":"The primary email address of the identity.","example":"john.snow@example.com"}}},"status":{"enum":["COMPLETED"],"description":"The current status of the campaign.","example":"COMPLETED"}}}}},{"title":"Campaign Generated","type":"object","required":["campaign"],"properties":{"campaign":{"description":"Details about the campaign that was generated.","type":"object","required":["id","name","description","created","type","campaignOwner","status"],"properties":{"id":{"type":"string","description":"The unique ID of the campaign.","example":"2c91808576f886190176f88cac5a0010"},"name":{"type":"string","description":"Human friendly name of the campaign.","example":"Manager Access Campaign"},"description":{"type":"string","description":"Extended description of the campaign.","example":"Audit access for all employees."},"created":{"type":"string","format":"date-time","description":"The date and time the campaign was created.","example":"2021-02-16T03:04:45.815Z"},"modified":{"nullable":true,"type":"string","description":"The date and time the campaign was last modified.","example":"2021-02-17T03:04:45.815Z"},"deadline":{"nullable":true,"type":"string","description":"The date and time when the campaign must be finished by.","example":"2021-02-18T03:04:45.815Z"},"type":{"enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"description":"The type of campaign that was generated.","example":"MANAGER"},"campaignOwner":{"type":"object","description":"The identity that owns the campaign.","required":["id","displayName","email"],"properties":{"id":{"type":"string","description":"The unique ID of the identity.","example":"37f080867702c1910177031320c40n27"},"displayName":{"type":"string","description":"The display name of the identity.","example":"John Snow"},"email":{"type":"string","description":"The primary email address of the identity.","example":"john.snow@example.com"}}},"status":{"enum":["STAGED","ACTIVATING","ACTIVE"],"description":"The current status of the campaign.","example":"STAGED"}}}}},{"title":"Certification Signed Off","type":"object","required":["certification"],"properties":{"certification":{"description":"The certification campaign that was signed off on.","required":["id","name","created"],"allOf":[{"type":"object","required":["campaignRef","completed","decisionsMade","decisionsTotal","due","signed","reviewer","campaignOwner","hasErrors","phase","entitiesCompleted","entitiesTotal"],"properties":{"campaignRef":{"type":"object","required":["id","name","type","campaignType","description","correlatedStatus","mandatoryCommentRequirement"],"properties":{"id":{"type":"string","description":"The unique ID of the campaign.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the campaign.","example":"Campaign Name"},"type":{"type":"string","enum":["CAMPAIGN"],"description":"The type of object that is being referenced.","example":"CAMPAIGN"},"campaignType":{"type":"string","enum":["MANAGER","SOURCE_OWNER","SEARCH"],"description":"The type of the campaign.","example":"MANAGER"},"description":{"type":"string","description":"The description of the campaign set by the admin who created it.","nullable":true,"example":"A description of the campaign"},"correlatedStatus":{"description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"},"mandatoryCommentRequirement":{"type":"string","description":"Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.","enum":["ALL_DECISIONS","REVOKE_ONLY_DECISIONS","NO_DECISIONS"],"example":"NO_DECISIONS"}}},"phase":{"type":"string","description":"The current phase of the campaign.\n* `STAGED`: The campaign is waiting to be activated.\n* `ACTIVE`: The campaign is active.\n* `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete.\n","enum":["STAGED","ACTIVE","SIGNED"],"example":"ACTIVE"},"due":{"type":"string","format":"date-time","description":"The due date of the certification.","example":"2018-10-19T13:49:37.385Z"},"signed":{"type":"string","format":"date-time","description":"The date the reviewer signed off on the certification.","example":"2018-10-19T13:49:37.385Z"},"reviewer":{"description":"A reference to the reviewer of the campaign.","type":"object","required":["type","id","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"properties":{"type":{"description":"The type of object that the reviewer is.","enum":["IDENTITY","GOVERNANCE_GROUP"],"example":"IDENTITY"},"email":{"type":"string","nullable":true,"description":"The email of the reviewing identity. Only applicable to `IDENTITY`","example":"reviewer@test.com"}}},"reassignment":{"nullable":true,"description":"A reference to a reviewer that this campaign has been reassigned to.","type":"object","properties":{"from":{"description":"The previous certification","type":"object","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object","properties":{"reviewer":{"description":"Certification reviewer","type":"object","required":["type","id","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"properties":{"type":{"description":"The type of object that the reviewer is.","enum":["IDENTITY","GOVERNANCE_GROUP"],"example":"IDENTITY"},"email":{"type":"string","nullable":true,"description":"The email of the reviewing identity. Only applicable to `IDENTITY`","example":"reviewer@test.com"}}}}}],"properties":{"type":{"description":"The type of object that the reviewer is.","enum":["CERTIFICATION"],"example":"CERTIFICATION"}}},"comment":{"type":"string","description":"Comments from the previous reviewer.","example":"Please review"}}},"hasErrors":{"type":"boolean","example":false,"description":"Indicates it the certification has any errors."},"errorMessage":{"type":"string","nullable":true,"example":"The certification has an error","description":"A message indicating what the error is."},"completed":{"type":"boolean","description":"Indicates if all certification decisions have been made.","example":false},"decisionsMade":{"type":"integer","description":"The number of approve/revoke/acknowledge decisions that have been made by the reviewer.","example":20,"format":"int32"},"decisionsTotal":{"type":"integer","description":"The total number of approve/revoke/acknowledge decisions for the certification.","example":40,"format":"int32"},"entitiesCompleted":{"type":"integer","description":"The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete.","example":5,"format":"int32"},"entitiesTotal":{"type":"integer","format":"int32","description":"The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete.","example":10}}}],"properties":{"id":{"type":"string","description":"Unique ID of the certification.","example":"2c91808576f886190176f88caf0d0067"},"name":{"type":"string","description":"The name of the certification.","example":"Manager Access Review for Alice Baker"},"created":{"type":"string","format":"date-time","description":"The date and time the certification was created.","example":"2020-02-16T03:04:45.815Z"},"modified":{"nullable":true,"type":"string","format":"date-time","description":"The date and time the certification was last modified.","example":"2020-02-16T03:06:45.815Z"}}}}},{"title":"Identity Attributes Changed","type":"object","required":["identity","changes"],"properties":{"identity":{"required":["id","type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity who's attributes changed.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}},"changes":{"description":"A list of one or more identity attributes that changed on the identity.","type":"array","items":{"type":"object","required":["attribute"],"properties":{"attribute":{"type":"string","description":"The name of the identity attribute that changed.","example":"department"},"oldValue":{"description":"The value of the identity attribute before it changed.","nullable":true,"example":"sales","oneOf":[{"type":"string"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"object","nullable":true,"additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"}]}}]},"newValue":{"description":"The value of the identity attribute after it changed.","example":"marketing","oneOf":[{"type":"string"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"object","nullable":true,"additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"}]}}]}}}}}},{"title":"Identity Created","type":"object","required":["identity","attributes"],"properties":{"identity":{"required":["id","type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that was created.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}},"attributes":{"type":"object","description":"The attributes assigned to the identity. Attributes are determined by the identity profile.","additionalProperties":true,"example":{"firstname":"John"}}}},{"title":"Identity Deleted","type":"object","required":["identity","attributes"],"properties":{"identity":{"required":["id","type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that was deleted.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}},"attributes":{"type":"object","description":"The attributes assigned to the identity. Attributes are determined by the identity profile.","additionalProperties":true,"example":{"firstname":"John"}}}},{"title":"Provisioning Completed","type":"object","required":["trackingNumber","sources","recipient","accountRequests"],"properties":{"trackingNumber":{"type":"string","description":"The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface.","example":"4b4d982dddff4267ab12f0f1e72b5a6d"},"sources":{"type":"string","description":"One or more sources that the provisioning transaction(s) were done against. Sources are comma separated.","example":"Corp AD, Corp LDAP, Corp Salesforce"},"action":{"nullable":true,"type":"string","description":"Origin of where the provisioning request came from.","example":"IdentityRefresh"},"errors":{"nullable":true,"description":"A list of any accumulated error messages that occurred during provisioning.","type":"array","items":{"type":"string","example":"Connector AD Failed"}},"warnings":{"nullable":true,"description":"A list of any accumulated warning messages that occurred during provisioning.","type":"array","items":{"type":"string","example":"Notification Skipped due to invalid email"}},"recipient":{"required":["id","type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the identity who is the target of the provisioning request.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}},"requester":{"nullable":true,"required":["id","type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the identity (if any) who submitted the provisioning request.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}},"accountRequests":{"type":"array","description":"A list of provisioning instructions to perform on an account-by-account basis.","items":{"type":"object","required":["source","accountOperation","provisioningResult","provisioningTarget"],"properties":{"source":{"required":["id","type","name"],"type":"object","description":"Reference to the source being provisioned against.","properties":{"id":{"description":"ID of the object to which this reference applies","type":"string","example":"4e4d982dddff4267ab12f0f1e72b5a6d"},"type":{"type":"string","enum":["SOURCE"],"example":"SOURCE","description":"The type of object that is referenced"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"Corporate Active Directory"}}},"accountId":{"type":"string","description":"The unique idenfier of the account being provisioned.","example":"CN=Chewy.Bacca,ou=hardcorefigter,ou=wookies,dc=starwars,dc=com"},"accountOperation":{"type":"string","description":"The provisioning operation; typically Create, Modify, Enable, Disable, Unlock, or Delete.","example":"Modify"},"provisioningResult":{"description":"The overall result of the provisioning transaction; this could be success, pending, failed, etc.","enum":["SUCCESS","PENDING","FAILED"],"example":"SUCCESS"},"provisioningTarget":{"type":"string","description":"The name of the provisioning channel selected; this could be the same as the source, or could be a Service Desk Integration Module (SDIM).","example":"Corp AD"},"ticketId":{"nullable":true,"type":"string","description":"A reference to a tracking number, if this is sent to a Service Desk Integration Module (SDIM).","example":"72619262"},"attributeRequests":{"nullable":true,"description":"A list of attributes as part of the provisioning transaction.","type":"array","items":{"type":"object","required":["attributeName","operation"],"properties":{"attributeName":{"type":"string","description":"The name of the attribute being provisioned.","example":"memberOf"},"attributeValue":{"nullable":true,"type":"string","description":"The value of the attribute being provisioned.","example":"CN=jedi,DC=starwars,DC=com"},"operation":{"enum":["Add","Set","Remove"],"description":"The operation to handle the attribute.","example":"Add"}}}}}}}}},{"title":"Saved Search Complete","type":"object","required":["fileName","ownerEmail","ownerName","query","searchName","searchResults","signedS3Url"],"properties":{"fileName":{"type":"string","description":"A name for the report file.","example":"Modified.zip"},"ownerEmail":{"type":"string","description":"The email address of the identity that owns the saved search.","example":"test@sailpoint.com"},"ownerName":{"type":"string","description":"The name of the identity that owns the saved search.","example":"Cloud Support"},"query":{"type":"string","description":"The search query that was used to generate the report.","example":"modified:[now-7y/d TO now]"},"searchName":{"type":"string","description":"The name of the saved search.","example":"Modified Activity"},"searchResults":{"type":"object","description":"A preview of the search results for each object type. This includes a count as well as headers, and the first several rows of data, per object type.","properties":{"Account":{"description":"A table of accounts that match the search criteria.","nullable":true,"type":"object","required":["count","noun","preview"],"properties":{"count":{"type":"string","description":"The number of rows in the table.","example":3},"noun":{"type":"string","description":"The type of object represented in the table.","example":"accounts"},"preview":{"description":"A sample of the data in the table.","type":"array","items":{"type":"array","items":{"type":"string","example":"Robert.Chase"},"example":[]}}}},"Entitlement":{"description":"A table of entitlements that match the search criteria.","nullable":true,"type":"object","required":["count","noun","preview"],"properties":{"count":{"type":"string","description":"The number of rows in the table.","example":2},"noun":{"type":"string","description":"The type of object represented in the table.","example":"entitlements"},"preview":{"description":"A sample of the data in the table.","type":"array","items":{"type":"array","items":{"type":"string","example":"Administrator"},"example":[]}}}},"Identity":{"description":"A table of identities that match the search criteria.","nullable":true,"type":"object","required":["count","noun","preview"],"properties":{"count":{"type":"string","description":"The number of rows in the table.","example":2},"noun":{"type":"string","description":"The type of object represented in the table.","example":"identities"},"preview":{"description":"A sample of the data in the table.","type":"array","items":{"type":"array","items":{"type":"string","example":"Carol Shelby"},"example":[]}}}}}},"signedS3Url":{"type":"string","description":"The Amazon S3 URL to download the report from.","example":"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"}}},{"type":"object","required":["id","nativeIdentifier","sourceId","sourceName","identityId","identityName","attributes"],"properties":{"uuid":{"type":"string","description":"Source unique identifier for the identity. UUID is generated by the source system.","example":"b7264868-7201-415f-9118-b581d431c688"},"id":{"type":"string","description":"SailPoint generated unique identifier.","example":"ee769173319b41d19ccec35ba52f237b"},"nativeIdentifier":{"type":"string","description":"Unique ID of the account on the source.","example":"E009"},"sourceId":{"type":"string","description":"The ID of the source.","example":"2c918082814e693601816e09471b29b6"},"sourceName":{"type":"string","description":"The name of the source.","example":"Active Directory"},"identityId":{"type":"string","description":"The ID of the identity that is corellated with this account.","example":"ee769173319b41d19ccec6c235423237b"},"identityName":{"type":"string","description":"The name of the identity that is corellated with this account.","example":"john.doe"},"attributes":{"type":"object","additionalProperties":true,"description":"The attributes of the account. The contents of attributes depends on the account schema for the source.","example":{"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"}}}},{"type":"object","required":["id","nativeIdentifier","sourceId","sourceName","identityId","identityName","attributes"],"properties":{"uuid":{"type":"string","description":"Source unique identifier for the identity. UUID is generated by the source system.","example":"b7264868-7201-415f-9118-b581d431c688"},"id":{"type":"string","description":"SailPoint generated unique identifier.","example":"ee769173319b41d19ccec35ba52f237b"},"nativeIdentifier":{"type":"string","description":"Unique ID of the account on the source.","example":"E009"},"sourceId":{"type":"string","description":"The ID of the source.","example":"2c918082814e693601816e09471b29b6"},"sourceName":{"type":"string","description":"The name of the source.","example":"Active Directory"},"identityId":{"type":"string","description":"The ID of the identity that is corellated with this account.","example":"ee769173319b41d19ccec6c235423237b"},"identityName":{"type":"string","description":"The name of the identity that is corellated with this account.","example":"john.doe"},"attributes":{"type":"object","additionalProperties":true,"description":"The attributes of the account. The contents of attributes depends on the account schema for the source.","example":{"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"}}}},{"type":"object","required":["id","nativeIdentifier","sourceId","sourceName","identityId","identityName","attributes"],"properties":{"uuid":{"type":"string","description":"Source unique identifier for the identity. UUID is generated by the source system.","example":"b7264868-7201-415f-9118-b581d431c688"},"id":{"type":"string","description":"SailPoint generated unique identifier.","example":"ee769173319b41d19ccec35ba52f237b"},"nativeIdentifier":{"type":"string","description":"Unique ID of the account on the source.","example":"E009"},"sourceId":{"type":"string","description":"The ID of the source.","example":"2c918082814e693601816e09471b29b6"},"sourceName":{"type":"string","description":"The name of the source.","example":"Active Directory"},"identityId":{"type":"string","description":"The ID of the identity that is corellated with this account.","example":"ee769173319b41d19ccec6c235423237b"},"identityName":{"type":"string","description":"The name of the identity that is corellated with this account.","example":"john.doe"},"attributes":{"type":"object","additionalProperties":true,"description":"The attributes of the account. The contents of attributes depends on the account schema for the source.","example":{"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"}}}},{"title":"Source Created","type":"object","required":["id","name","type","created","connector","actor"],"properties":{"id":{"type":"string","description":"The unique ID of the source.","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"Human friendly name of the source.","example":"Test source"},"type":{"type":"string","description":"The connection type.","example":"DIRECT_CONNECT"},"created":{"type":"string","format":"date-time","description":"The date and time the source was created.","example":"2021-03-29T22:01:50.474Z"},"connector":{"type":"string","description":"The connector type used to connect to the source.","example":"active-directory"},"actor":{"required":["id","name","type"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that created the source.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}}}},{"title":"Source Deleted","type":"object","required":["id","name","type","deleted","connector","actor"],"properties":{"id":{"type":"string","description":"The unique ID of the source.","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"Human friendly name of the source.","example":"Test source"},"type":{"type":"string","description":"The connection type.","example":"DIRECT_CONNECT"},"deleted":{"type":"string","format":"date-time","description":"The date and time the source was deleted.","example":"2021-03-29T22:01:50.474Z"},"connector":{"type":"string","description":"The connector type used to connect to the source.","example":"active-directory"},"actor":{"required":["id","name","type"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that deleted the source.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}}}},{"title":"Source Updated","type":"object","required":["id","name","type","modified","connector","actor"],"properties":{"id":{"type":"string","description":"The unique ID of the source.","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"The user friendly name of the source.","example":"Corporate Active Directory"},"type":{"type":"string","description":"The connection type of the source.","example":"DIRECT_CONNECT"},"modified":{"type":"string","format":"date-time","description":"The date and time the source was modified.","example":"2021-03-29T22:01:50.474Z"},"connector":{"type":"string","description":"The connector type used to connect to the source.","example":"active-directory"},"actor":{"required":["type","name"],"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity or system that performed the update.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}}}},{"title":"VA Cluster Status Change Event","type":"object","required":["created","type","application","healthCheckResult","previousHealthCheckResult"],"properties":{"created":{"type":"string","format":"date-time","description":"The date and time the status change occurred.","example":"2020-06-29T22:01:50.474Z"},"type":{"enum":["SOURCE","CLUSTER"],"description":"The type of the object that initiated this event.","example":"CLUSTER"},"application":{"type":"object","description":"Details about the `CLUSTER` or `SOURCE` that initiated this event.","required":["id","name","attributes"],"properties":{"id":{"type":"string","description":"The GUID of the application","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"The name of the application","example":"Production VA Cluster"},"attributes":{"type":"object","description":"Custom map of attributes for a source. This will only be populated if type is `SOURCE` and the source has a proxy.","additionalProperties":true,"nullable":true,"example":null}}},"healthCheckResult":{"type":"object","description":"The results of the most recent health check.","required":["message","resultType","status"],"properties":{"message":{"type":"string","description":"Detailed message of the result of the health check.","example":"Test Connection failed with exception. Error message - java.lang Exception"},"resultType":{"type":"string","description":"The type of the health check result.","example":"SOURCE_STATE_ERROR_CLUSTER"},"status":{"enum":["Succeeded","Failed"],"description":"The status of the health check.","example":"Succeeded"}}},"previousHealthCheckResult":{"type":"object","description":"The results of the last health check.","required":["message","resultType","status"],"properties":{"message":{"type":"string","description":"Detailed message of the result of the health check.","example":"Test Connection failed with exception. Error message - java.lang Exception"},"resultType":{"type":"string","description":"The type of the health check result.","example":"SOURCE_STATE_ERROR_CLUSTER"},"status":{"enum":["Succeeded","Failed"],"description":"The status of the health check.","example":"Failed"}}}}}]},"outputSchema":{"type":"string","description":"The JSON schema of the response that will be sent by the subscribed service to the trigger in response to an event. This only applies to a trigger type of `REQUEST_RESPONSE`.","nullable":true,"example":"{\"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":{"description":"An example of the JSON payload that will be sent by the subscribed service to the trigger in response to an event.","nullable":true,"oneOf":[{"title":"Access Request Dynamic Approver","type":"object","nullable":true,"required":["id","name","type"],"properties":{"id":{"type":"string","description":"The unique ID of the identity to add to the approver list for the access request.","example":"2c91808b6ef1d43e016efba0ce470906"},"name":{"type":"string","description":"The name of the identity to add to the approver list for the access request.","example":"Adam Adams"},"type":{"enum":["IDENTITY","GOVERNANCE_GROUP"],"description":"The type of object being referenced.","example":"IDENTITY"}}},{"title":"Access Request Pre Approval","type":"object","required":["approved","comment","approver"],"properties":{"approved":{"type":"boolean","description":"Whether or not to approve the access request.","example":false},"comment":{"type":"string","description":"A comment about the decision to approve or deny the request.","example":"This access should be denied, because this will cause an SOD violation."},"approver":{"type":"string","description":"The name of the entity that approved or denied the request.","example":"AcmeCorpExternalIntegration"}}}]}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["sp:trigger-service-subscriptions:read"]}],"method":"get","path":"/triggers","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Triggers","description":{"content":"Gets a list of triggers that are available in the tenant.","type":"text/plain"},"url":{"path":["triggers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields:\n\n**id** **name**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Triggers' (list-triggers)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Triggers + + + +Gets a list of triggers that are available in the tenant. + +
Query Parameters
+ +List of triggers. + +
Schema array
    exampleInput object
    + +An example of the JSON payload that will be sent by the trigger to the subscribed service. + +
    oneOf
    requestedFor object
    requestedItems object[]
    + +The access items that are being requested. + +
    requestedBy object
    requestedFor object
    requestedItemsStatus object[]
    + +Details on the outcome of each access item. + +
    clientMetadata object
    + +Additional customer defined metadata about the access item. + +
    approvalInfo object[]
    + +A list of one or more approvers for the access request. + +
    approver object
    requestedBy object
    requestedFor object
    requestedItems object[]
    + +Details of the access items being requested. + +
    requestedBy object
    source object
    stats object
    + +Overall statistics about the account aggregation. + +
    identity object
    source object
    + +The source that contains the account. + +
    account object
    + +Details of the account where the attributes changed. + +
    changes object[]
    + +A list of attributes that changed. + +
    oldValue object
    + +The previous value of the attribute. + +
    oneOf
  • string
  • boolean
  • string
    • newValue object
    + +The new value of the attribute. + +
    oneOf
  • string
  • boolean
  • string
    • identity object
    source object
    + +The source from which the account came from. + +
    account object
    attributes object
    + +The attributes associated with the account. Attributes are unique per source. + +
    source object
    + +Reference to the source that has been aggregated. + +
    stats object
    + +Overall statistics about the account collection. + +
    identity object
    source object
    account object
    campaign object
    + +Details about the certification campaign that was activated. + +
    campaignOwner object
    + +Details of the identity that owns the campaign. + +
    campaign object
    + +Details about the certification campaign that ended. + +
    campaignOwner object
    + +Details of the identity that owns the campaign. + +
    campaign object
    + +Details about the campaign that was generated. + +
    campaignOwner object
    + +The identity that owns the campaign. + +
    certification object
    campaignRef object
    reviewer object
    + +A reference to the reviewer of the campaign. + +
    reassignment object
    + +A reference to a reviewer that this campaign has been reassigned to. + +
    from object
    + +The previous certification + +
    reviewer object
    + +Certification reviewer + +
    identity object
    changes object[]
    + +A list of one or more identity attributes that changed on the identity. + +
    oldValue object
    + +The value of the identity attribute before it changed. + +
    oneOf
  • string
  • boolean
  • string
    • newValue object
    + +The value of the identity attribute after it changed. + +
    oneOf
  • string
  • boolean
  • string
    • identity object
    attributes object
    + +The attributes assigned to the identity. Attributes are determined by the identity profile. + +
    identity object
    attributes object
    + +The attributes assigned to the identity. Attributes are determined by the identity profile. + +
    recipient object
    requester object
    accountRequests object[]
    + +A list of provisioning instructions to perform on an account-by-account basis. + +
    source object
    + +Reference to the source being provisioned against. + +
    attributeRequests object[]
    + +A list of attributes as part of the provisioning transaction. + +
    searchResults object
    + +A preview of the search results for each object type. This includes a count as well as headers, and the first several rows of data, per object type. + +
    Account object
    + +A table of accounts that match the search criteria. + +
    Entitlement object
    + +A table of entitlements that match the search criteria. + +
    Identity object
    + +A table of identities that match the search criteria. + +
    attributes object
    + +The attributes of the account. The contents of attributes depends on the account schema for the source. + +
    attributes object
    + +The attributes of the account. The contents of attributes depends on the account schema for the source. + +
    attributes object
    + +The attributes of the account. The contents of attributes depends on the account schema for the source. + +
    actor object
    actor object
    actor object
    application object
    + +Details about the `CLUSTER` or `SOURCE` that initiated this event. + +
    attributes object
    + +Custom map of attributes for a source. This will only be populated if type is `SOURCE` and the source has a proxy. + +
    healthCheckResult object
    + +The results of the most recent health check. + +
    previousHealthCheckResult object
    + +The results of the last health check. + +
    exampleOutput object
    + +An example of the JSON payload that will be sent by the subscribed service to the trigger in response to an event. + +
    oneOf
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-work-items.api.mdx b/products/idn/api/beta/list-work-items.api.mdx new file mode 100644 index 000000000..4bde8009a --- /dev/null +++ b/products/idn/api/beta/list-work-items.api.mdx @@ -0,0 +1,67 @@ +--- +id: list-work-items +sidebar_label: List Work Items +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listWorkItems","tags":["Work Items"],"description":"This gets a collection of work items belonging to either the specified user(admin required), or the current user.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"ownerId","schema":{"type":"string"},"description":"ID of the work item owner.","required":false}],"responses":{"200":{"description":"List of work items","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the work item","example":"2c9180835d2e5168015d32f890ca1581"},"requesterId":{"type":"string","description":"ID of the requester","example":"2c9180835d2e5168015d32f890ca1581"},"requesterDisplayName":{"type":"string","description":"The displayname of the requester","example":"John Smith"},"ownerId":{"type":"string","description":"The ID of the owner","example":"2c9180835d2e5168015d32f890ca1581"},"ownerName":{"type":"string","description":"The name of the owner","example":"Jason Smith"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z"},"description":{"type":"string","description":"The description of the work item","example":"Create account on source 'AD'"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"},"type":{"type":"string","enum":["UNKNOWN","GENERIC","CERTIFICATION","REMEDIATION","DELEGATION","APPROVAL","VIOLATIONREVIEW","FORM","POLICYVIOLATION","CHALLENGE","IMPACTANALYSIS","SIGNOFF","EVENT","MANUALACTION","TEST"],"example":"GENERIC","description":"The type of the work item"},"remediationItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the certification","example":"2c9180835d2e5168015d32f890ca1581"},"targetId":{"type":"string","description":"The ID of the certification target","example":"2c9180835d2e5168015d32f890ca1581"},"targetName":{"type":"string","description":"The name of the certification target","example":"john.smith"},"targetDisplayName":{"type":"string","description":"The display name of the certification target","example":"emailAddress"},"applicationName":{"type":"string","description":"The name of the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute being certified","example":"phoneNumber"},"attributeOperation":{"type":"string","description":"The operation of the certification on the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute being certified","example":"512-555-1212"},"nativeIdentity":{"type":"string","description":"The native identity of the target","example":"jason.smith2"}}},"approvalItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the approval item","example":"2c9180835d2e5168015d32f890ca1581"},"account":{"type":"string","description":"The account referenced by the approval item","example":"john.smith"},"application":{"type":"string","description":"The name the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute","example":"emailAddress"},"attributeOperation":{"type":"string","description":"The operation of the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute","example":"a@b.com"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"}}},"name":{"type":"string","description":"The work item name","example":"Account Create"},"completed":{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z"},"numItems":{"type":"integer","description":"The number of items in the work item","example":19},"errors":{"type":"array","items":{"type":"string"},"example":["The work item ID that was specified was not found."]}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}}},"method":"get","path":"/work-items","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Work Items","description":{"content":"This gets a collection of work items belonging to either the specified user(admin required), or the current user.","type":"text/plain"},"url":{"path":["work-items"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"ID of the work item owner.","type":"text/plain"},"key":"ownerId","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Work Items' (list-work-items)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Work Items + + + +This gets a collection of work items belonging to either the specified user(admin required), or the current user. + +
Query Parameters
+ +List of work items + +
Schema array
    remediationItems object
    approvalItems object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-workflow-executions.api.mdx b/products/idn/api/beta/list-workflow-executions.api.mdx new file mode 100644 index 000000000..e3295b186 --- /dev/null +++ b/products/idn/api/beta/list-workflow-executions.api.mdx @@ -0,0 +1,97 @@ +--- +id: list-workflow-executions +sidebar_label: List Workflow Executions +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listWorkflowExecutions","tags":["Workflows"],"description":"This lists the executions for a given workflow. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: \n1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. \n2. Get your workflow ID from the response. \n3. You can then do either of the following: \n\n - Filter to find relevant workflow executions.\n For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"`\n\n - You can paginate through results with the `offset` parameter. \n For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. \n Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. ","security":[{"oauth2":["sp:workflow:read"]}],"parameters":[{"name":"id","in":"path","description":"Id of the workflow","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b"}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"example":"status eq \"Failed\"","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**start_time**: *eq, lt, lte, gt, gte*\n\n**status**: *eq*","required":false}],"responses":{"200":{"description":"List of workflow executions for the given workflow","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The workflow execution ID","example":"b393f4e2-4785-4d7f-ab27-3a6b8ded4c81"},"workflowId":{"type":"string","description":"The workflow ID","example":"d201c5d9-d37b-4a2f-af14-66414f39d568"},"requestId":{"type":"string","description":"This backend ID tracks a workflow request in the system. You can provide this ID in a customer support ticket for debugging purposes.","example":"41e12a74fa7b4a6a98ae47887b64acdb"},"startTime":{"type":"string","format":"date-time","description":"The date/time the workflow started","example":"2022-02-07T20:13:29.356648026Z"},"closeTime":{"type":"string","format":"date-time","description":"The date/time the workflow ended","example":"2022-02-07T20:13:31.682410165Z"},"status":{"description":"The workflow execution status","type":"string","enum":["Completed","Failed","Canceled","Running"],"example":"Completed"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/workflows/{id}/executions","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Workflow Executions","description":{"content":"This lists the executions for a given workflow. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: \n1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. \n2. Get your workflow ID from the response. \n3. You can then do either of the following: \n\n - Filter to find relevant workflow executions.\n For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"`\n\n - You can paginate through results with the `offset` parameter. \n For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. \n Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. ","type":"text/plain"},"url":{"path":["workflows",":id","executions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**start_time**: *eq, lt, lte, gt, gte*\n\n**status**: *eq*","type":"text/plain"},"key":"filters","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the workflow","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Workflow Executions' (list-workflow-executions)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Workflow Executions + + + +This lists the executions for a given workflow. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: +1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. +2. Get your workflow ID from the response. +3. You can then do either of the following: + + - Filter to find relevant workflow executions. + For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq "Failed"` + + - You can paginate through results with the `offset` parameter. + For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. + Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. + +
Path Parameters
Query Parameters
+ +List of workflow executions for the given workflow + +
Schema array
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-workflow-library-actions.api.mdx b/products/idn/api/beta/list-workflow-library-actions.api.mdx new file mode 100644 index 000000000..9dae94136 --- /dev/null +++ b/products/idn/api/beta/list-workflow-library-actions.api.mdx @@ -0,0 +1,79 @@ +--- +id: list-workflow-library-actions +sidebar_label: List Workflow Library Actions +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listWorkflowLibraryActions","tags":["Workflows"],"description":"This lists the workflow actions available to you.","externalDocs":{"description":"Additional documentation for each action","url":"https://documentation.sailpoint.com/saas/help/workflows/workflow-steps.html#actions"},"parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq*","example":"id eq \"sp:create-campaign\""}],"security":[{"oauth2":["sp:workflow:read"]}],"responses":{"200":{"description":"List of workflow actions","content":{"application/json":{"schema":{"type":"array","items":{"title":"Workflow Action","type":"object","properties":{"id":{"type":"string","description":"Action ID. This is a static namespaced ID for the action","example":"sp:create-campaign"},"name":{"type":"string","description":"Action Name","example":"Create Certification Campaign"},"type":{"type":"string","description":"Action type","example":"ACTION"},"description":{"type":"string","description":"Action Description","example":"Generates a certification campaign."},"formFields":{"type":"array","description":"One or more inputs that the action accepts","items":{"type":"object","properties":{"helpText":{"type":"string","description":"Describes the form field in the UI","example":"The name to give to this certification campaign."},"label":{"type":"string","description":"A human readable name for this form field in the UI","example":"Campaign Name"},"name":{"type":"string","description":"The name of the input attribute","example":"name"},"required":{"type":"boolean","description":"Denotes if this field is a required attribute","example":false},"type":{"description":"The type of the form field","nullable":true,"enum":["text","textarea","boolean","email","url","number","json","checkbox","jsonpath","select","multiType","duration","toggle","identityPicker","governanceGroupPicker","string","object","array","secret","keyValuePairs","emailPicker","advancedToggle"],"example":"text"}}}},"isDynamicSchema":{"type":"boolean","description":"Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields.","example":false},"outputSchema":{"type":"object","description":"Defines the output schema, if any, that this action produces.","example":{"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"}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/workflow-library/actions","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Workflow Library Actions","description":{"content":"This lists the workflow actions available to you.","type":"text/plain"},"url":{"path":["workflow-library","actions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq*","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Workflow Library Actions' (list-workflow-library-actions)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Workflow Library Actions + + + +This lists the workflow actions available to you. + +
Query Parameters
+ +List of workflow actions + +
Schema array
    formFields object[]
    + +One or more inputs that the action accepts + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-workflow-library-operators.api.mdx b/products/idn/api/beta/list-workflow-library-operators.api.mdx new file mode 100644 index 000000000..90b96ff49 --- /dev/null +++ b/products/idn/api/beta/list-workflow-library-operators.api.mdx @@ -0,0 +1,79 @@ +--- +id: list-workflow-library-operators +sidebar_label: List Workflow Library Operators +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listWorkflowLibraryOperators","tags":["Workflows"],"description":"This lists the workflow operators available to you","security":[{"oauth2":["sp:workflow:read"]}],"responses":{"200":{"description":"List of workflow operators","content":{"application/json":{"schema":{"type":"array","items":{"title":"Workflow Operator","type":"object","properties":{"id":{"type":"string","description":"Operator ID.","example":"sp:compare-boolean"},"name":{"type":"string","description":"Operator friendly name","example":"Compare Boolean Values"},"type":{"description":"Operator type","type":"string","example":"OPERATOR"},"description":{"type":"string","description":"Description of the operator","example":"Compare two boolean values and decide what happens based on the result."},"formFields":{"type":"array","description":"One or more inputs that the operator accepts","items":{"type":"object","properties":{"helpText":{"type":"string","description":"Describes the form field in the UI","example":"The name to give to this certification campaign."},"label":{"type":"string","description":"A human readable name for this form field in the UI","example":"Campaign Name"},"name":{"type":"string","description":"The name of the input attribute","example":"name"},"required":{"type":"boolean","description":"Denotes if this field is a required attribute","example":false},"type":{"description":"The type of the form field","nullable":true,"enum":["text","textarea","boolean","email","url","number","json","checkbox","jsonpath","select","multiType","duration","toggle","identityPicker","governanceGroupPicker","string","object","array","secret","keyValuePairs","emailPicker","advancedToggle"],"example":"text"}}},"example":[{"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"}]}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/workflow-library/operators","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Workflow Library Operators","description":{"content":"This lists the workflow operators available to you","type":"text/plain"},"url":{"path":["workflow-library","operators"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Workflow Library Operators' (list-workflow-library-operators)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Workflow Library Operators + + + +This lists the workflow operators available to you + +
+ +List of workflow operators + +
Schema array
    formFields object[]
    + +One or more inputs that the operator accepts + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-workflow-library-triggers.api.mdx b/products/idn/api/beta/list-workflow-library-triggers.api.mdx new file mode 100644 index 000000000..d7ae43034 --- /dev/null +++ b/products/idn/api/beta/list-workflow-library-triggers.api.mdx @@ -0,0 +1,79 @@ +--- +id: list-workflow-library-triggers +sidebar_label: List Workflow Library Triggers +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listWorkflowLibraryTriggers","tags":["Workflows"],"description":"This lists the workflow triggers available to you","externalDocs":{"description":"Additional documentation for each trigger","url":"https://documentation.sailpoint.com/saas/help/workflows/workflow-steps.html#triggers"},"parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq*","example":"id eq \"idn:identity-attributes-changed\""}],"security":[{"oauth2":["sp:workflow:read"]}],"responses":{"200":{"description":"List of workflow triggers","content":{"application/json":{"schema":{"type":"array","items":{"title":"Workflow Trigger","type":"object","properties":{"id":{"type":"string","description":"Trigger ID. This is a static namespaced ID for the trigger.","example":"idn:identity-attributes-changed"},"type":{"description":"Trigger type","enum":["EVENT","SCHEDULED","EXTERNAL"],"example":"EVENT"},"name":{"type":"string","description":"Trigger Name","example":"Identity Attributes Changed"},"description":{"type":"string","description":"Trigger Description","example":"One or more identity attributes changed."},"isDynamicSchema":{"type":"boolean","description":"Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields.","example":false},"inputExample":{"type":"object","description":"Example trigger payload if applicable","nullable":true,"externalDocs":{"description":"List of triggers and their input schemas","url":"https://developer.sailpoint.com/idn/docs/event-triggers/available"},"example":{"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":{"type":"array","nullable":true,"description":"One or more inputs that the trigger accepts","example":[],"items":{"type":"object","properties":{"helpText":{"type":"string","description":"Describes the form field in the UI","example":"The name to give to this certification campaign."},"label":{"type":"string","description":"A human readable name for this form field in the UI","example":"Campaign Name"},"name":{"type":"string","description":"The name of the input attribute","example":"name"},"required":{"type":"boolean","description":"Denotes if this field is a required attribute","example":false},"type":{"description":"The type of the form field","nullable":true,"enum":["text","textarea","boolean","email","url","number","json","checkbox","jsonpath","select","multiType","duration","toggle","identityPicker","governanceGroupPicker","string","object","array","secret","keyValuePairs","emailPicker","advancedToggle"],"example":"text"}}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/workflow-library/triggers","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Workflow Library Triggers","description":{"content":"This lists the workflow triggers available to you","type":"text/plain"},"url":{"path":["workflow-library","triggers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq*","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Workflow Library Triggers' (list-workflow-library-triggers)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Workflow Library Triggers + + + +This lists the workflow triggers available to you + +
Query Parameters
+ +List of workflow triggers + +
Schema array
    formFields object[]
    + +One or more inputs that the trigger accepts + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-workflows.api.mdx b/products/idn/api/beta/list-workflows.api.mdx new file mode 100644 index 000000000..93eac9758 --- /dev/null +++ b/products/idn/api/beta/list-workflows.api.mdx @@ -0,0 +1,99 @@ +--- +id: list-workflows +sidebar_label: List Workflows +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listWorkflows","tags":["Workflows"],"description":"List all workflows in the tenant.","security":[{"oauth2":["sp:workflow:read"]}],"responses":{"200":{"description":"List of workflows","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","description":"Workflow ID. This is a UUID generated upon creation.","example":"d201c5e9-d37b-4aff-af14-66414f39d569"},"executionCount":{"type":"integer","format":"int32","description":"The number of times this workflow has been executed","example":2},"failureCount":{"type":"integer","format":"int32","description":"The number of times this workflow has failed during execution","example":0},"created":{"type":"string","format":"date-time","description":"The date and time the workflow was created","example":"2022-01-10T16:06:16.636381447Z"},"creator":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that created the workflow.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}},"example":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"}}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the workflow","example":"Send Email"},"owner":{"description":"The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request.","properties":{"type":{"type":"string","enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"},"id":{"type":"string","description":"The unique ID of the object","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The name of the object","example":"William Wilson"}}},"description":{"type":"string","description":"Description of what the workflow accomplishes","example":"Send an email to the identity who's attributes changed."},"definition":{"type":"object","description":"The map of steps that the workflow will execute.","properties":{"start":{"type":"string","description":"The name of the starting step.","example":"Send Email Test"},"steps":{"type":"object","description":"One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type.","additionalProperties":true,"example":{"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":{"type":"boolean","description":"Enable or disable the workflow. Workflows cannot be created in an enabled state.","default":false,"example":false},"trigger":{"type":"object","description":"The trigger that starts the workflow","required":["type","attributes"],"properties":{"type":{"type":"string","enum":["EVENT","EXTERNAL","SCHEDULED"],"example":"EVENT","description":"The trigger type"},"attributes":{"anyOf":[{"title":"Event Trigger Attributes","type":"object","description":"Attributes related to an IdentityNow ETS event","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the trigger","example":"idn:identity-attributes-changed"},"filter.$":{"type":"string","description":"JSON path expression that will limit which events the trigger will fire on","example":"$.changes[?(@.attribute == 'manager')]"}}},{"title":"External Trigger Attributes","type":"object","description":"Attributes related to an external trigger","required":["name"],"properties":{"name":{"type":"string","description":"A unique name for the external trigger","example":"search-and-notify"},"description":{"type":"string","description":"Additonal context about the external trigger","example":"Run a search and notify the results"}}},{"title":"Scheduled Trigger Attributes","type":"object","description":"Attributes related to a scheduled trigger","required":["cronString"],"properties":{"cronString":{"type":"string","description":"A valid CRON expression","externalDocs":{"description":"CRON expression editor","url":"https://crontab.guru/"},"example":"0 * */3 */5 *"}}}],"description":"Workflow Trigger Attributes."}}}}}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/workflows","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Workflows","description":{"content":"List all workflows in the tenant.","type":"text/plain"},"url":{"path":["workflows"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Workflows' (list-workflows)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Workflows + + + +List all workflows in the tenant. + +
+ +List of workflows + +
Schema array
    creator object
    + +The identity that created the workflow. + +
    owner
    + +The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request. + +
    definition object
    + +The map of steps that the workflow will execute. + +
    steps object
    + +One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. + +
    trigger object
    + +The trigger that starts the workflow + +
    attributes object
    + +Workflow Trigger Attributes. + +
    anyOf
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/list-workgroups.api.mdx b/products/idn/api/beta/list-workgroups.api.mdx new file mode 100644 index 000000000..5c64d24eb --- /dev/null +++ b/products/idn/api/beta/list-workgroups.api.mdx @@ -0,0 +1,79 @@ +--- +id: list-workgroups +sidebar_label: List Governance Groups +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listWorkgroups","tags":["Governance Groups"],"description":"This API returns list of Governance Groups","parameters":[{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"limit","description":"Note that for this API the maximum value for limit is 50.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":50,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":50,"default":50}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"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, modified**","example":"name,-modified","required":false}],"responses":{"200":{"description":"List of Governance Groups","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"owner":{"description":"Owner of the Governance Group","type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable name of the owner","example":"William Wilson"},"displayName":{"type":"string","description":"Human-readable display name of the owner","example":"William"},"emailAddress":{"type":"string","description":"Email ID of the owner","example":"william@sailpoint.com"}}},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"description":{"type":"string","description":"Description of the Governance Group","example":"Description of the Governance Group"},"memberCount":{"type":"integer","format":"int64","example":1641498673000,"description":"Number of members in the Governance Group."},"connectionCount":{"type":"integer","format":"int64","example":1641498673000,"description":"Number of connections in the Governance Group."}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:workgroup:read","idn:workgroup:write"]}],"method":"get","path":"/workgroups","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List Governance Groups","description":{"content":"This API returns list of Governance Groups","type":"text/plain"},"url":{"path":["workgroups"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Note that for this API the maximum value for limit is 50.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"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, modified**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Governance Groups' (list-workgroups)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Governance Groups + + + +This API returns list of Governance Groups + +
Query Parameters
+ +List of Governance Groups + +
Schema array
    owner object
    + +Owner of the Governance Group + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/managed-clients.tag.mdx b/products/idn/api/beta/managed-clients.tag.mdx new file mode 100644 index 000000000..3f2f14d9e --- /dev/null +++ b/products/idn/api/beta/managed-clients.tag.mdx @@ -0,0 +1,20 @@ +--- +id: managed-clients +title: "Managed Clients" +description: "Managed Clients" +custom_edit_url: null +--- + + + +Read and write operations for managing client data and statuses + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/managed-clusters.tag.mdx b/products/idn/api/beta/managed-clusters.tag.mdx new file mode 100644 index 000000000..caa92bd5f --- /dev/null +++ b/products/idn/api/beta/managed-clusters.tag.mdx @@ -0,0 +1,20 @@ +--- +id: managed-clusters +title: "Managed Clusters" +description: "Managed Clusters" +custom_edit_url: null +--- + + + +Operations for accessing and managing client Clusters, including Log Configuration + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/mfa-configuration.tag.mdx b/products/idn/api/beta/mfa-configuration.tag.mdx new file mode 100644 index 000000000..7e2e38e1c --- /dev/null +++ b/products/idn/api/beta/mfa-configuration.tag.mdx @@ -0,0 +1,20 @@ +--- +id: mfa-configuration +title: "MFA Configuration" +description: "MFA Configuration" +custom_edit_url: null +--- + + + +Configure and test multifactor authentication (MFA) methods + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/move.api.mdx b/products/idn/api/beta/move.api.mdx new file mode 100644 index 000000000..d93ec6e33 --- /dev/null +++ b/products/idn/api/beta/move.api.mdx @@ -0,0 +1,95 @@ +--- +id: move +sidebar_label: Reassign Certifications +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:certification:write"]}],"operationId":"move","tags":["Certification Campaigns"],"description":"This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.","deprecated":true,"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The certification campaign ID","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"certificationIds":{"description":"List of certification IDs to reassign","type":"array","items":{"type":"string"},"minItems":1,"maxItems":250,"example":["af3859464779471211bb8424a563abc1","af3859464779471211bb8424a563abc2","af3859464779471211bb8424a563abc3"]},"reassignTo":{"type":"object","properties":{"id":{"type":"string","description":"The identity ID to which the review is being assigned.","example":"ef38f94347e94562b5bb8424a56397d8"},"type":{"type":"string","description":"The type of the ID provided.","enum":["IDENTITY"],"example":"IDENTITY"}}},"reason":{"type":"string","description":"Comment to explain why the certification was reassigned","example":"reassigned for some reason"}}}}}},"responses":{"202":{"description":"The reassign task that has been submitted.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the certification task.","example":"2c918086719eec070171a7e3355a360a"},"type":{"type":"string","description":"The type of the certification task. More values may be added in the future.","enum":["REASSIGN","ADMIN_REASSIGN","COMPLETE_CERTIFICATION","FINISH_CERTIFICATION","COMPLETE_CAMPAIGN","ACTIVATE_CAMPAIGN","CAMPAIGN_CREATE","CAMPAIGN_DELETE"],"example":"ADMIN_REASSIGN"},"targetType":{"type":"string","description":"The type of item that is being operated on by this task whose ID is stored in the targetId field.","enum":["CERTIFICATION","CAMPAIGN"],"example":"CAMPAIGN"},"targetId":{"type":"string","description":"The ID of the item being operated on by this task.","example":"2c918086719eec070171a7e3355a834c"},"status":{"type":"string","description":"The status of the task.","enum":["QUEUED","IN_PROGRESS","SUCCESS","ERROR"]},"errors":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}},"description":"A list of errors that have been encountered by the task."},"created":{"type":"string","description":"The date and time on which this task was created.","format":"date-time","example":"2020-09-24T18:10:47.693Z"}}},"example":{"id":"2c918086719eec070171a7e3355a360a","type":"ADMIN_REASSIGN","targetType":"CAMPAIGN","targetId":"2c918086719eec070171a7e3355a834c","status":"QUEUED","errors":[],"created":"2020-09-24T18:10:47.693Z"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/campaigns/{id}/reassign","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"certificationIds":["af3859464779471211bb8424a563abc1","af3859464779471211bb8424a563abc2","af3859464779471211bb8424a563abc3"],"reassignTo":{"id":"ef38f94347e94562b5bb8424a56397d8","type":"IDENTITY"},"reason":"reassigned for some reason"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Reassign Certifications","description":{"content":"This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["campaigns",":id","reassign"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The certification campaign ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Reassign Certifications' (move)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Reassign Certifications + +:::caution deprecated + +This endpoint has been deprecated and may be removed in future versions of the API. + +::: + +This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + +
Path Parameters
Request Body required
    = 1`, `<= 250`"} defaultValue={undefined}>
    reassignTo object
+ +The reassign task that has been submitted. + +
Schema
    errors object[]
    + +A list of errors that have been encountered by the task. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/non-employee-lifecycle-management.tag.mdx b/products/idn/api/beta/non-employee-lifecycle-management.tag.mdx new file mode 100644 index 000000000..73f9ce4de --- /dev/null +++ b/products/idn/api/beta/non-employee-lifecycle-management.tag.mdx @@ -0,0 +1,51 @@ +--- +id: non-employee-lifecycle-management +title: "Non-Employee Lifecycle Management" +description: "Non-Employee Lifecycle Management" +custom_edit_url: null +--- + + + +Use this API to implement non-employee lifecycle management functionality. +With this functionality in place, administrators can create non-employee records and configure them for use in their organizations. +This allows organizations to provide secure access to non-employees and control that access. + +The 'non-employee' term refers to any consultant, contractor, intern, or other user in an organization who is not a full-time permanent employee. +Organizations can track non-employees' access and activity in IdentityNow by creating and maintaining non-employee sources. +Organizations can have a maximum of 50 non-employee sources. + +By using SailPoint's Non-Employee Lifecycle Management functionality, you agree to the following: + +- SailPoint is not responsible for storing sensitive data. +You may only add account attributes to non-employee identities that are necessary for business operations and are consistent with your contractual limitations on data that may be sent or stored in IdentityNow. + +- You are responsible for regularly downloading your list of non-employee accounts for all the sources you create and storing this list of accounts in a managed location to maintain an authoritative system of record and backup data for these accounts. + +To manage non-employees in IdentityNow, administrators must create a non-employee source and add accounts to the source. + +To create a non-employee source in IdentityNow, administrators must use the Admin panel to go to Connections > Sources. +They must then specify 'Non-Employee' in the 'Source Type' field. +Refer to [Creating a Non-Employee Source](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#creating-a-non-employee-source) for more details about how to create non-employee sources. + +To add accounts to a non-employee source in IdentityNow, administrators can select the non-employee source and add the accounts. +They can also use the 'Manage Non-Employees' widget on their user dashboards to reach the list of sources and then select the non-employee source they want to add the accounts to. + +Administrators can either add accounts individually or in bulk. Each non-employee source can have a maximum of 20,000 accounts. +To add accounts in bulk, they must select the 'Bulk Upload' option and upload a CSV file. +Refer to [Adding Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#adding-accounts) for more details about how to add accounts to non-employee sources. + +Once administrators have created the non-employee source and added accounts to it, they can create identity profiles to generate identities for the non-employee accounts and manage the non-employee identities the same way they would any other identities. + +Refer to [Managing Non-Employee Sources and Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html) for more information about non-employee lifecycle management. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/notifications.tag.mdx b/products/idn/api/beta/notifications.tag.mdx new file mode 100644 index 000000000..ac2c40aac --- /dev/null +++ b/products/idn/api/beta/notifications.tag.mdx @@ -0,0 +1,16 @@ +--- +id: notifications +title: "Notifications" +description: "Notifications" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/o-auth-clients.tag.mdx b/products/idn/api/beta/o-auth-clients.tag.mdx new file mode 100644 index 000000000..c97b2f1aa --- /dev/null +++ b/products/idn/api/beta/o-auth-clients.tag.mdx @@ -0,0 +1,23 @@ +--- +id: o-auth-clients +title: "OAuth Clients" +description: "OAuth Clients" +custom_edit_url: null +--- + + + +Use this API to implement OAuth client functionality. +With this functionality in place, users with the appropriate security scopes can create and configure OAuth clients to use as a way to obtain authorization to use the IdentityNow REST API. +Refer to [Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information about OAuth and how it works with the IdentityNow REST API. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/org-config.tag.mdx b/products/idn/api/beta/org-config.tag.mdx new file mode 100644 index 000000000..85bc228af --- /dev/null +++ b/products/idn/api/beta/org-config.tag.mdx @@ -0,0 +1,20 @@ +--- +id: org-config +title: "Org Config" +description: "Org Config" +custom_edit_url: null +--- + + + +Operations for managing org configuration settings (eg. time zone) + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/password-configuration.tag.mdx b/products/idn/api/beta/password-configuration.tag.mdx new file mode 100644 index 000000000..519fb6269 --- /dev/null +++ b/products/idn/api/beta/password-configuration.tag.mdx @@ -0,0 +1,26 @@ +--- +id: password-configuration +title: "Password Configuration" +description: "Password Configuration" +custom_edit_url: null +--- + + + +Use this API to implement organization password configuration functionality. +With this functionality in place, organization administrators can create organization-specific password configurations. + +These configurations include details like custom password instructions, as well as digit token length and duration. + +Refer to [Configuring User Authentication for Password Resets](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html) for more information about organization password configuration functionality. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/password-dictionary.tag.mdx b/products/idn/api/beta/password-dictionary.tag.mdx new file mode 100644 index 000000000..cf79ae7a4 --- /dev/null +++ b/products/idn/api/beta/password-dictionary.tag.mdx @@ -0,0 +1,67 @@ +--- +id: password-dictionary +title: "Password Dictionary" +description: "Password Dictionary" +custom_edit_url: null +--- + + + +Use this API to implement password dictionary functionality. +With this functionality in place, administrators can create password dictionaries to prevent users from using certain words or characters in their passwords. + +A password dictionary is a list of words or characters that users are prevented from including in their passwords. +This can help protect users from themselves and force them to create passwords that are not easy to break. + +A password dictionary must meet the following requirements to for the API to handle them correctly: + +- It must be in .txt format. + +- All characters must be UTF-8 characters. + +- Each line must contain a single word or character with no spaces or whitespace characters. + +- It must contain at least one line other than the locale string. + +- Each line must not exceed 128 characters. + +- The file must not exceed 2500 lines. + +Administrators should also consider the following when they create their dictionaries: + +- Lines starting with a # represent comments. + +- All words in the password dictionary are case-insensitive. +For example, adding the word "password" to the dictionary also disallows the following: PASSWORD, Password, and PassWord. + +- The dictionary uses substring matching. +For example, adding the word "spring" to the dictionary also disallows the following: Spring124, 345SprinG, and 8spring. +Users can then select 'Change Password' to update their passwords. + +Administrators must do the following to create a password dictionary: + +- Create the text file that will contain the prohibited password values. + +- If the dictionary is not in English, they must add a locale string to the top line: locale:`languageCode`_`countryCode` + +The languageCode value refers to the language's 2-letter ISO 639-1 code. +The countryCode value refers to the country's 2-letter ISO 3166-1 code. + +Refer to this list https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html to see all the available ISO 639-1 language codes and ISO 3166-1 country codes. + +- Upload the .txt file to IdentityNow with [Update Password Dictionary](https://developer.sailpoint.com/idn/api/beta/update-password-dictionary). Uploading a new file always overwrites the previous dictionary file. + +Administrators can then specify which password policies check new passwords against the password dictionary by doing the following: In the Admin panel, they can use the Password Mgmt dropdown menu to select Policies, select the policy, and select the 'Prevent use of words in this site's password dictionary' checkbox beside it. + +Refer to [Configuring Advanced Password Management Options](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html) for more information about password dictionaries. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/password-management.tag.mdx b/products/idn/api/beta/password-management.tag.mdx new file mode 100644 index 000000000..07f739c1d --- /dev/null +++ b/products/idn/api/beta/password-management.tag.mdx @@ -0,0 +1,44 @@ +--- +id: password-management +title: "Password Management" +description: "Password Management" +custom_edit_url: null +--- + + + +Use this API to implement password management functionality. +With this functionality in place, users can manage their identity passwords for all their applications. + +In IdentityNow, users can select their names in the upper right corner of the page and use the drop-down menu to select Password Manager. +Password Manager lists the user's identity's applications, possibly grouped to share passwords. +Users can then select 'Change Password' to update their passwords. + +Grouping passwords allows users to update their passwords more broadly, rather than requiring them to update each password individually. +Password Manager may list the applications and sources in the following groups: + +- Password Group: This refers to a group of applications that share a password. +For example, a user can use the same password for Google Drive, Google Mail, and YouTube. +Updating the password for the password group updates the password for all its included applications. + +- Multi-Application Source: This refers to a source with multiple applications that share a password. +For example, a user can have a source, G Suite, that includes the Google Calendar, Google Drive, and Google Mail applications. +Updating the password for the multi-application source updates the password for all its included applications. + +- Applications: These are applications that do not share passwords with other applications. + +An organization may require some authentication for users to update their passwords. +Users may be required to answer security questions or use a third-party authenticator before they can confirm their updates. + +Refer to [Managing Passwords](https://documentation.sailpoint.com/saas/user-help/accounts/passwords.html) for more information about password management. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/password-sync-groups.tag.mdx b/products/idn/api/beta/password-sync-groups.tag.mdx new file mode 100644 index 000000000..7225d1112 --- /dev/null +++ b/products/idn/api/beta/password-sync-groups.tag.mdx @@ -0,0 +1,52 @@ +--- +id: password-sync-groups +title: "Password Sync Groups" +description: "Password Sync Groups" +custom_edit_url: null +--- + + + +Use this API to implement password sync group functionality. +With this functionality in place, administrators can group sources into password sync groups so that all their applications share the same password. +This allows users to update the password for all the applications in a sync group if they want, rather than updating each password individually. + +A password sync group is a group of applications that shares a password. +Administrators create these groups by grouping the applications' sources. +For example, an administrator can group the ActiveDirectory, GitHub, and G Suite sources together so that all those sources' applications can also be grouped to share a password. +A user can then update his or her password for ActiveDirectory, GitHub, Gmail, Google Drive, and Google Calendar all at once, rather then updating each one individually. + +The following are required for administrators to create a password sync group in IdentityNow: + +- At least two direct connect sources connected to IdentityNow and configured for Password Management. + +- Each authentication source in a sync group must have at least one application. Refer to [Adding and Resetting Application Passwords](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html#adding-and-resetting-application-passwords) for more information about adding applications to sources. + +- At least one password policy. Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/policies.html) for more information about password policies. + +In the Admin panel in IdentityNow, administrators can use the Password Mgmt dropdown menu to select Sync Groups. +To create a sync group, administrators must provide a name, choose a password policy to be enforced across the sources in the sync group, and select the sources to include in the sync group. + +Administrators can also delete sync groups in IdentityNow, but they should know the following before they do: + +- Passwords related to the associated sources will become independent, so changing one will not change the others anymore. + +- Passwords for the sources' connected applications will also become independent. + +- Password policies assigned to the sync group are then assigned directly to the associated sources. +To change the password policy for a source, administrators must edit it directly. + +Once the password sync group has been created, users can update the password for the group in Password Manager. + +Refer to [Managing Password Sync Groups](https://documentation.sailpoint.com/saas/help/pwd/sync_grps.html) for more information about password sync groups. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/patch-access-profile.api.mdx b/products/idn/api/beta/patch-access-profile.api.mdx new file mode 100644 index 000000000..862aeddf9 --- /dev/null +++ b/products/idn/api/beta/patch-access-profile.api.mdx @@ -0,0 +1,122 @@ +--- +id: patch-access-profile +sidebar_label: Patch a specified Access Profile +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchAccessProfile","tags":["Access Profiles"],"description":"This API updates an existing Access Profile. The following fields are patchable:\n**name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria**\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer.\n> The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters.\n\n> You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source.\n\n> Patching the value of the **requestable** field is only supported for customers enabled with the new Request Center. Otherwise, attempting to modify this field results in a 400 error.","parameters":[{"name":"id","in":"path","description":"ID of the Access Profile to patch","required":true,"schema":{"type":"string","example":"2c91808a7813090a017814121919ecca"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"examples":{"Add Entitlements":{"description":"Add one or more entitlements to the end of the list","value":[{"op":"add","path":"/entitlements","value":[{"id":"2c9180857725c14301772a93bb77242d","type":"ENTITLEMENT","name":"AD User Group"}]}]},"Insert Entitlement":{"description":"Add an entitlement at the beginning of the entitlement list","value":[{"op":"add","path":"/entitlements/0","value":{"id":"2c9180857725c14301772a93bb77242d","type":"ENTITLEMENT","name":"AD User Group"}}]},"Replace Entitlements":{"description":"Replace all entitlements with a new list of entitlements","value":[{"op":"replace","path":"/entitlements","value":[{"id":"2c9180857725c14301772a93bb77242d","type":"ENTITLEMENT","name":"AD User Group"}]}]},"Remove Entitlement":{"description":"Remove the first entitlement in the list","value":[{"op":"remove","path":"/entitlements/0"}]}}}},"required":true},"responses":{"200":{"description":"Responds with the Access Profile as updated.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Access Profile","example":"2c91808a7190d06e01719938fcd20792","readOnly":true},"name":{"type":"string","description":"Name of the Access Profile","example":"Employee-database-read-write"},"description":{"type":"string","nullable":true,"description":"Information about the Access Profile","example":"Collection of entitlements to read/write the employee database"},"created":{"type":"string","description":"Date the Access Profile was created","format":"date-time","example":"2021-03-01T22:32:58.104Z","readOnly":true},"modified":{"type":"string","description":"Date the Access Profile was last modified.","format":"date-time","example":"2021-03-02T20:22:28.104Z","readOnly":true},"enabled":{"type":"boolean","description":"Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement.","example":true},"owner":{"description":"Owner of the Access Profile","type":"object","nullable":true,"properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"source":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Source with with which the Access Profile is associated","example":"2c91809773dee3610173fdb0b6061ef4"},"type":{"type":"string","enum":["SOURCE"],"description":"The type of the Source, will always be SOURCE","example":"SOURCE"},"name":{"type":"string","description":"The display name of the associated Source","example":"ODS-AD-SOURCE"}}},"entitlements":{"type":"array","description":"A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement.","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Entitlement","example":"2c91809773dee32014e13e122092014e"},"type":{"type":"string","enum":["ENTITLEMENT"],"description":"The type of the Entitlement, will always be ENTITLEMENT","example":"ENTITLEMENT"},"name":{"type":"string","description":"The display name of the Entitlement","example":"CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"}}}},"requestable":{"type":"boolean","description":"Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error.","example":true},"accessRequestConfig":{"nullable":true,"description":"Access request configuration for this object","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":true},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":true},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"revocationRequestConfig":{"nullable":true,"description":"Revocation request configuration for this object.","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":false,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":false,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the revocation request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"segments":{"type":"array","nullable":true,"items":{"type":"string"},"description":"List of IDs of segments, if any, to which this Access Profile is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]},"provisioningCriteria":{"description":"When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression is evaluated against those Accounts to choose one to provision with the Access Profile.","nullable":true,"example":{"operation":"OR","children":[{"operation":"AND","children":[{"attribute":"dn","operation":"CONTAINS","value":"useast"},{"attribute":"manager","operation":"CONTAINS","value":"Scott.Clark"}]},{"operation":"AND","children":[{"attribute":"dn","operation":"EQUALS","value":"Gibson"},{"attribute":"telephoneNumber","operation":"CONTAINS","value":"512"}]}]},"type":"object","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","nullable":true,"description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines matching criteria for an Account to be provisioned with a specific Access Profile","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","nullable":true,"description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines matching criteria for an Account to be provisioned with a specific Access Profile","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.","example":null}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.","example":null}}}},"required":["owner","name","source"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:access-profile:manage"]}],"method":"patch","path":"/access-profiles/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Patch a specified Access Profile","description":{"content":"This API updates an existing Access Profile. The following fields are patchable:\n**name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria**\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer.\n> The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters.\n\n> You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source.\n\n> Patching the value of the **requestable** field is only supported for customers enabled with the new Request Center. Otherwise, attempting to modify this field results in a 400 error.","type":"text/plain"},"url":{"path":["access-profiles",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Access Profile to patch","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch a specified Access Profile' (patch-access-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch a specified Access Profile + + + +This API updates an existing Access Profile. The following fields are patchable: +**name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** +A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. +> The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. + +> You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source. + +> Patching the value of the **requestable** field is only supported for customers enabled with the new Request Center. Otherwise, attempting to modify this field results in a 400 error. + +
Path Parameters
Request Body array required
    value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    anyOf
  • string
  • integer
    • anyOf
  • string
  • integer
+ +Responds with the Access Profile as updated. + +
Schema
    owner object
    + +Owner of the Access Profile + +
    source object
    entitlements object[]
    + +A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. + +
    accessRequestConfig object
    + +Access request configuration for this object + +
    approvalSchemes object[]
    + +List describing the steps in approving the request + +
    revocationRequestConfig object
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]
    + +List describing the steps in approving the revocation request + +
    provisioningCriteria object
    + +When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression is evaluated against those Accounts to choose one to provision with the Access Profile. + +
    children object[]
    + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + +
    children object[]
    + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/patch-campaign-template.api.mdx b/products/idn/api/beta/patch-campaign-template.api.mdx new file mode 100644 index 000000000..19eada110 --- /dev/null +++ b/products/idn/api/beta/patch-campaign-template.api.mdx @@ -0,0 +1,146 @@ +--- +id: patch-campaign-template +sidebar_label: Update a Campaign Template +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchCampaignTemplate","tags":["Certification Campaigns"],"description":"Allows updating individual fields on a campaign template using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the campaign template being modified.","example":"2c9180835d191a86015d28455b4a2329"}],"requestBody":{"required":true,"description":"A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nThe following fields are patchable:\n* name\n* description\n* deadlineDuration\n* campaign (all fields that are allowed during create)\n","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object"}},"example":[{"op":"replace","path":"/description","value":"Updated description!"},{"op":"replace","path":"/campaign/filter/id","value":"ff80818155fe8c080155fe8d925b0316"}]}}},"responses":{"200":{"description":"Indicates the PATCH operation succeeded, and returns the template's new representation.","content":{"application/json":{"schema":{"type":"object","description":"Campaign Template","properties":{"id":{"type":"string","description":"Id of the campaign template","example":"2c9079b270a266a60170a277bb960008"},"name":{"type":"string","description":"This template's name. Has no bearing on generated campaigns' names.","example":"Manager Campaign Template"},"description":{"type":"string","description":"This template's description. Has no bearing on generated campaigns' descriptions.","example":"Template for the annual manager campaign."},"created":{"type":"string","description":"Creation date of Campaign Template","readOnly":true,"format":"date-time","example":"2020-03-05T22:44:00.364Z"},"modified":{"type":"string","description":"Modification date of Campaign Template","readOnly":true,"format":"date-time","example":"2020-03-05T22:52:09.969Z"},"scheduled":{"type":"boolean","readOnly":true,"description":"Indicates if this campaign template has been scheduled.","example":false},"ownerRef":{"type":"object","description":"The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user.","properties":{"id":{"type":"string","description":"Id of the owner","example":"2c918086676d3e0601677611dbde220f"},"type":{"type":"string","enum":["IDENTITY"],"description":"Type of the owner","example":"IDENTITY"},"name":{"type":"string","description":"Name of the owner","example":"Mister Manager"},"email":{"type":"string","description":"Email of the owner","example":"mr.manager@example.com"}}},"deadlineDuration":{"type":"string","description":"The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign's deadline would be 2020-01-15 (the current date plus 14 days).","example":"P2W"},"campaign":{"type":"object","title":"Campaign","allOf":[{"type":"object","title":"Slim Campaign","required":["name","description","type"],"properties":{"id":{"type":"string","readOnly":true,"description":"Id of the campaign","example":"2c9079b270a266a60170a2779fcb0007"},"name":{"description":"The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","type":"string","example":"Manager Campaign"},"description":{"type":"string","description":"The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","example":"Everyone needs to be reviewed by their manager"},"deadline":{"type":"string","format":"date-time","description":"The campaign's completion deadline.","example":"2020-03-15T10:00:01.456Z"},"type":{"type":"string","description":"The type of campaign. Could be extended in the future.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"},"emailNotificationEnabled":{"type":"boolean","description":"Enables email notification for this campaign","default":false,"example":false},"autoRevokeAllowed":{"type":"boolean","description":"Allows auto revoke for this campaign","default":false,"example":false},"recommendationsEnabled":{"type":"boolean","description":"Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.","default":false,"example":true},"status":{"type":"string","description":"The campaign's current status.","readOnly":true,"enum":["PENDING","STAGED","CANCELING","ACTIVATING","ACTIVE","COMPLETING","COMPLETED","ERROR","ARCHIVED"],"example":"ACTIVE"},"correlatedStatus":{"type":"string","description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"}}},{"type":"object","properties":{"created":{"type":"string","readOnly":true,"format":"date-time","description":"Created time of the campaign","example":"2020-03-03T22:15:13.611Z"},"modified":{"type":"string","readOnly":true,"format":"date-time","description":"Modified time of the campaign","example":"2020-03-03T22:20:12.674Z"},"correlatedStatus":{"description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"},"filter":{"type":"object","description":"Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank.","properties":{"id":{"type":"string","description":"The ID of whatever type of filter is being used.","example":"0fbe863c063c4c88a35fd7f17e8a3df5"},"type":{"type":"string","description":"Type of the filter","enum":["CAMPAIGN_FILTER","RULE"],"example":"CAMPAIGN_FILTER"},"name":{"type":"string","description":"Name of the filter","example":"Test Filter"}}},"sunsetCommentsRequired":{"type":"boolean","description":"Determines if comments on sunset date changes are required.","default":true,"example":true},"sourceOwnerCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SOURCE_OWNER.","properties":{"sourceIds":{"type":"array","description":"The list of sources to be included in the campaign.","items":{"type":"string"},"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]}}},"searchCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SEARCH.","properties":{"type":{"type":"string","description":"The type of search campaign represented.","enum":["IDENTITY","ACCESS"],"example":"ACCESS"},"description":{"type":"string","description":"Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available.","example":"Search Campaign description"},"reviewer":{"description":"If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"query":{"type":"string","description":"The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set.","example":"Search Campaign query description"},"identityIds":{"type":"array","description":"A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set.","items":{"type":"string"},"maxItems":1000,"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]},"accessConstraints":{"type":"array","description":"Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT","ACCESS_PROFILE","ROLE"],"description":"Type of Access","example":"ENTITLEMENT"},"ids":{"description":"Must be set only if operator is SELECTED.","type":"array","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"operator":{"type":"string","enum":["ALL","SELECTED"],"description":"Used to determine whether the scope of the campaign should be reduced for selected ids or all.","example":"SELECTED"}},"required":["type","operator"]},"maxItems":1000}},"required":["type"]},"roleCompositionCampaignInfo":{"type":"object","description":"Optional configuration options for role composition campaigns.","properties":{"reviewer":{"description":"If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"roleIds":{"type":"array","description":"Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"remediatorRef":{"type":"object","description":"This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin.","properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Legal Remediator Type","example":"IDENTITY"},"id":{"type":"string","description":"The ID of the remediator.","example":"2c90ad2a70ace7d50170acf22ca90010"},"name":{"type":"string","description":"The name of the remediator.","readOnly":true,"example":"Role Admin"}},"required":["type","id"]},"query":{"type":"string","description":"Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","example":"Search Query"},"description":{"type":"string","description":"Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available.","example":"Role Composition Description"}},"required":["remediatorRef"]},"alerts":{"type":"array","description":"A list of errors and warnings that have accumulated.","readOnly":true,"items":{"type":"object","properties":{"level":{"type":"string","enum":["ERROR","WARN","INFO"],"description":"Denotes the level of the message","example":"ERROR"},"localizations":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}},"totalCertifications":{"type":"integer","description":"The total number of certifications in this campaign.","readOnly":true,"example":100},"completedCertifications":{"type":"integer","description":"The number of completed certifications in this campaign.","readOnly":true,"example":10},"sourcesWithOrphanEntitlements":{"type":"array","description":"A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented).","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the source","example":"2c90ad2a70ace7d50170acf22ca90010"},"type":{"type":"string","enum":["SOURCE"],"description":"Type","example":"SOURCE"},"name":{"type":"string","description":"Name of the source","example":"Source with orphan entitlements"}}}},"mandatoryCommentRequirement":{"type":"string","description":"Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.","enum":["ALL_DECISIONS","REVOKE_ONLY_DECISIONS","NO_DECISIONS"],"example":"NO_DECISIONS"}}}]}},"required":["name","description","created","modified","campaign"]},"examples":{"Manager":{"value":{"id":"e7dbec99d49349c8951bd84f58a05120","name":"Manager Review","created":"2022-08-02T19:16:42.632Z","modified":null,"description":"A review of everyone's access by their manager.","deadlineDuration":"P14D","ownerRef":{"email":"support@testmail.identitysoon.com","type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"scheduled":false,"campaign":{"created":null,"modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c","name":"Test Manager Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":null,"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":null,"completedCertifications":null,"sourcesWithOrphanEntitlements":null,"id":null,"name":"Manager Review","description":"Review everyone's access.","deadline":null,"type":"MANAGER","status":null,"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"}}},"Search":{"value":{"id":"b7e6459eed5247ac8b98a5fed81fe27f","name":"Reporting Access Review","created":"2022-07-28T19:19:40.035Z","modified":null,"description":"A review of everyone's access to the reporting system.","deadlineDuration":"P14D","ownerRef":{"email":"support@testmail.identitysoon.com","type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"scheduled":false,"campaign":{"created":null,"modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c","name":"Test Search Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":{"type":"ACCESS","description":"Identities with reporting abilities","reviewerId":null,"reviewer":null,"query":"@access(name: (\"reporter\"))","identityIds":null,"accessConstraints":[]},"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":null,"completedCertifications":null,"sourcesWithOrphanEntitlements":null,"id":null,"name":"Search Campaign Review","description":"Review everyone's access to the reporting system.","deadline":null,"type":"SEARCH","status":null,"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"}}},"Source Owner":{"value":{"id":"b9f41bc69e7a4291b9de0630396d030d","name":"AD Source Review","created":"2022-08-02T13:40:36.857Z","modified":null,"description":"A review of our AD source.","deadlineDuration":"P1M","ownerRef":{"email":"support@testmail.identitysoon.com","type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"scheduled":false,"campaign":{"created":null,"modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"e0adaae69852e8fe8b8a3d48e5ce757c","name":"Test Source Owner Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":{"sourceIds":["2c918084707deba501709d45ce4e5569"]},"searchCampaignInfo":null,"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":null,"completedCertifications":null,"sourcesWithOrphanEntitlements":null,"id":null,"name":"AD Source Review","description":"Review everyone's access.","deadline":null,"type":"SOURCE_OWNER","status":null,"emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"}}},"RoleComposition":{"value":{"id":"b9f41bc69e7a4291b9de0630396d030d","name":"Campaign With Admin Role","created":"2022-08-02T13:40:36.857Z","modified":null,"description":"Campaign With Admin Role","deadlineDuration":null,"ownerRef":{"email":"support@testmail.identitysoon.com","type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"scheduled":false,"campaign":{"created":null,"modified":null,"filter":null,"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":null,"roleCompositionCampaignInfo":{"remediatorRef":{"type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"reviewerId":null,"reviewer":null,"roleIds":["b15d609fc5c8434b865fe552315fda8f"],"query":null,"description":null},"alerts":null,"totalCertifications":null,"completedCertifications":null,"sourcesWithOrphanEntitlements":null,"id":null,"name":"Campaign With Admin Role","description":"Campaign With Admin Role","deadline":null,"type":"ROLE_COMPOSITION","status":null,"emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/campaign-templates/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update a Campaign Template","description":{"content":"Allows updating individual fields on a campaign template using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.","type":"text/plain"},"url":{"path":["campaign-templates",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the campaign template being modified.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a Campaign Template' (patch-campaign-template)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a Campaign Template + + + +Allows updating individual fields on a campaign template using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +
Path Parameters
Request Body array required
+ +A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +The following fields are patchable: +* name +* description +* deadlineDuration +* campaign (all fields that are allowed during create) + + +
+ +Indicates the PATCH operation succeeded, and returns the template's new representation. + +
Schema
    ownerRef object
    + +The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user. + +
    campaign object
    filter object
    + +Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank. + +
    sourceOwnerCampaignInfo object
    + +Must be set only if the campaign type is SOURCE_OWNER. + +
    searchCampaignInfo object
    + +Must be set only if the campaign type is SEARCH. + +
    reviewer object
    + +If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP + +
    accessConstraints object[]
    + +**Possible values:** `<= 1000` + +
    + +Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. + +
    roleCompositionCampaignInfo object
    + +Optional configuration options for role composition campaigns. + +
    reviewer object
    + +If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP + +
    remediatorRef object
    + +This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin. + +
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
    localizations object[]
    sourcesWithOrphanEntitlements object[]
    + +A list of sources in the campaign that contain \"orphan entitlements\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/patch-entitlement.api.mdx b/products/idn/api/beta/patch-entitlement.api.mdx new file mode 100644 index 000000000..a83685813 --- /dev/null +++ b/products/idn/api/beta/patch-entitlement.api.mdx @@ -0,0 +1,109 @@ +--- +id: patch-entitlement +sidebar_label: Patch an entitlement +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchEntitlement","tags":["Entitlements"],"description":"This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.\n\nThe following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**.\n\nWhen you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.\n\nA token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:entitlement:manage"]}],"parameters":[{"name":"id","in":"path","description":"ID of the entitlement to patch","required":true,"schema":{"type":"string","example":"2c91808a7813090a017814121e121518"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}},"example":[{"op":"replace","path":"/requestable","value":true}]},"examples":{"Make an entitlement requestable and privileged in one call":{"description":"This example shows how multiple fields may be updated with a single patch call.","value":[{"op":"replace","path":"/requestable","value":true},{"op":"replace","path":"/privileged","value":true}]},"Assign an entitlement to a segment":{"description":"This example shows how to use patch to assign an entitlement to a segment by adding the segment's ID to the entitlement's segments array.","value":[{"op":"add","path":"/segments/-","value":"f7b1b8a3-5fed-4fd4-ad29-82014e137e19"}]},"Assign an owner to an entitlement":{"description":"This example shows how to use patch to assign an owner to an entitlement by adding the owner's info to the entitlement.","value":[{"op":"add","path":"/owner","value":{"type":"IDENTITY","id":"2c9180858315595501831958427e5424"}}]},"Replace an owner for an entitlement":{"description":"This example shows how to use patch to replace an entitlement's owner by replacing the owner's info to the entitlement.","value":[{"op":"replace","path":"/owner","value":{"type":"IDENTITY","id":"2c9180858315595501831958427e5424"}}]},"Set entitlement manually updated fields":{"description":"This example shows how to set an entitlement's manually updated fields values with patch request. Values for all manually updateable fields must be specified in the request. For now only two entitlement fields support this: DISPLAY_NAME and DESCRIPTION.","value":[{"op":"replace","path":"/manuallyUpdatedFields","value":{"DISPLAY_NAME":true,"DESCRIPTION":true}}]},"Add the description for an entitlement":{"description":"This example shows how to use patch to add a description for the entitlement.","value":[{"op":"add","path":"/description","value":"new description for the entitlement"}]},"Update the name for an entitlement":{"description":"This example shows how to use patch to update an entitlement's name.","value":[{"op":"replace","path":"/name","value":"entitlement new name"}]}}}}},"responses":{"200":{"description":"Responds with the entitlement as updated.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The entitlement id","example":"2c91808874ff91550175097daaec161c"},"name":{"type":"string","description":"The entitlement name","example":"LauncherTest2"},"created":{"type":"string","description":"Time when the entitlement was created","format":"date-time","example":"2020-10-08T18:33:52.029Z"},"modified":{"type":"string","description":"Time when the entitlement was last modified","format":"date-time","example":"2020-10-08T18:33:52.029Z"},"attribute":{"type":"string","description":"The entitlement attribute name","example":"memberOf"},"value":{"type":"string","description":"The value of the entitlement","example":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local"},"sourceSchemaObjectType":{"type":"string","description":"The object type of the entitlement from the source schema","example":"group"},"privileged":{"type":"boolean","default":false,"description":"True if the entitlement is privileged","example":true},"cloudGoverned":{"type":"boolean","default":false,"description":"True if the entitlement is cloud governed","example":true},"description":{"type":"string","description":"The description of the entitlement","example":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local"},"requestable":{"type":"boolean","default":false,"description":"True if the entitlement is requestable","example":true},"attributes":{"type":"object","description":"A map of free-form key-value pairs from the source system","example":{"fieldName":"fieldValue"},"additionalProperties":true},"source":{"type":"object","properties":{"id":{"type":"string","description":"The source ID","example":"2c9180827ca885d7017ca8ce28a000eb"},"type":{"type":"string","description":"The source type, will always be \"SOURCE\"","example":"SOURCE"},"name":{"type":"string","description":"The source name","example":"ODS-AD-Source"}}},"owner":{"type":"object","description":"Simplified DTO for the owner object of the entitlement","properties":{"id":{"type":"string","description":"The owner id for the entitlement","example":"2a2fdacca5e345f18bf7970cfbb8fec2"},"name":{"type":"string","description":"The owner name for the entitlement","example":"identity 1"},"type":{"type":"string","enum":["IDENTITY"],"description":"The type of the owner. Initially only type IDENTITY is supported","example":"IDENTITY"}}},"directPermissions":{"type":"array","items":{"type":"object","description":"Simplified DTO for the Permission objects stored in SailPoint's database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers.","properties":{"rights":{"type":"array","description":"All the rights (e.g. actions) that this permission allows on the target","readOnly":true,"items":{"type":"string","example":"SELECT"}},"target":{"type":"string","description":"The target the permission would grants rights on.","readOnly":true,"example":"SYS.GV_$TRANSACTION"}}}},"segments":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of IDs of segments, if any, to which this Entitlement is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]},"manuallyUpdatedFields":{"description":"Object contains entitlement manually updated fields. Field value is true if is was updated manually via entitlement import csv or patch endpoint. Field value is false if that property value has not been changed after first entitlement aggregation. Values for all manually updatable fields must be specified. For now only two entitlement fields support this: DISPLAY_NAME and DESCRIPTION.","example":{"DISPLAY_NAME":true,"DESCRIPTION":true},"type":"object","properties":{"DISPLAY_NAME":{"type":"boolean","default":false,"description":"True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation.\nField refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property.","example":true},"DESCRIPTION":{"type":"boolean","default":false,"description":"True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation.\nField refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property.","example":true}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/entitlements/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/requestable","value":true}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Patch an entitlement","description":{"content":"This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.\n\nThe following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**.\n\nWhen you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.\n\nA token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["entitlements",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the entitlement to patch","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch an entitlement' (patch-entitlement)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch an entitlement + + + +This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**. + +When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. + +A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API. + +
Path Parameters
Request Body array
    value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    anyOf
  • string
  • integer
    • anyOf
  • string
  • integer
+ +Responds with the entitlement as updated. + +
Schema
    attributes object
    + +A map of free-form key-value pairs from the source system + +
    source object
    owner object
    + +Simplified DTO for the owner object of the entitlement + +
    directPermissions object[]
    manuallyUpdatedFields object
    + +Object contains entitlement manually updated fields. Field value is true if is was updated manually via entitlement import csv or patch endpoint. Field value is false if that property value has not been changed after first entitlement aggregation. Values for all manually updatable fields must be specified. For now only two entitlement fields support this: DISPLAY_NAME and DESCRIPTION. + +
    `name` property."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}> `description` property."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/patch-form-definition.api.mdx b/products/idn/api/beta/patch-form-definition.api.mdx new file mode 100644 index 000000000..a98ca7db2 --- /dev/null +++ b/products/idn/api/beta/patch-form-definition.api.mdx @@ -0,0 +1,91 @@ +--- +id: patch-form-definition +sidebar_label: Patch a form definition. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Custom Forms"],"description":"Parameter `{formDefinitionID}` should match a form definition ID.","operationId":"patchFormDefinition","parameters":[{"name":"formDefinitionID","in":"path","description":"Form definition ID","required":true,"schema":{"type":"string","x-go-name":"FormDefinitionID"},"example":"00000000-0000-0000-0000-000000000000","x-go-name":"FormDefinitionID"}],"requestBody":{"description":"Body is the request payload to patch a form definition, check: https://jsonpatch.com","content":{"application/json":{"schema":{"title":"Patch is an ordered collection of Operations.","description":"Patch is an ordered collection of Operations.","type":"array","example":[{"op":"replace","path":"/description","value":"a new description"}],"items":{"title":"Operation is a single JSON-Patch step, such as a single 'add' operation.","type":"object","additionalProperties":{"type":"object","properties":{}},"x-go-package":"github.com/evanphx/json-patch"},"x-go-package":"github.com/evanphx/json-patch"},"example":[{"op":"replace","path":"/description","value":"test-description"}]}},"required":false},"responses":{"200":{"description":"Returns the form definition updated","content":{"application/json":{"schema":{"properties":{"created":{"description":"Created is the date the form definition was created","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Created"},"description":{"description":"Description is the form definition description","example":"My form description","type":"string","x-go-name":"Description"},"formConditions":{"description":"FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form","items":{"description":"FormCondition represent a form conditional","properties":{"effects":{"description":"Effects is a list of effects","items":{"description":"ConditionEffect is the effect produced by a condition","properties":{"config":{"additionalProperties":{},"description":"Config is a arbitrary map that holds a configuration based on EffectType","example":{},"type":"object","x-go-name":"Config"},"effectType":{"description":"EffectType is the type of effect to perform when the conditions are evaluated for this logic block\nHIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","enum":["HIDE","SHOW","DISABLE","ENABLE","REQUIRE","OPTIONAL","SUBMIT_MESSAGE","SUBMIT_NOTIFICATION","SET_DEFAULT_VALUE"],"example":"HIDE","type":"string","x-go-enum-desc":"HIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","x-go-name":"EffectType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Effects"},"ruleOperator":{"description":"RuleOperator is a ConditionRuleLogicalOperatorType value\nAND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","enum":["AND","OR"],"example":"AND","type":"string","x-go-enum-desc":"AND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","x-go-name":"RuleOperator"},"rules":{"description":"Rules is a list of rules","items":{"properties":{"operator":{"description":"Operator is a ConditionRuleComparisonOperatorType value\nEQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","enum":["EQ","NE","CO","NOT_CO","IN","NOT_IN","EM","NOT_EM","SW","NOT_SW","EW","NOT_EW"],"example":"EQ","type":"string","x-go-enum-desc":"EQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","x-go-name":"Operator"},"source":{"description":"Source, if the sourceType is ConditionRuleSourceTypeInput then the source type is the name of the form input to accept. While if the sourceType is ConditionRuleSourceTypeElement\nthen source is the name of a technical key of an element to retrieve its value","example":"department","type":"string","x-go-name":"Source"},"sourceType":{"description":"SourceType defines what type of object is being selected. Either a reference to a form input (by input name), or a form element (by technical key)\nINPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","enum":["INPUT","ELEMENT"],"example":"ELEMENT","type":"string","x-go-enum-desc":"INPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","x-go-name":"SourceType"},"value":{"description":"Value is the value based on the ValueType","example":"Engineering","x-go-name":"Value"},"valueType":{"description":"ValueType is a ConditionRuleValueType type\nSTRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","enum":["STRING","STRING_LIST","INPUT","ELEMENT","LIST","BOOLEAN"],"example":"STRING","type":"string","x-go-enum-desc":"STRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","x-go-name":"ValueType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Rules"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormConditions"},"formElements":{"description":"FormElements is a list of nested form elements","items":{"properties":{"config":{"additionalProperties":{},"description":"Config is a config object","example":{"label":"Department"},"type":"object","x-go-name":"Config"},"elementType":{"description":"ElementType is a FormElementType value\nTEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","enum":["TEXT","TOGGLE","TEXTAREA","HIDDEN","PHONE","EMAIL","SELECT","DATE","SECTION","COLUMNS"],"example":"TEXT","type":"string","x-go-enum-desc":"TEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","x-go-name":"ElementType"},"id":{"description":"ID is a form element identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"key":{"description":"Key is the technical key","example":"department","type":"string","x-go-name":"Key"},"validations":{"description":"FormElementValidationsSet is a set of FormElementValidation items","example":[{"validationType":"REQUIRED"}],"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormElements"},"formInput":{"description":"FormInput is a list of form inputs that are required when creating a form-instance object","items":{"properties":{"description":{"description":"Description is the description for this form input value","example":"A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic","type":"string","x-go-name":"Description"},"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"label":{"description":"Label is the name for this form input value","example":"input1","type":"string","x-go-name":"Label"},"type":{"description":"Type is a FormDefinitionInputType value\nSTRING FormDefinitionInputTypeString","enum":["STRING"],"example":"STRING","type":"string","x-go-enum-desc":"STRING FormDefinitionInputTypeString","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormInput"},"id":{"description":"FormDefinitionID is a unique guid identifying this form definition","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"FormDefinitionID"},"modified":{"description":"Modified is the last date the form definition was modified","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Modified"},"name":{"description":"Name is the form definition name","example":"My form","type":"string","x-go-name":"Name"},"owner":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a FormOwnerType value\nIDENTITY FormOwnerTypeIdentity","enum":["IDENTITY"],"example":"IDENTITY","type":"string","x-go-enum-desc":"IDENTITY FormOwnerTypeIdentity","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"usedBy":{"description":"UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used","items":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a FormUsedByType value\nWORKFLOW FormUsedByTypeWorkflow\nSOURCE FormUsedByTypeSource","enum":["WORKFLOW","SOURCE"],"example":"WORKFLOW","type":"string","x-go-enum-desc":"WORKFLOW FormUsedByTypeWorkflow\nSOURCE FormUsedByTypeSource","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"UsedBy"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}}}},"400":{"description":"An error with the request occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"401":{"description":"An error with the authorization occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"403":{"description":"An error with the user permissions occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"404":{"description":"An error with the user permissions occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"title":"Error is the standard API error response type.","type":"object","properties":{"detailCode":{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"trackingId":{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"}}}},"500":{"description":"An internal server error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}}},"security":[{"oauth2":["sp:forms:manage"]}],"x-codegen-request-body-name":"Body","method":"patch","path":"/form-definitions/{formDefinitionID}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"a new description"}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Patch a form definition.","description":{"content":"Parameter `{formDefinitionID}` should match a form definition ID.","type":"text/plain"},"url":{"path":["form-definitions",":formDefinitionID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Form definition ID","type":"text/plain"},"type":"any","value":"","key":"formDefinitionID"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch a form definition.' (patch-form-definition)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch a form definition. + + + +Parameter `{formDefinitionID}` should match a form definition ID. + +
Path Parameters
Request Body array
+ +Body is the request payload to patch a form definition, check: https://jsonpatch.com + +
  • property name* object
+ +Returns the form definition updated + +
Schema
    formConditions object[]
    + +FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form + +
    effects object[]
    + +Effects is a list of effects + +
    config object
    + +Config is a arbitrary map that holds a configuration based on EffectType + +
    rules object[]
    + +Rules is a list of rules + +
    formElements object[]
    + +FormElements is a list of nested form elements + +
    config object
    + +Config is a config object + +
    formInput object[]
    + +FormInput is a list of form inputs that are required when creating a form-instance object + +
    owner object
    usedBy object[]
    + +UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used + +
+ +An error with the request occurred + +
Schema
    messages object[]
+ +An error with the authorization occurred + +
Schema
    messages object[]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
+ +Too many requests + +
Schema
    messages object[]
+ +An internal server error occurred + +
Schema
    messages object[]
\ No newline at end of file diff --git a/products/idn/api/beta/patch-form-instance.api.mdx b/products/idn/api/beta/patch-form-instance.api.mdx new file mode 100644 index 000000000..5368435a6 --- /dev/null +++ b/products/idn/api/beta/patch-form-instance.api.mdx @@ -0,0 +1,107 @@ +--- +id: patch-form-instance +sidebar_label: Patch a form instance. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Custom Forms"],"description":"Parameter `{formInstanceID}` should match a form instance ID.","operationId":"patchFormInstance","parameters":[{"name":"formInstanceID","in":"path","description":"Form instance ID","required":true,"schema":{"type":"string","x-go-name":"FormInstanceID"},"example":"00000000-0000-0000-0000-000000000000","x-go-name":"FormInstanceID"}],"requestBody":{"description":"Body is the request payload to patch a form instance, check: https://jsonpatch.com","content":{"application/json":{"schema":{"title":"Patch is an ordered collection of Operations.","description":"Patch is an ordered collection of Operations.","type":"array","example":[{"op":"replace","path":"/description","value":"a new description"}],"items":{"title":"Operation is a single JSON-Patch step, such as a single 'add' operation.","type":"object","additionalProperties":{"type":"object","properties":{}},"x-go-package":"github.com/evanphx/json-patch"},"x-go-package":"github.com/evanphx/json-patch"},"example":[{"op":"replace","path":"/state","value":"SUBMITTED"},{"op":"replace","path":"/formData","value":{"a-key-1":"a-value-1","a-key-2":true,"a-key-3":1}}]}},"required":false},"responses":{"200":{"description":"Returns the form instance updated","content":{"application/json":{"schema":{"properties":{"created":{"description":"Created is the date the form instance was assigned","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Created"},"createdBy":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a form instance created by type enum value\nWORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution\nSOURCE FormInstanceCreatedByTypeSource","enum":["WORKFLOW_EXECUTION","SOURCE"],"example":"WORKFLOW_EXECUTION","type":"string","x-go-enum-desc":"WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution\nSOURCE FormInstanceCreatedByTypeSource","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"expire":{"description":"Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record","example":"2023-08-12T20:14:57.74486Z","type":"string","x-go-name":"Expire"},"formConditions":{"description":"FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form","items":{"description":"FormCondition represent a form conditional","properties":{"effects":{"description":"Effects is a list of effects","items":{"description":"ConditionEffect is the effect produced by a condition","properties":{"config":{"additionalProperties":{},"description":"Config is a arbitrary map that holds a configuration based on EffectType","example":{},"type":"object","x-go-name":"Config"},"effectType":{"description":"EffectType is the type of effect to perform when the conditions are evaluated for this logic block\nHIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","enum":["HIDE","SHOW","DISABLE","ENABLE","REQUIRE","OPTIONAL","SUBMIT_MESSAGE","SUBMIT_NOTIFICATION","SET_DEFAULT_VALUE"],"example":"HIDE","type":"string","x-go-enum-desc":"HIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","x-go-name":"EffectType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Effects"},"ruleOperator":{"description":"RuleOperator is a ConditionRuleLogicalOperatorType value\nAND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","enum":["AND","OR"],"example":"AND","type":"string","x-go-enum-desc":"AND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","x-go-name":"RuleOperator"},"rules":{"description":"Rules is a list of rules","items":{"properties":{"operator":{"description":"Operator is a ConditionRuleComparisonOperatorType value\nEQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","enum":["EQ","NE","CO","NOT_CO","IN","NOT_IN","EM","NOT_EM","SW","NOT_SW","EW","NOT_EW"],"example":"EQ","type":"string","x-go-enum-desc":"EQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","x-go-name":"Operator"},"source":{"description":"Source, if the sourceType is ConditionRuleSourceTypeInput then the source type is the name of the form input to accept. While if the sourceType is ConditionRuleSourceTypeElement\nthen source is the name of a technical key of an element to retrieve its value","example":"department","type":"string","x-go-name":"Source"},"sourceType":{"description":"SourceType defines what type of object is being selected. Either a reference to a form input (by input name), or a form element (by technical key)\nINPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","enum":["INPUT","ELEMENT"],"example":"ELEMENT","type":"string","x-go-enum-desc":"INPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","x-go-name":"SourceType"},"value":{"description":"Value is the value based on the ValueType","example":"Engineering","x-go-name":"Value"},"valueType":{"description":"ValueType is a ConditionRuleValueType type\nSTRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","enum":["STRING","STRING_LIST","INPUT","ELEMENT","LIST","BOOLEAN"],"example":"STRING","type":"string","x-go-enum-desc":"STRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","x-go-name":"ValueType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Rules"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormConditions"},"formData":{"additionalProperties":{},"description":"FormData is the data provided by the form on submit. The data is in a key -> value map","example":{"department":"Engineering"},"type":"object","x-go-name":"FormData"},"formDefinitionId":{"description":"FormDefinitionID is the id of the form definition that created this form","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"FormDefinitionID"},"formElements":{"description":"FormElements is the configuration of the form, this would be a repeat of the fields from the form-config","items":{"properties":{"config":{"additionalProperties":{},"description":"Config is a config object","example":{"label":"Department"},"type":"object","x-go-name":"Config"},"elementType":{"description":"ElementType is a FormElementType value\nTEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","enum":["TEXT","TOGGLE","TEXTAREA","HIDDEN","PHONE","EMAIL","SELECT","DATE","SECTION","COLUMNS"],"example":"TEXT","type":"string","x-go-enum-desc":"TEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","x-go-name":"ElementType"},"id":{"description":"ID is a form element identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"key":{"description":"Key is the technical key","example":"department","type":"string","x-go-name":"Key"},"validations":{"description":"FormElementValidationsSet is a set of FormElementValidation items","example":[{"validationType":"REQUIRED"}],"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormElements"},"formErrors":{"description":"FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors","items":{"properties":{"key":{"description":"Key is the technical key","example":"department","type":"string","x-go-name":"Key"},"messages":{"description":"Messages is a list of web.ErrorMessage items","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"type":"array","x-go-name":"Messages"},"value":{"description":"Value is the value associated with a Key","example":"Engineering","x-go-name":"Value"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormErrors"},"formInput":{"additionalProperties":{},"description":"FormInput is an object of form input labels to value","example":{"input1":"Sales"},"type":"object","x-go-name":"FormInput"},"id":{"description":"FormInstanceID is a unique guid identifying this form instance","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"FormInstanceID"},"modified":{"description":"Modified is the last date the form instance was modified","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Modified"},"recipients":{"description":"Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it","items":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a FormInstanceRecipientType value\nIDENTITY FormInstanceRecipientIdentity","enum":["IDENTITY"],"example":"IDENTITY","type":"string","x-go-enum-desc":"IDENTITY FormInstanceRecipientIdentity","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Recipients"},"standAloneForm":{"default":false,"description":"StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form","example":false,"type":"boolean","x-go-name":"StandAloneForm"},"standAloneFormUrl":{"description":"StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI","example":"https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"StandAloneFormURL"},"state":{"description":"State the state of the form instance\nASSIGNED FormInstanceStateAssigned\nIN_PROGRESS FormInstanceStateInProgress\nSUBMITTED FormInstanceStateSubmitted\nCOMPLETED FormInstanceStateCompleted\nCANCELLED FormInstanceStateCancelled","enum":["ASSIGNED","IN_PROGRESS","SUBMITTED","COMPLETED","CANCELLED"],"example":"ASSIGNED","type":"string","x-go-enum-desc":"ASSIGNED FormInstanceStateAssigned\nIN_PROGRESS FormInstanceStateInProgress\nSUBMITTED FormInstanceStateSubmitted\nCOMPLETED FormInstanceStateCompleted\nCANCELLED FormInstanceStateCancelled","x-go-name":"State"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}}}},"400":{"description":"An error with the request occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"401":{"description":"An error with the authorization occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"403":{"description":"An error with the user permissions occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"404":{"description":"An error with the item not found","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"409":{"description":"An error with the request property conflicts with stored","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"title":"Error is the standard API error response type.","type":"object","properties":{"detailCode":{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"trackingId":{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"}}}},"500":{"description":"An internal server error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}}},"security":[{"oauth2":[]}],"x-codegen-request-body-name":"Body","method":"patch","path":"/form-instances/{formInstanceID}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"a new description"}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Patch a form instance.","description":{"content":"Parameter `{formInstanceID}` should match a form instance ID.","type":"text/plain"},"url":{"path":["form-instances",":formInstanceID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Form instance ID","type":"text/plain"},"type":"any","value":"","key":"formInstanceID"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch a form instance.' (patch-form-instance)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch a form instance. + + + +Parameter `{formInstanceID}` should match a form instance ID. + +
Path Parameters
Request Body array
+ +Body is the request payload to patch a form instance, check: https://jsonpatch.com + +
  • property name* object
+ +Returns the form instance updated + +
Schema
    createdBy object
    formConditions object[]
    + +FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form + +
    effects object[]
    + +Effects is a list of effects + +
    config object
    + +Config is a arbitrary map that holds a configuration based on EffectType + +
    rules object[]
    + +Rules is a list of rules + +
    formData object
    + +FormData is the data provided by the form on submit. The data is in a key -\> value map + +
    formElements object[]
    + +FormElements is the configuration of the form, this would be a repeat of the fields from the form-config + +
    config object
    + +Config is a config object + +
    formErrors object[]
    + +FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors + +
    messages object[]
    + +Messages is a list of web.ErrorMessage items + +
    formInput object
    + +FormInput is an object of form input labels to value + +
    recipients object[]
    + +Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it + +
+ +An error with the request occurred + +
Schema
    messages object[]
+ +An error with the authorization occurred + +
Schema
    messages object[]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
+ +An error with the item not found + +
Schema
    messages object[]
+ +An error with the request property conflicts with stored + +
Schema
    messages object[]
+ +Too many requests + +
Schema
    messages object[]
+ +An internal server error occurred + +
Schema
    messages object[]
\ No newline at end of file diff --git a/products/idn/api/beta/patch-non-employee-record.api.mdx b/products/idn/api/beta/patch-non-employee-record.api.mdx new file mode 100644 index 000000000..a37c2a18a --- /dev/null +++ b/products/idn/api/beta/patch-non-employee-record.api.mdx @@ -0,0 +1,99 @@ +--- +id: patch-non-employee-record +sidebar_label: Patch Non-Employee Record +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchNonEmployeeRecord","security":[{"oauth2":["idn:nelm:manage"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This request will patch a non-employee record.","parameters":[{"in":"path","name":"id","description":"Non-employee record id (UUID)","required":true,"example":"2c91808b6ef1d43e016efba0ce470904","schema":{"type":"string"}}],"requestBody":{"description":"A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.","required":true,"content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"example":[{"op":"replace","path":"/endDate","value":{"2019-08-23T18:40:35.772Z":null}}]}}},"responses":{"200":{"description":"A patched non-employee record.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee record id."},"accountName":{"type":"string","description":"Requested identity account name."},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"sourceId":{"type":"string","description":"Non-Employee's source id.","example":"2c91808568c529c60168cca6f90c1313"},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee."},"startDate":{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2019-08-23T18:52:59.162Z"},"endDate":{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2020-08-23T18:52:59.162Z"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/non-employee-records/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Patch Non-Employee Record","description":{"content":"This request will patch a non-employee record.","type":"text/plain"},"url":{"path":["non-employee-records",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Non-employee record id (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch Non-Employee Record' (patch-non-employee-record)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch Non-Employee Record + + + +This request will patch a non-employee record. + +
Path Parameters
Request Body array required
+ +A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + +
    value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    anyOf
  • string
  • integer
    • anyOf
  • string
  • integer
+ +A patched non-employee record. + +
Schema
    data object
    + +Attribute blob/bag for a non-employee. + +
  • property name* string
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/patch-non-employee-schema-attribute.api.mdx b/products/idn/api/beta/patch-non-employee-schema-attribute.api.mdx new file mode 100644 index 000000000..54dbfbc2f --- /dev/null +++ b/products/idn/api/beta/patch-non-employee-schema-attribute.api.mdx @@ -0,0 +1,96 @@ +--- +id: patch-non-employee-schema-attribute +sidebar_label: Patch Non-Employee Source's Schema Attribute +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchNonEmployeeSchemaAttribute","security":[{"oauth2":["idn:nelm:manage"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This end-point patches a specific schema attribute for a non-employee SourceId.\n","parameters":[{"in":"path","name":"attributeId","schema":{"type":"string"},"required":true,"example":"2c91808b6ef1d43e016efba0ce470904","description":"The Schema Attribute Id (UUID)"},{"in":"path","name":"sourceId","schema":{"type":"string"},"required":true,"example":"2c91808b6ef1d43e016efba0ce470904","description":"The Source id"}],"requestBody":{"description":"A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'.","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"example":[{"op":"replace","path":"/label","value":{"new attribute label":null}}]}},"required":true},"responses":{"200":{"description":"The Schema Attribute was successfully patched.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"UUID","example":"ac110005-7156-1150-8171-5b292e3e0084","description":"Schema Attribute Id"},"system":{"type":"boolean","description":"True if this schema attribute is mandatory on all non-employees sources.","example":true},"modified":{"type":"string","format":"date-time","description":"When the schema attribute was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the schema attribute was created.","example":"2019-08-23T18:40:35.772Z"},"type":{"type":"string","enum":["TEXT","DATE","IDENTITY"],"description":"Enum representing the type of data a schema attribute accepts."},"label":{"type":"string","description":"Label displayed on the UI for this schema attribute.","example":"Account Name"},"technicalName":{"type":"string","description":"The technical name of the attribute. Must be unique per source.","example":"account.name"},"helpText":{"type":"string","description":"help text displayed by UI.","example":"The unique identifier for the account"},"placeholder":{"type":"string","description":"Hint text that fills UI box.","example":"Enter a unique user name for this account."},"required":{"type":"boolean","description":"If true, the schema attribute is required for all non-employees in the source","example":true}},"required":["type","technicalName","label"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/non-employee-sources/{sourceId}/schema-attributes/{attributeId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Patch Non-Employee Source's Schema Attribute","description":{"content":"This end-point patches a specific schema attribute for a non-employee SourceId.\n","type":"text/plain"},"url":{"path":["non-employee-sources",":sourceId","schema-attributes",":attributeId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Schema Attribute Id (UUID)","type":"text/plain"},"type":"any","value":"","key":"attributeId"},{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch Non-Employee Source's Schema Attribute' (patch-non-employee-schema-attribute)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch Non-Employee Source's Schema Attribute + + + +This end-point patches a specific schema attribute for a non-employee SourceId. + + +
Path Parameters
Request Body array required
+ +A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. + +
    value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    anyOf
  • string
  • integer
    • anyOf
  • string
  • integer
+ +The Schema Attribute was successfully patched. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/patch-non-employee-source.api.mdx b/products/idn/api/beta/patch-non-employee-source.api.mdx new file mode 100644 index 000000000..868725c5d --- /dev/null +++ b/products/idn/api/beta/patch-non-employee-source.api.mdx @@ -0,0 +1,91 @@ +--- +id: patch-non-employee-source +sidebar_label: Patch a Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchNonEmployeeSource","security":[{"oauth2":["idn:nelm:manage"]}],"tags":["Non-Employee Lifecycle Management"],"description":"patch a non-employee source. (Partial Update) Patchable field: **name, description, approvers, accountManagers**","parameters":[{"in":"path","name":"sourceId","description":"Source Id","required":true,"example":"2c91808b6ef1d43e016efba0ce470904","schema":{"type":"string"}}],"requestBody":{"description":"A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.","required":true,"content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"example":[{"op":"replace","path":"/name","value":{"new name":null}},{"op":"replace","path":"/approvers","value":["2c91809f703bb37a017040a2fe8748c7","48b1f463c9e8427db5a5071bd81914b8"]}]}}},"responses":{"200":{"description":"A patched non-employee source object.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"},"sourceId":{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"},"description":{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}},{"type":"object","properties":{"approvers":{"description":"List of approvers","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}}},"accountManagers":{"description":"List of account managers","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}}},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"},"nonEmployeeCount":{"nullable":true,"type":"integer","description":"The number of non-employee records on all sources that *requested-for* user manages.","example":2,"format":"int32"}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/non-employee-sources/{sourceId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Patch a Non-Employee Source","description":{"content":"patch a non-employee source. (Partial Update) Patchable field: **name, description, approvers, accountManagers**","type":"text/plain"},"url":{"path":["non-employee-sources",":sourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Source Id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch a Non-Employee Source' (patch-non-employee-source)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch a Non-Employee Source + + + +patch a non-employee source. (Partial Update) Patchable field: **name, description, approvers, accountManagers** + +
Path Parameters
Request Body array required
+ +A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +
    value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    anyOf
  • string
  • integer
    • anyOf
  • string
  • integer
+ +A patched non-employee source object. + +
Schema
    approvers object[]
    + +List of approvers + +
    accountManagers object[]
    + +List of account managers + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/patch-oauth-client.api.mdx b/products/idn/api/beta/patch-oauth-client.api.mdx new file mode 100644 index 000000000..d898c323e --- /dev/null +++ b/products/idn/api/beta/patch-oauth-client.api.mdx @@ -0,0 +1,113 @@ +--- +id: patch-oauth-client +sidebar_label: Patch OAuth Client +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchOauthClient","security":[{"oauth2":["sp:oauth-client:manage"]}],"tags":["OAuth Clients"],"description":"This performs a targeted update to the field(s) of an OAuth client.\nRequest will require a security scope of \n- sp:oauth-client:manage","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The OAuth client id","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"description":"A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nThe following fields are patchable:\n* tenant\n* businessName\n* homepageUrl\n* name\n* description\n* accessTokenValiditySeconds\n* refreshTokenValiditySeconds\n* redirectUris\n* grantTypes\n* accessType\n* enabled\n* strongAuthSupported\n* claimsSupported\n","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"example":[{"op":"replace","path":"/strongAuthSupported","value":true},{"op":"replace","path":"/businessName","value":"acme-solar"}]}}},"responses":{"200":{"description":"Indicates the PATCH operation succeeded, and returns the OAuth client's new representation.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the OAuth client","example":"2c9180835d2e5168015d32f890ca1581"},"businessName":{"type":"string","nullable":true,"description":"The name of the business the API Client should belong to","example":"Acme-Solar"},"homepageUrl":{"type":"string","nullable":true,"description":"The homepage URL associated with the owner of the API Client","example":"http://localhost:12345"},"name":{"type":"string","description":"A human-readable name for the API Client","example":"Demo API Client"},"description":{"type":"string","nullable":true,"description":"A description of the API Client","example":"An API client used for the authorization_code, refresh_token, and client_credentials flows"},"accessTokenValiditySeconds":{"type":"integer","format":"int32","description":"The number of seconds an access token generated for this API Client is valid for","example":750},"refreshTokenValiditySeconds":{"type":"integer","format":"int32","description":"The number of seconds a refresh token generated for this API Client is valid for","example":86400},"redirectUris":{"type":"array","nullable":true,"items":{"type":"string"},"description":"A list of the approved redirect URIs used with the authorization_code flow","example":["http://localhost:12345"]},"grantTypes":{"type":"array","items":{"description":"OAuth2 Grant Type","type":"string","example":"CLIENT_CREDENTIALS","enum":["CLIENT_CREDENTIALS","AUTHORIZATION_CODE","REFRESH_TOKEN"]},"description":"A list of OAuth 2.0 grant types this API Client can be used with","example":["AUTHORIZATION_CODE","CLIENT_CREDENTIALS","REFRESH_TOKEN"]},"accessType":{"description":"The access type (online or offline) of this API Client","example":"OFFLINE","type":"string","enum":["ONLINE","OFFLINE"]},"type":{"description":"The type of the API Client (public or confidential)","example":"CONFIDENTIAL","type":"string","enum":["CONFIDENTIAL","PUBLIC"]},"internal":{"type":"boolean","description":"An indicator of whether the API Client can be used for requests internal to IDN","example":false},"enabled":{"type":"boolean","description":"An indicator of whether the API Client is enabled for use","example":true},"strongAuthSupported":{"type":"boolean","description":"An indicator of whether the API Client supports strong authentication","example":false},"claimsSupported":{"type":"boolean","description":"An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow","example":false},"created":{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when the API Client was created","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when the API Client was last updated","example":"2018-06-25T20:22:28.104Z"},"lastUsed":{"type":"string","nullable":true,"format":"date-time","description":"The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed.","example":"2017-07-11T18:45:37.098Z"},"scope":{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the API Client.","example":["demo:api-client-scope:first","demo:api-client-scope:second"]}},"required":["id","businessName","homepageUrl","name","description","accessTokenValiditySeconds","refreshTokenValiditySeconds","redirectUris","grantTypes","accessType","type","internal","enabled","strongAuthSupported","claimsSupported","created","modified","scope"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/oauth-clients/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Patch OAuth Client","description":{"content":"This performs a targeted update to the field(s) of an OAuth client.\nRequest will require a security scope of \n- sp:oauth-client:manage","type":"text/plain"},"url":{"path":["oauth-clients",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The OAuth client id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch OAuth Client' (patch-oauth-client)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch OAuth Client + + + +This performs a targeted update to the field(s) of an OAuth client. +Request will require a security scope of +- sp:oauth-client:manage + +
Path Parameters
Request Body array required
+ +A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +The following fields are patchable: +* tenant +* businessName +* homepageUrl +* name +* description +* accessTokenValiditySeconds +* refreshTokenValiditySeconds +* redirectUris +* grantTypes +* accessType +* enabled +* strongAuthSupported +* claimsSupported + + +
    value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    anyOf
  • string
  • integer
    • anyOf
  • string
  • integer
+ +Indicates the PATCH operation succeeded, and returns the OAuth client's new representation. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/patch-org-config.api.mdx b/products/idn/api/beta/patch-org-config.api.mdx new file mode 100644 index 000000000..e0b1bed5d --- /dev/null +++ b/products/idn/api/beta/patch-org-config.api.mdx @@ -0,0 +1,95 @@ +--- +id: patch-org-config +sidebar_label: Patch an Org configuration property +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchOrgConfig","tags":["Org Config"],"security":[{"oauth2":["idn:org-configs:manage"]}],"description":"Patch configuration of the current org using http://jsonpatch.com/ syntax. Commonly used for changing the time zone of an org.","requestBody":{"description":"A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"example":[{"op":"replace","path":"/timeZone","value":"America/Toronto"}]}},"required":true},"responses":{"200":{"description":"The Org was successfully patched.","content":{"application/json":{"schema":{"type":"object","description":"DTO class for OrgConfig data accessible by customer external org admin (\"ORG_ADMIN\") users","properties":{"orgName":{"type":"string","description":"The name of the org.","example":"acme-solar"},"timeZone":{"type":"string","description":"The selected time zone which is to be used for the org. This directly affects when scheduled tasks are executed. Valid options can be found at /beta/org-config/valid-time-zones","example":"America/Toronto"},"lcsChangeHonorsSourceEnableFeature":{"type":"boolean","description":"Flag to determine whether the LCS_CHANGE_HONORS_SOURCE_ENABLE_FEATURE flag is enabled for the current org.","example":false},"armCustomerId":{"type":"string","description":"ARM Customer ID","nullable":true,"example":"DE38E75A-5FF6-4A65-5DC7-08D64426B09E"},"armSapSystemIdMappings":{"type":"string","description":"A list of IDN::sourceId to ARM::systemId mappings.","nullable":true,"example":[{"sourceId":"2c91808c791a94e501792388b0d62659","systemId":"1556"},{"sourceId":"2_2c91808c791a94e501792388b0d62659","systemId":"2_1556"},{"sourceId":"3_2c91808c791a94e501792388b0d62659","systemId":"3_1556"}]},"armAuth":{"type":"string","description":"ARM authentication string","nullable":true,"example":"epiYNTRYA2S7swisDWk1Zv4VMNgvqEjiBh5_ufuCWsma2m-5XADijqBg0ijXLby5nS6lxZNXabhGnAPGeDGc4V3jQKrhwV-UHypRLs8ZLgOjiQNus9NimS0uPdKomRW6TFWqXyfnYd-znNgbbVuwUy9GyD9ebDVJSntPastxSx7UcyGuWBqfNZYpuxKRWe_7TVY60qL55jUqyz8N4XUbbdcxdbZ0uik6ut-Bv90MKTbZexBW_PR4qcgIkaEs4kIenLyBxnGziYo7AO0tJ8bGHO8FJRkibCpAQIt7PISLo7Gg_Xf9j10dKq2YDgy4pPTvz3fE2ZHYnXCXvXFSA-vVag=="},"armDb":{"type":"string","description":"ARM database name","nullable":true,"example":"EU"},"armSsoUrl":{"type":"string","description":"ARM SSO URL","nullable":true,"example":"https://your-arm-sso-url"},"iaiEnableCertificationRecommendations":{"type":"boolean","description":"Flag to determine whether IAI Certification Recommendations are enabled for the current org","example":true},"sodReportConfigs":{"type":"array","items":{"type":"object","properties":{"columnName":{"type":"string","description":"Name of column in report","example":"SOD Business Name"},"required":{"type":"boolean","description":"If true, column is required in all reports, and this entry is immutable. A 400 error will result from any attempt to modify the column's definition.","example":true,"default":false},"included":{"type":"boolean","description":"If true, column is included in the report. A 400 error will be thrown if an attempt is made to set included=false if required==true.","example":false,"default":false},"order":{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"description":"Relative sort order for the column. Columns will be displayed left-to-right in nondecreasing order.","example":2}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/org-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Patch an Org configuration property","description":{"content":"Patch configuration of the current org using http://jsonpatch.com/ syntax. Commonly used for changing the time zone of an org.","type":"text/plain"},"url":{"path":["org-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch an Org configuration property' (patch-org-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch an Org configuration property + + + +Patch configuration of the current org using http://jsonpatch.com/ syntax. Commonly used for changing the time zone of an org. + +
Request Body array required
+ +A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +
    value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    anyOf
  • string
  • integer
    • anyOf
  • string
  • integer
+ +The Org was successfully patched. + +
Schema
    sodReportConfigs object[]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/patch-personal-access-token.api.mdx b/products/idn/api/beta/patch-personal-access-token.api.mdx new file mode 100644 index 000000000..e677deb66 --- /dev/null +++ b/products/idn/api/beta/patch-personal-access-token.api.mdx @@ -0,0 +1,104 @@ +--- +id: patch-personal-access-token +sidebar_label: Patch Personal Access Token +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchPersonalAccessToken","security":[{"oauth2":["sp:my-personal-access-tokens:manage"]}],"tags":["Personal Access Tokens"],"description":"This performs a targeted update to the field(s) of a Personal Access Token.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Personal Access Token id","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"description":"A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nThe following fields are patchable:\n* name\n* scope\n","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"example":[{"op":"replace","path":"/name","value":"New name"},{"op":"replace","path":"/scope","value":["sp:scopes:all"]}]}}},"responses":{"200":{"description":"Indicates the PATCH operation succeeded, and returns the PAT's new representation.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the personal access token (to be used as the username for Basic Auth).","example":"86f1dc6fe8f54414950454cbb11278fa"},"name":{"type":"string","description":"The name of the personal access token. Cannot be the same as other personal access tokens owned by a user.","example":"NodeJS Integration"},"scope":{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the personal access token.","example":["demo:personal-access-token-scope:first","demo:personal-access-token-scope:second"]},"owner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Details about the owner of the personal access token."},"created":{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when this personal access token was created.","example":"2017-07-11T18:45:37.098Z"},"lastUsed":{"type":"string","nullable":true,"format":"date-time","description":"The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed.","example":"2017-07-11T18:45:37.098Z"}},"required":["id","name","scope","owner","created"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/personal-access-tokens/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Patch Personal Access Token","description":{"content":"This performs a targeted update to the field(s) of a Personal Access Token.","type":"text/plain"},"url":{"path":["personal-access-tokens",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Personal Access Token id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch Personal Access Token' (patch-personal-access-token)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch Personal Access Token + + + +This performs a targeted update to the field(s) of a Personal Access Token. + +
Path Parameters
Request Body array required
+ +A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +The following fields are patchable: +* name +* scope + + +
    value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    anyOf
  • string
  • integer
    • anyOf
  • string
  • integer
+ +Indicates the PATCH operation succeeded, and returns the PAT's new representation. + +
Schema
    owner object
    + +Details about the owner of the personal access token. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/patch-potential-role.api.mdx b/products/idn/api/beta/patch-potential-role.api.mdx new file mode 100644 index 000000000..63d2c4232 --- /dev/null +++ b/products/idn/api/beta/patch-potential-role.api.mdx @@ -0,0 +1,115 @@ +--- +id: patch-potential-role +sidebar_label: Update a potential role +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchPotentialRole","tags":["IAI Role Mining"],"description":"The method updates an existing potential role using.\n\nThe following fields can be modified:\n\n* `description`\n\n* `name`\n\n* `saved`\n\n\n>**NOTE: All other fields cannot be modified.**\n","parameters":[{"in":"path","name":"sessionId","schema":{"type":"string"},"required":true,"description":"The role mining session id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"path","name":"potentialRoleId","schema":{"type":"string"},"required":true,"description":"The potential role summary id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"}],"requestBody":{"required":true,"content":{"application/json-patch+json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["remove","replace"],"example":"replace"}}}},"example":[{"op":"remove","path":"/description"},{"op":"replace","path":"/description","value":"Acct I - Potential Role"},{"op":"remove","path":"/saved"},{"op":"replace","path":"/saved","value":"false"},{"op":"remove","path":"/name"},{"op":"replace","path":"/name","value":"Potential Role Accounting"}]}}},"responses":{"200":{"description":"Succeeded. Returns the potential role summary based on the potentialRoleId provided.","content":{"application/json":{"schema":{"type":"object","items":{"type":"object","properties":{"createdBy":{"description":"The session created by details.","type":"object","properties":{"id":{"type":"string","description":"ID of the creator","example":"2c918090761a5aac0176215c46a62d58"},"displayName":{"type":"string","description":"The display name of the creator","example":"Ashley.Pierce"}}},"density":{"type":"integer","description":"The density of a potential role.","example":75,"format":"int32"},"description":{"type":"string","description":"The description of a potential role.","example":"Potential Role for Accounting dept"},"entitlementCount":{"type":"integer","description":"The number of entitlements in a potential role.","example":25,"format":"int32"},"excludedEntitlements":{"description":"The list of entitlement ids to be excluded.","type":"array","items":{"type":"string"},"example":["07a0b4e2","13b4e2a0"]},"freshness":{"type":"integer","description":"The freshness of a potential role.","example":75,"format":"int32"},"identityCount":{"type":"integer","description":"The number of identities in a potential role.","example":25,"format":"int32"},"identityDistribution":{"description":"Identity attribute distribution.","type":"array","items":{"type":"object","properties":{"attributeName":{"type":"string","description":"Id of the potential role","example":"department"},"distribution":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}},"example":[{"attributeValue":"NM Tier 3","count":6}]}}}},"identityIds":{"description":"The list of ids in a potential role.","type":"array","items":{"type":"string"},"example":["07a0b4e2","13b4e2a0"]},"name":{"type":"string","description":"Name of the potential role.","example":"Saved Potential Role - 07/10"},"provisionState":{"description":"The provisioning state of a potential role.","type":"string","enum":["POTENTIAL","PENDING","COMPLETE","FAILED"],"example":"POTENTIAL"},"quality":{"type":"integer","description":"The quality of a potential role.","example":100,"format":"int32"},"roleId":{"type":"string","description":"The roleId of a potential role.","example":"07a0b4e2-7a76-44fa-bd0b-c64654b66519"},"saved":{"type":"boolean","description":"The potential role's saved status.","example":true},"session":{"description":"The session parameters of the potential role.","type":"object","properties":{"minNumIdentitiesInPotentialRole":{"type":"integer","description":"Minimum number of identities in a potential role","example":20,"format":"int32"},"name":{"type":"string","description":"The session's saved name","example":"Saved RM Session - 07/10"},"pruneThreshold":{"type":"integer","description":"The prune threshold to be used or null to calculate prescribedPruneThreshold","example":5,"format":"int32"},"saved":{"type":"boolean","description":"The session's saved status","example":true},"scope":{"description":"The scope of identities for this role mining session","example":{"identityIds":[],"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"]}}},"type":"object","properties":{"identityIds":{"type":"array","items":{"type":"string"},"description":"The list of identities for this role mining session.","example":["2c918090761a5aac0176215c46a62d58","2c918090761a5aac01722015c46a62d42"]},"criteria":{"type":"string","description":"The \"search\" criteria that produces the list of identities for this role mining session.","example":"source.name:DataScienceDataset"},"attributeFilterCriteria":{"type":"array","items":{"type":"object"},"description":"The filter criteria for this role mining session.","example":{"displayName":{"untranslated":"Location: Miami"},"ariaLabel":{"untranslated":"Location: Miami"},"data":{"displayName":{"translateKey":"IDN.IDENTITY_ATTRIBUTES.LOCATION"},"name":"location","operator":"EQUALS","values":["Miami"]}}}}},"type":{"description":"Role mining potential type","type":"string","enum":["SPECIALIZED","COMMON"],"example":"SPECIALIZED"}}},"type":{"description":"Role mining potential type.","type":"string","enum":["SPECIALIZED","COMMON"],"example":"SPECIALIZED"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update a potential role","description":{"content":"The method updates an existing potential role using.\n\nThe following fields can be modified:\n\n* `description`\n\n* `name`\n\n* `saved`\n\n\n>**NOTE: All other fields cannot be modified.**\n","type":"text/plain"},"url":{"path":["role-mining-sessions",":sessionId","potential-role-summaries",":potentialRoleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The role mining session id","type":"text/plain"},"type":"any","value":"","key":"sessionId"},{"disabled":false,"description":{"content":"(Required) The potential role summary id","type":"text/plain"},"type":"any","value":"","key":"potentialRoleId"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a potential role' (patch-potential-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a potential role + + + +The method updates an existing potential role using. + +The following fields can be modified: + +* `description` + +* `name` + +* `saved` + + +>**NOTE: All other fields cannot be modified.** + + +
Path Parameters
Request Body array required
+ +Succeeded. Returns the potential role summary based on the potentialRoleId provided. + +
Schema
    createdBy object
    + +The session created by details. + +
    identityDistribution object[]
    + +Identity attribute distribution. + +
    session object
    + +The session parameters of the potential role. + +
    scope object
    + +The scope of identities for this role mining session + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/patch-role-mining-session.api.mdx b/products/idn/api/beta/patch-role-mining-session.api.mdx new file mode 100644 index 000000000..4d20cadf5 --- /dev/null +++ b/products/idn/api/beta/patch-role-mining-session.api.mdx @@ -0,0 +1,95 @@ +--- +id: patch-role-mining-session +sidebar_label: Patch a role mining session +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchRoleMiningSession","tags":["IAI Role Mining"],"description":"The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated.","parameters":[{"in":"path","name":"sessionId","schema":{"type":"string"},"required":true,"description":"The role mining session id to be patched","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"}],"requestBody":{"required":true,"description":"Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session.","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"example":[{"op":"replace","path":"/pruneThreshold","value":"83"},{"op":"replace","path":"/minNumIdentitiesInPotentialRole","value":"10"},{"op":"replace","path":"/saved","value":"false"},{"op":"replace","path":"/name","value":"RM Session - 07/10/22"},{"op":"add","path":"/name","value":"RM Session - 07/10/22"}]}}},"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/role-mining-sessions/{sessionId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Patch a role mining session","description":{"content":"The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated.","type":"text/plain"},"url":{"path":["role-mining-sessions",":sessionId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The role mining session id to be patched","type":"text/plain"},"type":"any","value":"","key":"sessionId"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch a role mining session' (patch-role-mining-session)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch a role mining session + + + +The method updates an existing role mining session using PATCH. Supports op in {"replace"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. + +
Path Parameters
Request Body array required
+ +Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. + +
    value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    anyOf
  • string
  • integer
    • anyOf
  • string
  • integer
+ +Accepted - Returned if the request was successfully accepted into the system. + +
Schema
  • object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/patch-role.api.mdx b/products/idn/api/beta/patch-role.api.mdx new file mode 100644 index 000000000..4e0c783ef --- /dev/null +++ b/products/idn/api/beta/patch-role.api.mdx @@ -0,0 +1,139 @@ +--- +id: patch-role +sidebar_label: Patch a specified Role +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchRole","tags":["Roles"],"description":"This API updates an existing Role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.\n\nThe following fields are patchable: **name**, **description**, **enabled**, **owner**, **accessProfiles**, **membership**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.\nThe maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.","parameters":[{"name":"id","in":"path","description":"ID of the Role to patch","required":true,"schema":{"type":"string","example":"2c91808a7813090a017814121e121518"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"examples":{"Make a Role Requestable and Enable it in One Call":{"description":"This example shows how multiple fields may be updated with a single patch call.","value":[{"op":"replace","path":"/requestable","value":true},{"op":"replace","path":"/enabled","value":true}]},"Assign a Role to a Segment":{"description":"This example illustrates the use of patch to assign a Role to a Segment by adding the Segment's ID to the Role's segments array.","value":[{"op":"add","path":"/segments/-","value":"f7b1b8a3-5fed-4fd4-ad29-82014e137e19"}]},"Set the Membership Selection Criteria to a List of Identities":{"description":"This example shows how to define a Role's membershp by providing a list of Identities, referenced by their IDs.","value":[{"op":"replace","path":"/membership","value":{"type":"IDENTITY_LIST","identities":[{"id":"2c91808973fe906c0174262092014ed9"},{"id":"2c918086262092014ed94fb8a47612f3"}]}}]},"Set the Membership Selection Criteria to a Standard Expression":{"description":"This example shows how to define a Role's membership using STANDARD criteria. In this case, the Role will be granted to all Identities which have the *Engineering* attribute from the indicated Source.","value":[{"op":"replace","path":"/membership","value":{"type":"STANDARD","criteria":{"operation":"OR","children":[{"operation":"EQUALS","key":{"type":"ENTITLEMENT","property":"attribute.memberOf","sourceId":"2c9180887701fb2014213e122092014e"},"stringValue":"Engineering"}]}}}]},"Add a New Clause as the Child of an Existing Standard Expression":{"description":"This example shows how to add a child clause to an existing STANDARD criteria expression.","value":[{"op":"add","path":"/membership/criteria/children/-","value":{"operation":"ENDS_WITH","key":{"type":"IDENTITY","property":"attribute.email"},"stringValue":"@identitynow.com"}}]}}}},"required":true},"responses":{"200":{"description":"Responds with the Role as updated.","content":{"application/json":{"schema":{"type":"object","description":"A Role","properties":{"id":{"type":"string","description":"The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.","example":"2c918086749d78830174a1a40e121518"},"name":{"type":"string","description":"The human-readable display name of the Role","maxLength":128,"example":"Role 2567"},"created":{"type":"string","description":"Date the Role was created","format":"date-time","example":"2021-03-01T22:32:58.104Z","readOnly":true},"modified":{"type":"string","description":"Date the Role was last modified.","format":"date-time","example":"2021-03-02T20:22:28.104Z","readOnly":true},"description":{"type":"string","nullable":true,"description":"A human-readable description of the Role","example":"Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor."},"owner":{"type":"object","nullable":true,"description":"The owner of this object.","properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"accessProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the Access Profile","example":"ff808081751e6e129f1518161919ecca"},"type":{"type":"string","description":"Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result.","enum":["ACCESS_PROFILE"],"example":"ACCESS_PROFILE"},"name":{"type":"string","description":"Human-readable display name of the Access Profile. This field is ignored on input.","example":"Access Profile 2567"}}},"nullable":true},"membership":{"nullable":true,"type":"object","description":"When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.","properties":{"type":{"type":"string","enum":["STANDARD","IDENTITY_LIST"],"description":"This enum characterizes the type of a Role's membership selector. Only the following two are fully supported:\n\nSTANDARD: Indicates that Role membership is defined in terms of a criteria expression\n\nIDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed","example":"IDENTITY_LIST"},"criteria":{"nullable":true,"type":"object","description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","nullable":true,"description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","nullable":true,"description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","nullable":true,"description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa."}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa."}}},"identities":{"type":"array","items":{"type":"object","description":"A reference to an Identity in an IDENTITY_LIST role membership criteria.","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY","nullable":true},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","nullable":true,"description":"Human-readable display name of the Identity.","example":"Thomas Edison"},"aliasName":{"type":"string","nullable":true,"description":"User name of the Identity","example":"t.edison"}}},"nullable":true,"description":"Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST."}}},"legacyMembershipInfo":{"type":"object","nullable":true,"description":"This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.","example":{"type":"IDENTITY_LIST"},"additionalProperties":true},"enabled":{"type":"boolean","description":"Whether the Role is enabled or not.","example":true,"default":false},"requestable":{"type":"boolean","description":"Whether the Role can be the target of access requests.","example":true,"default":false},"accessRequestConfig":{"nullable":true,"description":"Access request configuration for this object","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":true,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":true,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n\n**OWNER**: Owner of the associated Role\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"revocationRequestConfig":{"nullable":true,"default":null,"description":"Revocation request configuration for this object.","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":false,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":false,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the revocation request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"segments":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of IDs of segments, if any, to which this Role is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]}},"required":["name","owner"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:role-unchecked:manage","idn:role-checked:manage"]}],"method":"patch","path":"/roles/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Patch a specified Role","description":{"content":"This API updates an existing Role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.\n\nThe following fields are patchable: **name**, **description**, **enabled**, **owner**, **accessProfiles**, **membership**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.\nThe maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.","type":"text/plain"},"url":{"path":["roles",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Role to patch","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch a specified Role' (patch-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch a specified Role + + + +This API updates an existing Role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: **name**, **description**, **enabled**, **owner**, **accessProfiles**, **membership**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments** +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +
Path Parameters
Request Body array required
    value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    anyOf
  • string
  • integer
    • anyOf
  • string
  • integer
+ +Responds with the Role as updated. + +
Schema
    owner object
    + +The owner of this object. + +
    accessProfiles object[]
    membership object
    + +When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities. + +
    criteria object
    + +Defines STANDARD type Role membership + +
    key object
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]
    + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + +
    key object
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]
    + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + +
    key object
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    identities object[]
    + +Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. + +
    legacyMembershipInfo object
    + +This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. + +
    accessRequestConfig object
    + +Access request configuration for this object + +
    approvalSchemes object[]
    + +List describing the steps in approving the request + +
    revocationRequestConfig object
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]
    + +List describing the steps in approving the revocation request + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/patch-search-attribute-config.api.mdx b/products/idn/api/beta/patch-search-attribute-config.api.mdx new file mode 100644 index 000000000..0b21e3dab --- /dev/null +++ b/products/idn/api/beta/patch-search-attribute-config.api.mdx @@ -0,0 +1,93 @@ +--- +id: patch-search-attribute-config +sidebar_label: Update the details of a specific extended search attribute in IdentityNow. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchSearchAttributeConfig","tags":["Search Attribute Configuration"],"description":"This API updates an existing Search Attribute Configuration. The following fields are patchable:\n**name**, **displayName**, **applicationAttributes**\nA token with ORG_ADMIN authority is required to call this API.","parameters":[{"name":"name","in":"path","description":"Name of the Search Attribute Configuration to patch.","required":true,"schema":{"type":"string","example":"promotedMailAttribute"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"example":[{"op":"replace","path":"/name","value":"newAttributeName"},{"op":"replace","path":"/displayName","value":"new attribute display name"},{"op":"add","path":"/applicationAttributes","value":{"2c91808b79fd2422017a0b35d30f3968":"employeeNumber"}}]}},"required":true},"responses":{"200":{"description":"Responds with the Search Attribute Configuration as updated.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the new attribute","example":"newMailAttribute"},"displayName":{"type":"string","description":"The display name of the new attribute","example":"New Mail Attribute"},"applicationAttributes":{"type":"object","description":"Map of application id and their associated attribute.","example":{"2c91808b79fd2422017a0b35d30f3968":"employeeNumber","2c91808b79fd2422017a0b36008f396b":"employeeNumber"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/accounts/search-attribute-config/{name}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update the details of a specific extended search attribute in IdentityNow.","description":{"content":"This API updates an existing Search Attribute Configuration. The following fields are patchable:\n**name**, **displayName**, **applicationAttributes**\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts","search-attribute-config",":name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Name of the Search Attribute Configuration to patch.","type":"text/plain"},"type":"any","value":"","key":"name"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update the details of a specific extended search attribute in IdentityNow.' (patch-search-attribute-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update the details of a specific extended search attribute in IdentityNow. + + + +This API updates an existing Search Attribute Configuration. The following fields are patchable: +**name**, **displayName**, **applicationAttributes** +A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
Request Body array required
    value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    anyOf
  • string
  • integer
    • anyOf
  • string
  • integer
+ +Responds with the Search Attribute Configuration as updated. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/patch-segment.api.mdx b/products/idn/api/beta/patch-segment.api.mdx new file mode 100644 index 000000000..0ecf59d89 --- /dev/null +++ b/products/idn/api/beta/patch-segment.api.mdx @@ -0,0 +1,112 @@ +--- +id: patch-segment +sidebar_label: Update a Segment +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchSegment","tags":["Segments"],"description":"Allows updating Segment fields using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nNote that changes to a segment may take some time to propagate to all identities, and that segments will have no effect if segmentation is not enabled for your org.\n\nA token with ORG_ADMIN or API authority is required to call this API.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the Segment being modified.","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"description":"A list of Segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\n\nThe following fields are patchable:\n* name\n* description\n* owner\n* visibilityCriteria\n* active\n","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Set Visibility Criteria":{"description":"Set the visibility criteria","value":[{"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"}}]}}}]}}}}},"responses":{"200":{"description":"Indicates the PATCH operation succeeded, and returns the Segment's new representation.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"name":{"type":"string","description":"Segment Business Name","example":"segment-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this Segment is created","example":"2020-01-01T00:00:00.000000Z"},"modified":{"type":"string","format":"date-time","description":"The time when this Segment is modified","example":"2020-01-01T00:00:00.000000Z"},"description":{"type":"string","description":"Optional description of the Segment","example":"This segment represents xyz"},"owner":{"type":"object","nullable":true,"description":"The owner of this object.","properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"visibilityCriteria":{"type":"object","properties":{"expression":{"type":"object","properties":{"operator":{"type":"string","description":"Operator for the expression","enum":["AND","EQUALS"],"example":"EQUALS"},"attribute":{"type":"string","description":"Name for the attribute","example":"location"},"value":{"type":"object","properties":{"type":{"type":"string","description":"The type of attribute value","example":"STRING"},"value":{"type":"string","description":"The attribute value","example":"Austin"}}},"children":{"type":"array","description":"List of expressions","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of attribute value","example":"STRING"},"value":{"type":"string","description":"The attribute value","example":"Austin"}}},"example":[]}}}}},"active":{"type":"boolean","description":"Whether the Segment is currently active. Inactive segments have no effect."}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/segments/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update a Segment","description":{"content":"Allows updating Segment fields using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nNote that changes to a segment may take some time to propagate to all identities, and that segments will have no effect if segmentation is not enabled for your org.\n\nA token with ORG_ADMIN or API authority is required to call this API.","type":"text/plain"},"url":{"path":["segments",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the Segment being modified.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a Segment' (patch-segment)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a Segment + + + +Allows updating Segment fields using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +Note that changes to a segment may take some time to propagate to all identities, and that segments will have no effect if segmentation is not enabled for your org. + +A token with ORG_ADMIN or API authority is required to call this API. + +
Path Parameters
Request Body array required
+ +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 + + +
+ +Indicates the PATCH operation succeeded, and returns the Segment's new representation. + +
Schema
    owner object
    + +The owner of this object. + +
    visibilityCriteria object
    expression object
    value object
    children object[]
    + +List of expressions + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/patch-service-desk-integration.api.mdx b/products/idn/api/beta/patch-service-desk-integration.api.mdx new file mode 100644 index 000000000..43355473c --- /dev/null +++ b/products/idn/api/beta/patch-service-desk-integration.api.mdx @@ -0,0 +1,135 @@ +--- +id: patch-service-desk-integration +sidebar_label: Service Desk Integration Update PATCH +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchServiceDeskIntegration","tags":["Service Desk Integration"],"description":"Update an existing ServiceDeskIntegration by ID with a PATCH request.","parameters":[{"name":"id","in":"path","description":"ID of the Service Desk integration to update","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"anId"}}],"requestBody":{"required":true,"description":"A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nPATCH can only be applied to the following fields:\n * `beforeProvisioningRule`\n * `description`\n * `ownerRef`\n\nA 403 Forbidden Error indicates that you attempted to PATCH a field that is not allowed.\n","content":{"application/json-patch+json":{"schema":{"type":"object","description":"A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","properties":{"operations":{"description":"Operations to be applied","type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}}},"example":"[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]"},"example":[{"op":"replace","path":"/ownerRef","value":{"id":"2c9180867d05b227017d09921a205b4d","type":"IDENTITY","name":"Angelo2 tester"}}]}}},"responses":{"200":{"description":"ServiceDeskIntegrationDto as updated","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"},"modified":{"description":"Last modification date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}},{"type":"object","description":"Specification of a Service Desk integration","required":["description","type","attributes"],"properties":{"description":{"description":"Description of the Service Desk integration","type":"string","example":"A very nice Service Desk integration"},"type":{"description":"Service Desk integration types\n\n- ServiceNowSDIM\n- ServiceNow\n","type":"string","default":"ServiceNowSDIM","example":"ServiceNowSDIM"},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the identity that is the owner of this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the identity","example":"MyName"}}},"clusterRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the source cluster for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"cluster":{"description":"ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)","type":"string","example":"xyzzy999","deprecated":true},"managedSources":{"description":"Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)","type":"array","items":{"type":"string"},"deprecated":true,"example":["2c9180835d191a86015d28455b4a2329","2c5680835d191a85765d28455b4a9823"]},"provisioningConfig":{"description":"The 'provisioningConfig' property specifies the configuration used to provision integrations.","type":"object","properties":{"universalManager":{"description":"Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.","type":"boolean","readOnly":true,"example":true},"managedResourceRefs":{"description":"References to sources for the Service Desk integration template. May only be specified if universalManager is false.","type":"array","items":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"properties":{"type":{"description":"The type of object being referenced","enum":["SOURCE"],"example":"SOURCE"},"id":{"description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the source","example":"My Source"}}},"example":[{"type":"SOURCE","id":"2c9180855d191c59015d291ceb051111","name":"My Source 1"},{"type":"SOURCE","id":"2c9180855d191c59015d291ceb052222","name":"My Source 2"}]},"planInitializerScript":{"description":"This is a reference to a plan initializer script.","type":"object","properties":{"source":{"description":"This is a Rule that allows provisioning instruction changes.","type":"string","example":"\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n"}}},"noProvisioningRequests":{"description":"Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.","type":"boolean","example":true},"provisioningRequestExpiration":{"description":"When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.","type":"integer","format":"int32","example":7}}},"attributes":{"description":"Attributes of the Service Desk integration. Validation constraints enforced by the implementation.","type":"object","additionalProperties":true,"example":{"property":"value","key":"value"}},"beforeProvisioningRule":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to beforeProvisioningRule for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["RULE"],"example":"RULE"},"id":{"description":"ID of the rule","example":"2c91808568c529c60168cca6f90c1333"},"name":{"description":"Human-readable display name of the rule","example":"Example Rule"}}}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:service-desk-admin:manage","idn:service-desk-integration:manage"]}],"method":"patch","path":"/service-desk-integrations/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":"[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]","info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Service Desk Integration Update PATCH","description":{"content":"Update an existing ServiceDeskIntegration by ID with a PATCH request.","type":"text/plain"},"url":{"path":["service-desk-integrations",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Service Desk integration to update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Service Desk Integration Update PATCH' (patch-service-desk-integration)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Service Desk Integration Update PATCH + + + +Update an existing ServiceDeskIntegration by ID with a PATCH request. + +
Path Parameters
Request Body required
+ +A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +PATCH can only be applied to the following fields: + * `beforeProvisioningRule` + * `description` + * `ownerRef` + +A 403 Forbidden Error indicates that you attempted to PATCH a field that is not allowed. + + +
    operations object[]
    + +Operations to be applied + +
    value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    anyOf
  • string
  • integer
    • anyOf
  • string
  • integer
+ +ServiceDeskIntegrationDto as updated + +
Schema
    ownerRef object
    + +Reference to the identity that is the owner of this Service Desk integration + +
    clusterRef object
    + +Reference to the source cluster for this Service Desk integration + +
    provisioningConfig object
    + +The 'provisioningConfig' property specifies the configuration used to provision integrations. + +
    managedResourceRefs object[]
    + +References to sources for the Service Desk integration template. May only be specified if universalManager is false. + +
    planInitializerScript object
    + +This is a reference to a plan initializer script. + +
    attributes object
    + +Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + +
    beforeProvisioningRule object
    + +Reference to beforeProvisioningRule for this Service Desk integration + +
\\\\r\\\\n\\\\r\\\\n\\\\r\\\\n Before Provisioning Rule which changes disables and enables to a modify.\\\\r\\\\n \\n\"\n },\n \"noProvisioningRequests\": true,\n \"provisioningRequestExpiration\": 7\n },\n \"attributes\": {\n \"property\": \"value\",\n \"key\": \"value\"\n },\n \"beforeProvisioningRule\": {\n \"type\": true,\n \"id\": true,\n \"name\": true\n }\n}"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/patch-sod-policy.api.mdx b/products/idn/api/beta/patch-sod-policy.api.mdx new file mode 100644 index 000000000..9d0027780 --- /dev/null +++ b/products/idn/api/beta/patch-sod-policy.api.mdx @@ -0,0 +1,115 @@ +--- +id: patch-sod-policy +sidebar_label: Patch a SOD policy +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchSodPolicy","tags":["SOD Policy"],"description":"Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\nRequires role of ORG_ADMIN.\nThis endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. ","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the SOD policy being modified.","example":"2c9180835d191a86015d28455b4a2329"}],"requestBody":{"required":true,"description":"A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nThe following fields are patchable:\n* name\n* description\n* ownerRef\n* externalPolicyReference\n* compensatingControls\n* correctionAdvice\n* state\n* tags\n* violationOwnerAssignmentConfig\n* scheduled\n* conflictingAccessCriteria\n","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Conflicting Access Based Policy":{"value":[{"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"}]}}]},"General Policy":{"value":[{"op":"replace","path":"/description","value":"Modified description"}]}}}}},"responses":{"200":{"description":"Indicates the PATCH operation succeeded, and returns the SOD policy's new representation.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Policy id","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"name":{"type":"string","description":"Policy Business Name","example":"policy-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this SOD policy is created.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"modified":{"type":"string","format":"date-time","description":"The time when this SOD policy is modified.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"description":{"type":"string","description":"Optional description of the SOD policy","example":"This policy ensures compliance of xyz","nullable":true},"ownerRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"externalPolicyReference":{"type":"string","description":"Optional External Policy Reference","example":"XYZ policy","nullable":true},"policyQuery":{"type":"string","description":"Search query of the SOD policy","example":"@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)"},"compensatingControls":{"type":"string","description":"Optional compensating controls(Mitigating Controls)","example":"Have a manager review the transaction decisions for their \"out of compliance\" employee","nullable":true},"correctionAdvice":{"type":"string","description":"Optional correction advice","example":"Based on the role of the employee, managers should remove access that is not required for their job function.","nullable":true},"state":{"type":"string","description":"whether the policy is enforced or not","enum":["ENFORCED","NOT_ENFORCED"],"example":"ENFORCED"},"tags":{"type":"array","description":"tags for this policy object","example":["TAG1","TAG2"],"items":{"type":"string"}},"creatorId":{"type":"string","description":"Policy's creator ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"modifierId":{"type":"string","description":"Policy's modifier ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","nullable":true,"readOnly":true},"violationOwnerAssignmentConfig":{"nullable":true,"type":"object","properties":{"assignmentRule":{"type":"string","enum":["MANAGER","STATIC",null],"description":"Details about the violations owner.\nMANAGER - identity's manager\nSTATIC - Governance Group or Identity","example":"MANAGER","nullable":true},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"nullable":true}]}}},"scheduled":{"type":"boolean","description":"defines whether a policy has been scheduled or not","example":true,"default":false},"type":{"type":"string","description":"whether a policy is query based or conflicting access based","default":"GENERAL","enum":["GENERAL","CONFLICTING_ACCESS_BASED"],"example":"GENERAL"},"conflictingAccessCriteria":{"allOf":[{"type":"object","properties":{"leftCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"DTO type","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}},"rightCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"DTO type","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}}}},{"nullable":true}]}}},"examples":{"Conflicting Access Based Policy":{"value":{"id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"Conflicting-Policy-Name","created":"2020-01-01T00:00:00.000000Z","modified":"2020-01-01T00:00:00.000000Z","description":"Modified description","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Owner Name"},"externalPolicyReference":"XYZ policy","policyQuery":"@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c918087682f9a86016839c0509c1ab2)","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":["string"],"creatorId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","modifierId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","violationOwnerAssignmentConfig":{"assignmentRule":"MANAGER","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Violation Owner Name"}},"scheduled":true,"type":"CONFLICTING_ACCESS_BASED","conflictingAccessCriteria":{"leftCriteria":{"name":"money-in-modified","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67"}]},"rightCriteria":{"name":"money-out-modified","criteriaList":[{"type":"ENTITLEMENT","id":"2c918087682f9a86016839c0509c1ab2"}]}}}},"General Policy":{"value":{"description":"Modified description","ownerRef":{"type":"IDENTITY","id":"2c918087682f9a86016839c05e8f1aff","name":"Owner Name"},"externalPolicyReference":"New policy","policyQuery":"policy query implementation","compensatingControls":"Compensating controls","correctionAdvice":"Correction advice","tags":[],"state":"ENFORCED","scheduled":false,"creatorId":"2c918087682f9a86016839c05e8f1aff","modifierId":null,"violationOwnerAssignmentConfig":null,"type":"GENERAL","conflictingAccessCriteria":null,"id":"52c11db4-733e-4c31-949a-766c95ec95f1","name":"General-Policy-Name","created":"2020-05-12T19:47:38Z","modified":"2020-05-12T19:47:38Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/sod-policies/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Patch a SOD policy","description":{"content":"Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\nRequires role of ORG_ADMIN.\nThis endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. ","type":"text/plain"},"url":{"path":["sod-policies",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the SOD policy being modified.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch a SOD policy' (patch-sod-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch a SOD policy + + + +Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Requires role of ORG_ADMIN. +This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. + +
Path Parameters
Request Body array required
+ +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 + + +
+ +Indicates the PATCH operation succeeded, and returns the SOD policy's new representation. + +
Schema
    ownerRef object
    violationOwnerAssignmentConfig object
    ownerRef object
    conflictingAccessCriteria object
    leftCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
    rightCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/patch-subscription.api.mdx b/products/idn/api/beta/patch-subscription.api.mdx new file mode 100644 index 000000000..d3a77ccac --- /dev/null +++ b/products/idn/api/beta/patch-subscription.api.mdx @@ -0,0 +1,109 @@ +--- +id: patch-subscription +sidebar_label: Patch a Subscription +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchSubscription","tags":["Triggers"],"description":"This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable:\n\n**name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig**","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"ID of the Subscription to patch","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"}],"requestBody":{"required":true,"content":{"application/json-patch+json":{"schema":{"description":"Operations to be applied","type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}},"example":[{"op":"replace","path":"/description","value":"A new description"},{"op":"replace","path":"/name","value":"A new name"}]}}}},"responses":{"200":{"description":"Updated subscription.","content":{"application/json":{"schema":{"type":"object","required":["id","triggerId","type","name","triggerName","enabled","responseDeadline"],"properties":{"id":{"type":"string","description":"Subscription ID.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"name":{"type":"string","description":"Subscription name.","example":"Access request subscription"},"description":{"type":"string","description":"Subscription description.","example":"Access requested to site xyz"},"triggerId":{"type":"string","description":"ID of trigger subscribed to.","example":"idn:access-requested"},"triggerName":{"type":"string","description":"Trigger name of trigger subscribed to.","example":"Access Requested"},"type":{"type":"string","enum":["HTTP","EVENTBRIDGE","INLINE","SCRIPT","WORKFLOW"],"description":"Subscription type. **NOTE** If type is EVENTBRIDGE, then eventBridgeConfig is required. If type is HTTP, then httpConfig is required.","example":"HTTP"},"responseDeadline":{"type":"string","description":"Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format.","example":"PT1H","default":"PT1H"},"httpConfig":{"description":"Config required if HTTP subscription type is used.","type":"object","properties":{"url":{"type":"string","description":"URL of the external/custom integration.","example":"https://www.example.com"},"httpDispatchMode":{"type":"string","description":"HTTP response modes, i.e. SYNC, ASYNC, or DYNAMIC.","enum":["SYNC","ASYNC","DYNAMIC"],"example":"SYNC"},"httpAuthenticationType":{"type":"string","description":"Defines the HTTP Authentication type. Additional values may be added in the future.\n\nIf *NO_AUTH* is selected, no extra information will be in HttpConfig.\n\nIf *BASIC_AUTH* is selected, HttpConfig will include BasicAuthConfig with Username and Password as strings.\n\nIf *BEARER_TOKEN* is selected, HttpConfig will include BearerTokenAuthConfig with Token as string.","enum":["NO_AUTH","BASIC_AUTH","BEARER_TOKEN"],"default":"NO_AUTH","example":"BASIC_AUTH"},"basicAuthConfig":{"type":"object","properties":{"userName":{"type":"string","description":"The username to authenticate.","example":"user@example.com"},"password":{"type":"string","nullable":true,"description":"The password to authenticate. On response, this field is set to null as to not return secrets.","example":null}},"nullable":true,"description":"Config required if BASIC_AUTH is used."},"bearerTokenAuthConfig":{"type":"object","properties":{"bearerToken":{"type":"string","nullable":true,"description":"Bearer token","example":null}},"nullable":true,"description":"Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets."}},"required":["url","httpDispatchMode"]},"eventBridgeConfig":{"description":"Config required if EVENTBRIDGE subscription type is used.","type":"object","properties":{"awsAccount":{"type":"string","description":"AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource.","example":"123456789012"},"awsRegion":{"type":"string","description":"AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values.","example":"us-west-1"}},"required":["awsAccount","awsRegion"]},"enabled":{"type":"boolean","description":"Whether subscription should receive real-time trigger invocations or not.\nTest trigger invocations are always enabled regardless of this option.","default":true,"example":true},"filter":{"type":"string","description":"JSONPath filter to conditionally invoke trigger when expression evaluates to true.","example":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]","externalDocs":{"description":"JSONPath filter documentation","url":"https://developer.sailpoint.com/idn/docs/event-triggers/filtering-events"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["sp:trigger-service-subscriptions:manage"]}],"method":"patch","path":"/trigger-subscriptions/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"A new description"},{"op":"replace","path":"/name","value":"A new name"}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Patch a Subscription","description":{"content":"This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable:\n\n**name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig**","type":"text/plain"},"url":{"path":["trigger-subscriptions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Subscription to patch","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch a Subscription' (patch-subscription)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch a Subscription + + + +This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: + +**name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** + +
Path Parameters
Request Body array required
    value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    anyOf
  • string
  • integer
    • anyOf
  • string
  • integer
+ +Updated subscription. + +
Schema
    httpConfig object
    + +Config required if HTTP subscription type is used. + +
    basicAuthConfig object
    + +Config required if BASIC_AUTH is used. + +
    bearerTokenAuthConfig object
    + +Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets. + +
    eventBridgeConfig object
    + +Config required if EVENTBRIDGE subscription type is used. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/patch-workflow.api.mdx b/products/idn/api/beta/patch-workflow.api.mdx new file mode 100644 index 000000000..1694a8130 --- /dev/null +++ b/products/idn/api/beta/patch-workflow.api.mdx @@ -0,0 +1,103 @@ +--- +id: patch-workflow +sidebar_label: Patch Workflow +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchWorkflow","tags":["Workflows"],"description":"Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.","security":[{"oauth2":["sp:workflow:manage"]}],"parameters":[{"name":"id","in":"path","description":"Id of the Workflow","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b"}}],"requestBody":{"required":true,"content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"examples":{"Update all patchable fields":{"description":"Demonstrate how to update each patchable field in one PATCH request.","value":[{"op":"replace","path":"/name","value":"Send Email"},{"op":"replace","path":"/owner","value":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"}},{"op":"replace","path":"/description","value":"Send an email to the identity who's attributes changed."},{"op":"replace","path":"/enabled","value":false},{"op":"replace","path":"/definition","value":{"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"}}}},{"op":"replace","path":"/trigger","value":{"type":"EVENT","attributes":{"id":"idn:identity-attributes-changed"}}}]}}}}},"responses":{"200":{"description":"The Workflow object","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","description":"Workflow ID. This is a UUID generated upon creation.","example":"d201c5e9-d37b-4aff-af14-66414f39d569"},"executionCount":{"type":"integer","format":"int32","description":"The number of times this workflow has been executed","example":2},"failureCount":{"type":"integer","format":"int32","description":"The number of times this workflow has failed during execution","example":0},"created":{"type":"string","format":"date-time","description":"The date and time the workflow was created","example":"2022-01-10T16:06:16.636381447Z"},"creator":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that created the workflow.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}},"example":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"}}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the workflow","example":"Send Email"},"owner":{"description":"The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request.","properties":{"type":{"type":"string","enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"},"id":{"type":"string","description":"The unique ID of the object","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The name of the object","example":"William Wilson"}}},"description":{"type":"string","description":"Description of what the workflow accomplishes","example":"Send an email to the identity who's attributes changed."},"definition":{"type":"object","description":"The map of steps that the workflow will execute.","properties":{"start":{"type":"string","description":"The name of the starting step.","example":"Send Email Test"},"steps":{"type":"object","description":"One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type.","additionalProperties":true,"example":{"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":{"type":"boolean","description":"Enable or disable the workflow. Workflows cannot be created in an enabled state.","default":false,"example":false},"trigger":{"type":"object","description":"The trigger that starts the workflow","required":["type","attributes"],"properties":{"type":{"type":"string","enum":["EVENT","EXTERNAL","SCHEDULED"],"example":"EVENT","description":"The trigger type"},"attributes":{"anyOf":[{"title":"Event Trigger Attributes","type":"object","description":"Attributes related to an IdentityNow ETS event","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the trigger","example":"idn:identity-attributes-changed"},"filter.$":{"type":"string","description":"JSON path expression that will limit which events the trigger will fire on","example":"$.changes[?(@.attribute == 'manager')]"}}},{"title":"External Trigger Attributes","type":"object","description":"Attributes related to an external trigger","required":["name"],"properties":{"name":{"type":"string","description":"A unique name for the external trigger","example":"search-and-notify"},"description":{"type":"string","description":"Additonal context about the external trigger","example":"Run a search and notify the results"}}},{"title":"Scheduled Trigger Attributes","type":"object","description":"Attributes related to a scheduled trigger","required":["cronString"],"properties":{"cronString":{"type":"string","description":"A valid CRON expression","externalDocs":{"description":"CRON expression editor","url":"https://crontab.guru/"},"example":"0 * */3 */5 *"}}}],"description":"Workflow Trigger Attributes."}}}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/workflows/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Patch Workflow","description":{"content":"Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.","type":"text/plain"},"url":{"path":["workflows",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the Workflow","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch Workflow' (patch-workflow)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch Workflow + + + +Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +
Path Parameters
Request Body array required
    value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    anyOf
  • string
  • integer
    • anyOf
  • string
  • integer
+ +The Workflow object + +
Schema
    creator object
    + +The identity that created the workflow. + +
    owner
    + +The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request. + +
    definition object
    + +The map of steps that the workflow will execute. + +
    steps object
    + +One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. + +
    trigger object
    + +The trigger that starts the workflow + +
    attributes object
    + +Workflow Trigger Attributes. + +
    anyOf
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/peek-resource-objects.api.mdx b/products/idn/api/beta/peek-resource-objects.api.mdx new file mode 100644 index 000000000..0c40ddffb --- /dev/null +++ b/products/idn/api/beta/peek-resource-objects.api.mdx @@ -0,0 +1,92 @@ +--- +id: peek-resource-objects +sidebar_label: Peek source connector's resource objects +hide_title: true +hide_table_of_contents: true +api: {"operationId":"peekResourceObjects","tags":["Sources"],"description":"Retrieves a sample of data returned from account and group aggregation requests.\nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:source-connector:manage"]}],"parameters":[{"in":"path","name":"sourceId","schema":{"type":"string"},"required":true,"description":"The ID of the Source","example":"cef3ee201db947c5912551015ba0c679"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"objectType":"resource","maxCount":50},"type":"object","title":"Resource Objects Request","description":"Request model for peek resource objects from source connectors.","properties":{"objectType":{"type":"string","description":"The type of resource objects to iterate over.","default":"account","example":"group"},"maxCount":{"type":"integer","description":"The maximum number of resource objects to iterate over and return.","default":25,"example":100}}}}}},"responses":{"200":{"description":"List of resource objects that was fetched from the source connector.","content":{"application/json":{"schema":{"type":"object","title":"Resource Objects Response","description":"Response model for peek resource objects from source connectors.","properties":{"id":{"type":"string","description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313","readOnly":true},"name":{"type":"string","description":"Name of the source","example":"ODS-AD-Test [source-999999]","readOnly":true},"objectCount":{"type":"integer","description":"The number of objects that were fetched by the connector.","example":25,"readOnly":true},"elapsedMillis":{"type":"integer","description":"The number of milliseconds spent on the entire request.","example":1055,"readOnly":true},"resourceObjects":{"type":"array","items":{"type":"object","title":"Resource Object","description":"Representation of the object which is returned from source connectors.","properties":{"instance":{"description":"Identifier of the specific instance where this object resides.","type":"string","readOnly":true},"identity":{"description":"Native identity of the object in the Source.","type":"string","example":"CN=Aaron Carr,OU=test1,DC=test2,DC=test","readOnly":true},"uuid":{"description":"Universal unique identifier of the object in the Source.","type":"string","example":"{abf7bd9b-68b4-4d21-9b70-870c58ebf844}","readOnly":true},"previousIdentity":{"description":"Native identity that the object has previously.","type":"string","readOnly":true},"name":{"description":"Display name for this object.","type":"string","example":"Aaron Carr","readOnly":true},"objectType":{"description":"Type of object.","type":"string","example":"account","readOnly":true},"incomplete":{"description":"A flag indicating that this is an incomplete object. Used in special cases where the connector has to return account information in several phases and the objects might not have a complete set of all account attributes. The attributes in this object will replace the corresponding attributes in the Link, but no other Link attributes will be changed.","type":"boolean","example":false,"readOnly":true},"incremental":{"description":"A flag indicating that this is an incremental change object. This is similar to incomplete but it also means that the values of any multi-valued attributes in this object should be merged with the existing values in the Link rather than replacing the existing Link value.","type":"boolean","example":false,"readOnly":true},"delete":{"description":"A flag indicating that this object has been deleted. This is set only when doing delta aggregation and the connector supports detection of native deletes.","type":"boolean","example":false,"readOnly":true},"remove":{"description":"A flag set indicating that the values in the attributes represent things to remove rather than things to add. Setting this implies incremental. The values which are always for multi-valued attributes are removed from the current values.","type":"boolean","example":false,"readOnly":true},"missing":{"description":"A list of attribute names that are not included in this object. This is only used with SMConnector and will only contain \"groups\".","type":"array","items":{"type":"string"},"example":["missFieldOne","missFieldTwo"],"readOnly":true},"attributes":{"description":"Attributes of this ResourceObject.","type":"object","example":{"telephoneNumber":"12-(345)678-9012","mail":"example@test.com","displayName":"Aaron Carr"},"readOnly":true},"finalUpdate":{"description":"In Aggregation, for sparse object the count for total accounts scanned identities updated is not incremented.","type":"boolean","example":false,"readOnly":true}}},"description":"Fetched objects from the source connector.","readOnly":true}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sources/{sourceId}/connector/peek-resource-objects","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"objectType":"resource","maxCount":50},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Peek source connector's resource objects","description":{"content":"Retrieves a sample of data returned from account and group aggregation requests.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":sourceId","connector","peek-resource-objects"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the Source","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Peek source connector's resource objects' (peek-resource-objects)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Peek source connector's resource objects + + + +Retrieves a sample of data returned from account and group aggregation requests. +A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
Request Body required
+ +List of resource objects that was fetched from the source connector. + +
Schema
    resourceObjects object[]
    + +Fetched objects from the source connector. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/personal-access-tokens.tag.mdx b/products/idn/api/beta/personal-access-tokens.tag.mdx new file mode 100644 index 000000000..4a11a5bb9 --- /dev/null +++ b/products/idn/api/beta/personal-access-tokens.tag.mdx @@ -0,0 +1,31 @@ +--- +id: personal-access-tokens +title: "Personal Access Tokens" +description: "Personal Access Tokens" +custom_edit_url: null +--- + + + +Use this API to implement personal access token (PAT) functionality. +With this functionality in place, users can use PATs as an alternative to passwords for authentication in IdentityNow. + +PATs embed user information into the client ID and secret. +This replaces the API clients' need to store and provide a username and password to establish a connection, improving IdentityNow organizations' integration security. + +In IdentityNow, users can do the following to create and manage their PATs: Select the dropdown menu under their names, select Preferences, and then select Personal Access Tokens. +They must then provide a description about the token's purpose. +They can then select 'Create Token' at the bottom of the page to generate and view the Secret and Client ID. + +Refer to [Managing Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/generate_tokens.html) for more information about PATs. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/ping-cluster.api.mdx b/products/idn/api/beta/ping-cluster.api.mdx new file mode 100644 index 000000000..520a64507 --- /dev/null +++ b/products/idn/api/beta/ping-cluster.api.mdx @@ -0,0 +1,88 @@ +--- +id: ping-cluster +sidebar_label: Ping cluster for source connector +hide_title: true +hide_table_of_contents: true +api: {"operationId":"pingCluster","tags":["Sources"],"description":"This endpoint validates that the cluster being used by the source is reachable from IdentityNow.\nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:source-connector:manage"]}],"parameters":[{"in":"path","name":"sourceId","schema":{"type":"string"},"required":true,"description":"The ID of the Source","example":"cef3ee201db947c5912551015ba0c679"}],"responses":{"200":{"description":"The result of pinging connection with the source connector.","content":{"application/json":{"schema":{"type":"object","title":"Status Response","description":"Response model for connection check, configuration test and ping of source connectors.","properties":{"id":{"type":"string","description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313","readOnly":true},"name":{"type":"string","description":"Name of the source","example":"ODS-AD-Test [source-999999]","readOnly":true},"status":{"type":"string","enum":["SUCCESS","FAILURE"],"description":"The status of the health check.","example":"SUCCESS","readOnly":true},"elapsedMillis":{"type":"integer","description":"The number of milliseconds spent on the entire request.","example":1000,"readOnly":true},"details":{"type":"object","description":"The document contains the results of the health check.\nThe schema of this document depends on the type of source used.\n","readOnly":true,"example":{"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"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sources/{sourceId}/connector/ping-cluster","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Ping cluster for source connector","description":{"content":"This endpoint validates that the cluster being used by the source is reachable from IdentityNow.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":sourceId","connector","ping-cluster"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the Source","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Ping cluster for source connector' (ping-cluster)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Ping cluster for source connector + + + +This endpoint validates that the cluster being used by the source is reachable from IdentityNow. +A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
+ +The result of pinging connection with the source connector. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/post-external-execute-workflow.api.mdx b/products/idn/api/beta/post-external-execute-workflow.api.mdx new file mode 100644 index 000000000..43abeb229 --- /dev/null +++ b/products/idn/api/beta/post-external-execute-workflow.api.mdx @@ -0,0 +1,75 @@ +--- +id: post-external-execute-workflow +sidebar_label: Execute Workflow via External Trigger +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postExternalExecuteWorkflow","tags":["Workflows"],"description":"This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body.","security":[{"oauth2":["sp:workflow-execute:external"]}],"parameters":[{"name":"id","in":"path","description":"Id of the workflow","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"input":{"type":"object","description":"The input for the workflow","example":{"customAttribute1":"value1","customAttribute2":"value2"}}}}}}},"responses":{"200":{"description":"The Workflow object","content":{"application/json":{"schema":{"type":"object","properties":{"workflowExecutionId":{"type":"string","description":"The workflow execution id","example":"0e11cefa-96e7-4b67-90d0-065bc1da5753"},"message":{"type":"string","description":"An error message if any errors occurred","example":"Workflow was not executed externally. Check enabled flag on workflow definition"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/workflows/execute/external/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"input":{"customAttribute1":"value1","customAttribute2":"value2"}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Execute Workflow via External Trigger","description":{"content":"This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body.","type":"text/plain"},"url":{"path":["workflows","execute","external",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the workflow","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Execute Workflow via External Trigger' (post-external-execute-workflow)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Execute Workflow via External Trigger + + + +This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. + +
Path Parameters
Request Body
+ +The Workflow object + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/post-workflow-external-trigger.api.mdx b/products/idn/api/beta/post-workflow-external-trigger.api.mdx new file mode 100644 index 000000000..6654b2df3 --- /dev/null +++ b/products/idn/api/beta/post-workflow-external-trigger.api.mdx @@ -0,0 +1,75 @@ +--- +id: post-workflow-external-trigger +sidebar_label: Generate External Trigger OAuth Client +hide_title: true +hide_table_of_contents: true +api: {"operationId":"postWorkflowExternalTrigger","tags":["Workflows"],"description":"Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow.","security":[{"oauth2":["sp:workflow:manage"]}],"parameters":[{"name":"id","in":"path","description":"Id of the workflow","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b"}}],"responses":{"200":{"description":"The OAuth Client object","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"OAuth client ID for the trigger. This is a UUID generated upon creation.","example":"1a58c03a6bf64dc2876f6988c6e2c7b7"},"secret":{"type":"string","description":"OAuthClient secret.","example":"00cc24a7fe810fe06a7cb38bc168ae104d703c7abb296f9944dc68e69ddb578b"},"url":{"type":"string","description":"URL for the external trigger to invoke","example":"https://tenant.api.identitynow.com/beta/workflows/execute/external/c17bea3a-574d-453c-9e04-4365fbf5af0b"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/workflows/{id}/external/oauth-clients","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Generate External Trigger OAuth Client","description":{"content":"Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow.","type":"text/plain"},"url":{"path":["workflows",":id","external","oauth-clients"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the workflow","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Generate External Trigger OAuth Client' (post-workflow-external-trigger)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Generate External Trigger OAuth Client + + + +Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. + +
Path Parameters
+ +The OAuth Client object + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/predict-sod-violations.api.mdx b/products/idn/api/beta/predict-sod-violations.api.mdx new file mode 100644 index 000000000..0d3ce1051 --- /dev/null +++ b/products/idn/api/beta/predict-sod-violations.api.mdx @@ -0,0 +1,105 @@ +--- +id: predict-sod-violations +sidebar_label: Predict SOD violations for the given identity if they were granted the given access. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"predictSodViolations","tags":["SOD Violations"],"description":"This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused.\n\nA token with ORG_ADMIN or API authority is required to call this API.","requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"An identity with a set of access to be added","required":["identityId","accessRefs"],"type":"object","properties":{"identityId":{"description":"Identity id to be checked.","type":"string","example":"2c91808568c529c60168cca6f90c1313"},"accessRefs":{"description":"The list of ENTITLEMENTs to consider for calculating possible violations in a preventive check.","type":"array","items":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The types of objects supported for SOD violations","properties":{"type":{"enum":["ENTITLEMENT"],"example":"ENTITLEMENT","description":"The type of object that is referenced"}}},"example":[{"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"}]}}},"example":{"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"}]}}}},"responses":{"200":{"description":"Violation Contexts","content":{"application/json":{"schema":{"description":"An object containing a listing of the SOD violation reasons detected by this check.","required":["requestId"],"type":"object","properties":{"violationContexts":{"type":"array","description":"List of Violation Contexts","items":{"type":"object","properties":{"policy":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object","properties":{"type":{"type":"string","example":"SOD_POLICY"},"name":{"type":"string","example":"A very cool policy name"}}}],"description":"The types of objects supported for SOD violations","properties":{"type":{"enum":["ENTITLEMENT"],"example":"ENTITLEMENT","description":"The type of object that is referenced"}}},"conflictingAccessCriteria":{"nullable":false,"type":"object","properties":{"leftCriteria":{"type":"object","properties":{"criteriaList":{"type":"array","description":"List of exception criteria. There is a min of 1 and max of 50 items in the list.","items":{"allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local"},"existing":{"type":"boolean","description":"Whether the subject identity already had that access or not","example":true}},"description":"Access reference with addition of boolean existing flag to indicate whether the access was extant"}],"description":"The types of objects supported for SOD violations","properties":{"type":{"enum":["ENTITLEMENT"],"example":"ENTITLEMENT","description":"The type of object that is referenced"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","existing":true},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","existing":false}]}}},"rightCriteria":{"type":"object","properties":{"criteriaList":{"type":"array","description":"List of exception criteria. There is a min of 1 and max of 50 items in the list.","items":{"allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local"},"existing":{"type":"boolean","description":"Whether the subject identity already had that access or not","example":true}},"description":"Access reference with addition of boolean existing flag to indicate whether the access was extant"}],"description":"The types of objects supported for SOD violations","properties":{"type":{"enum":["ENTITLEMENT"],"example":"ENTITLEMENT","description":"The type of object that is referenced"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","existing":true},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","existing":false}]}}}}}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sod-violations/predict","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"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"}]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Predict SOD violations for the given identity if they were granted the given access.","description":{"content":"This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused.\n\nA token with ORG_ADMIN or API authority is required to call this API.","type":"text/plain"},"url":{"path":["sod-violations","predict"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Predict SOD violations for the given identity if they were granted the given access.' (predict-sod-violations)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Predict SOD violations for the given identity if they were granted the given access. + + + +This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. + +A token with ORG_ADMIN or API authority is required to call this API. + +
Request Body required
    accessRefs object[] required
    + +The list of ENTITLEMENTs to consider for calculating possible violations in a preventive check. + +
+ +Violation Contexts + +
Schema
    violationContexts object[]
    + +List of Violation Contexts + +
    policy object
    conflictingAccessCriteria object
    leftCriteria object
    criteriaList object[]
    + +List of exception criteria. There is a min of 1 and max of 50 items in the list. + +
    rightCriteria object
    criteriaList object[]
    + +List of exception criteria. There is a min of 1 and max of 50 items in the list. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/public-identities-config.tag.mdx b/products/idn/api/beta/public-identities-config.tag.mdx new file mode 100644 index 000000000..ccaa0408f --- /dev/null +++ b/products/idn/api/beta/public-identities-config.tag.mdx @@ -0,0 +1,30 @@ +--- +id: public-identities-config +title: "Public Identities Config" +description: "Public Identities Config" +custom_edit_url: null +--- + + + +Use this API to implement public identity configuration functionality. +With this functionality in place, administrators can make up to 5 identity attributes publicly visible so other non-administrator users can see the relevant information they need to make decisions. +This can be helpful for access approvers, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. + +By default, non-administrators can select an identity and view the following attributes: email, lifecycle state, and manager. +However, it may be helpful for a non-administrator reviewer to see other identity attributes like department, region, title, etc. +Administrators can use this API to make those necessary identity attributes public to non-administrators. + +For example, a non-administrator deciding whether to approve another identity's request for access to the Workday application, whose access may be restricted to members of the HR department, would want to know whether the identity is a member of the HR department. +If an administrator has used [Update Public Identity Config](https://developer.sailpoint.com/idn/api/beta/update-public-identity-config) to make the "department" attribute public, the approver can see the department and make a decision without requesting any more information. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/put-account.api.mdx b/products/idn/api/beta/put-account.api.mdx new file mode 100644 index 000000000..0de7812d4 --- /dev/null +++ b/products/idn/api/beta/put-account.api.mdx @@ -0,0 +1,88 @@ +--- +id: put-account +sidebar_label: Update Account +hide_title: true +hide_table_of_contents: true +api: {"operationId":"putAccount","tags":["Accounts"],"description":"This API submits an account update task and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:accounts:manage"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The account ID","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["attributes"],"properties":{"attributes":{"description":"The schema attribute values for the account","type":"object","example":{"city":"Austin","displayName":"John Doe","userName":"jdoe","sAMAccountName":"jDoe","mail":"john.doe@sailpoint.com"}}}}}}},"responses":{"202":{"description":"Async task details","content":{"application/json":{"schema":{"description":"Accounts async response containing details on started async process","required":["id"],"type":"object","properties":{"id":{"description":"id of the task","type":"string","example":"2c91808474683da6017468693c260195"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/accounts/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"attributes":{"city":"Austin","displayName":"John Doe","userName":"jdoe","sAMAccountName":"jDoe","mail":"john.doe@sailpoint.com"}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update Account","description":{"content":"This API submits an account update task and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The account ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Account' (put-account)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Account + + + +This API submits an account update task and returns the task ID. +A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
Request Body required
+ +Async task details + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/put-client-log-configuration.api.mdx b/products/idn/api/beta/put-client-log-configuration.api.mdx new file mode 100644 index 000000000..dad3c640b --- /dev/null +++ b/products/idn/api/beta/put-client-log-configuration.api.mdx @@ -0,0 +1,107 @@ +--- +id: put-client-log-configuration +sidebar_label: Update managed cluster's log configuration +hide_title: true +hide_table_of_contents: true +api: {"tags":["Managed Clusters"],"description":"Update managed cluster's log configuration","operationId":"putClientLogConfiguration","parameters":[{"name":"id","in":"path","description":"ID of ManagedCluster to update log configuration for","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"aClusterId"}}],"requestBody":{"description":"ClientLogConfiguration for given ManagedCluster","content":{"application/json":{"schema":{"description":"Client Runtime Logging Configuration","nullable":true,"type":"object","required":["durationMinutes","rootLevel"],"properties":{"clientId":{"description":"Log configuration's client ID","type":"string","example":"aClientId"},"durationMinutes":{"description":"Duration in minutes for log configuration to remain in effect before resetting to defaults","type":"integer","format":"int32","example":120,"minimum":5,"maximum":1440},"expiration":{"description":"Expiration date-time of the log configuration request","example":"2020-12-15T19:13:36.079Z","type":"string","format":"date-time"},"rootLevel":{"description":"Root log level to apply, the default level for all logs. For more information about logging levels, refer to the \"Logging Levels\" table in [Enabling Connector Logging in IdentityNow](https://community.sailpoint.com/t5/IdentityNow-Articles/Enabling-Connector-Logging-in-IdentityNow/ta-p/188107).","default":"INFO","example":"TRACE","type":"string","enum":["OFF","FATAL","ERROR","WARN","INFO","DEBUG","TRACE"]},"logLevels":{"description":"Map of log level by key. The keys are logging classes, and the values are logging levels. To see the available connectors and their logging classes, refer to the \"Logging Classes\" table in [Enabling Connector Logging in IdentityNow](https://community.sailpoint.com/t5/IdentityNow-Articles/Enabling-Connector-Logging-in-IdentityNow/ta-p/188107).","example":{"sailpoint.connector.ADLDAPConnector":"TRACE"},"type":"object","additionalProperties":{"default":"INFO","example":"TRACE","description":"Standard Log4j log level","type":"string","enum":["OFF","FATAL","ERROR","WARN","INFO","DEBUG","TRACE"]}}}}}},"required":true},"responses":{"200":{"description":"Responds with updated ClientLogConfiguration for given ManagedCluster","content":{"application/json":{"schema":{"description":"Client Runtime Logging Configuration","nullable":true,"type":"object","required":["durationMinutes","rootLevel"],"properties":{"clientId":{"description":"Log configuration's client ID","type":"string","example":"aClientId"},"durationMinutes":{"description":"Duration in minutes for log configuration to remain in effect before resetting to defaults","type":"integer","format":"int32","example":120,"minimum":5,"maximum":1440},"expiration":{"description":"Expiration date-time of the log configuration request","example":"2020-12-15T19:13:36.079Z","type":"string","format":"date-time"},"rootLevel":{"description":"Root log level to apply, the default level for all logs. For more information about logging levels, refer to the \"Logging Levels\" table in [Enabling Connector Logging in IdentityNow](https://community.sailpoint.com/t5/IdentityNow-Articles/Enabling-Connector-Logging-in-IdentityNow/ta-p/188107).","default":"INFO","example":"TRACE","type":"string","enum":["OFF","FATAL","ERROR","WARN","INFO","DEBUG","TRACE"]},"logLevels":{"description":"Map of log level by key. The keys are logging classes, and the values are logging levels. To see the available connectors and their logging classes, refer to the \"Logging Classes\" table in [Enabling Connector Logging in IdentityNow](https://community.sailpoint.com/t5/IdentityNow-Articles/Enabling-Connector-Logging-in-IdentityNow/ta-p/188107).","example":{"sailpoint.connector.ADLDAPConnector":"TRACE"},"type":"object","additionalProperties":{"default":"INFO","example":"TRACE","description":"Standard Log4j log level","type":"string","enum":["OFF","FATAL","ERROR","WARN","INFO","DEBUG","TRACE"]}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:remote-client:manage"]}],"method":"put","path":"/managed-clusters/{id}/log-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"clientId":"aClientId","durationMinutes":120,"expiration":"2020-12-15T19:13:36.079Z","rootLevel":"TRACE","logLevels":{"sailpoint.connector.ADLDAPConnector":"TRACE"}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update managed cluster's log configuration","description":{"content":"Update managed cluster's log configuration","type":"text/plain"},"url":{"path":["managed-clusters",":id","log-config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of ManagedCluster to update log configuration for","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update managed cluster's log configuration' (put-client-log-configuration)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update managed cluster's log configuration + + + +Update managed cluster's log configuration + +
Path Parameters
Request Body required
+ +ClientLogConfiguration for given ManagedCluster + +
    = 5` and `<= 1440`"} defaultValue={undefined}>
    logLevels object
    + +Map of log level by key. The keys are logging classes, and the values are logging levels. To see the available connectors and their logging classes, refer to the "Logging Classes" table in [Enabling Connector Logging in IdentityNow](https://community.sailpoint.com/t5/IdentityNow-Articles/Enabling-Connector-Logging-in-IdentityNow/ta-p/188107). + +
  • property name* string
    + +**Possible values:** [`OFF`, `FATAL`, `ERROR`, `WARN`, `INFO`, `DEBUG`, `TRACE`] + +
+ +Responds with updated ClientLogConfiguration for given ManagedCluster + +
Schema
    = 5` and `<= 1440`"} defaultValue={undefined}>
    logLevels object
    + +Map of log level by key. The keys are logging classes, and the values are logging levels. To see the available connectors and their logging classes, refer to the "Logging Classes" table in [Enabling Connector Logging in IdentityNow](https://community.sailpoint.com/t5/IdentityNow-Articles/Enabling-Connector-Logging-in-IdentityNow/ta-p/188107). + +
  • property name* string
    + +**Possible values:** [`OFF`, `FATAL`, `ERROR`, `WARN`, `INFO`, `DEBUG`, `TRACE`] + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/put-entitlement-request-config.api.mdx b/products/idn/api/beta/put-entitlement-request-config.api.mdx new file mode 100644 index 000000000..65386af42 --- /dev/null +++ b/products/idn/api/beta/put-entitlement-request-config.api.mdx @@ -0,0 +1,95 @@ +--- +id: put-entitlement-request-config +sidebar_label: Replace Entitlement Request Config +hide_title: true +hide_table_of_contents: true +api: {"operationId":"putEntitlementRequestConfig","tags":["Entitlements"],"description":"This API replaces the entitlement request config for a specified entitlement.","security":[{"oauth2":["idn:entitlement:manage"]}],"parameters":[{"name":"id","in":"path","description":"Entitlement ID","required":true,"schema":{"type":"string","example":"2c91808a7813090a017814121e121518"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accessRequestConfig":{"type":"object","properties":{"approvalSchemes":{"type":"array","description":"Ordered list of approval steps for the access request. Empty when no approval is required.","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["ENTITLEMENT_OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n\n**ENTITLEMENT_OWNER**: Owner of the associated Entitlement\n\n**SOURCE_OWNER**: Owner of the associated Source\n\n**MANAGER**: Manager of the Identity for whom the request is being made\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"e3eab852-8315-467f-9de7-70eda97f63c8"}}}},"requestCommentRequired":{"type":"boolean","description":"If the requester must provide a comment during access request.","default":false,"example":true},"denialCommentRequired":{"type":"boolean","description":"If the reviewer must provide a comment when denying the access request.","default":false,"example":false}}}}}}}},"responses":{"200":{"description":"Responds with the entitlement request config as updated.","content":{"application/json":{"schema":{"type":"object","properties":{"accessRequestConfig":{"type":"object","properties":{"approvalSchemes":{"type":"array","description":"Ordered list of approval steps for the access request. Empty when no approval is required.","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["ENTITLEMENT_OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n\n**ENTITLEMENT_OWNER**: Owner of the associated Entitlement\n\n**SOURCE_OWNER**: Owner of the associated Source\n\n**MANAGER**: Manager of the Identity for whom the request is being made\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"e3eab852-8315-467f-9de7-70eda97f63c8"}}}},"requestCommentRequired":{"type":"boolean","description":"If the requester must provide a comment during access request.","default":false,"example":true},"denialCommentRequired":{"type":"boolean","description":"If the reviewer must provide a comment when denying the access request.","default":false,"example":false}}}}},"example":{"accessRequestConfig":{"requestCommentRequired":true,"denialCommentRequired":true,"approvalSchemes":[{"approverType":"ENTITLEMENT_OWNER","approverId":null},{"approverType":"SOURCE_OWNER","approverId":null},{"approverType":"MANAGER","approverId":null},{"approverType":"GOVERNANCE_GROUP","approverId":"46c79819-a69f-49a2-becb-12c971ae66c6"}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/entitlements/{id}/entitlement-request-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"accessRequestConfig":{"approvalSchemes":[{"approverType":"GOVERNANCE_GROUP","approverId":"e3eab852-8315-467f-9de7-70eda97f63c8"}],"requestCommentRequired":true,"denialCommentRequired":false}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Replace Entitlement Request Config","description":{"content":"This API replaces the entitlement request config for a specified entitlement.","type":"text/plain"},"url":{"path":["entitlements",":id","entitlement-request-config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Entitlement ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Replace Entitlement Request Config' (put-entitlement-request-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Replace Entitlement Request Config + + + +This API replaces the entitlement request config for a specified entitlement. + +
Path Parameters
Request Body required
    accessRequestConfig object
    approvalSchemes object[]
    + +Ordered list of approval steps for the access request. Empty when no approval is required. + +
+ +Responds with the entitlement request config as updated. + +
Schema
    accessRequestConfig object
    approvalSchemes object[]
    + +Ordered list of approval steps for the access request. Empty when no approval is required. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/put-mail-from-attributes.api.mdx b/products/idn/api/beta/put-mail-from-attributes.api.mdx new file mode 100644 index 000000000..a51852da4 --- /dev/null +++ b/products/idn/api/beta/put-mail-from-attributes.api.mdx @@ -0,0 +1,75 @@ +--- +id: put-mail-from-attributes +sidebar_label: Change MAIL FROM domain +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["sp:notification-mail-from-attributes:write"]}],"operationId":"putMailFromAttributes","tags":["Notifications"],"description":"Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identity":{"type":"string","example":"BobSmith@sailpoint.com","description":"The identity or domain address"},"mailFromDomain":{"type":"string","example":"example.sailpoint.com","description":"The new MAIL FROM domain of the identity. Must be a subdomain of the identity."}},"description":"MAIL FROM attributes for a domain / identity"},"example":{"identity":"BobSmith@sailpoint.com","mailFromDomain":"example.sailpoint.com"}}}},"responses":{"200":{"description":"MAIL FROM Attributes required to verify the change","content":{"application/json":{"schema":{"type":"object","properties":{"identity":{"type":"string","example":"bob.smith@sailpoint.com","description":"The email identity"},"mailFromDomain":{"type":"string","example":"foo.sailpoint.com","description":"The name of a domain that an email identity uses as a custom MAIL FROM domain"},"mxRecord":{"type":"string","example":"10 feedback-smtp.us-east-1.amazonses.com","description":"MX record that is required in customer's DNS to allow the domain to receive bounce and complaint notifications that email providers send you"},"txtRecord":{"type":"string","example":"v=spf1 include:amazonses.com ~all","description":"TXT record that is required in customer's DNS in order to prove that Amazon SES is authorized to send email from your domain"},"mailFromDomainStatus":{"type":"string","enum":["PENDING","SUCCESS","FAILED"],"example":"PENDING","description":"The current status of the MAIL FROM verification"}},"description":"MAIL FROM attributes for a domain / identity"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/mail-from-attributes","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"identity":"BobSmith@sailpoint.com","mailFromDomain":"example.sailpoint.com"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Change MAIL FROM domain","description":{"content":"Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS","type":"text/plain"},"url":{"path":["mail-from-attributes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Change MAIL FROM domain' (put-mail-from-attributes)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Change MAIL FROM domain + + + +Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS + +
Request Body required
+ +MAIL FROM Attributes required to verify the change + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/put-notification-preference.api.mdx b/products/idn/api/beta/put-notification-preference.api.mdx new file mode 100644 index 000000000..e7b69ea8c --- /dev/null +++ b/products/idn/api/beta/put-notification-preference.api.mdx @@ -0,0 +1,81 @@ +--- +id: put-notification-preference +sidebar_label: Overwrite the preferences for the given notification key. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"putNotificationPreference","tags":["Notifications"],"description":"In the notification world, a notification flows through these salient stages - \n 1. Interest matching, \n 2. Preferences \n 3. Template Rendering. \n\nThe default notification preferences make up a part of the second stage, along with user preferences (which is a future goal). The expectation is for admins to be able to set default preferences for their org, like opting in to or out of certain notifications, and configuring future preferences as we tack on more features. The key in the Dto is not necessary but if it is provided and doesn't match the key in the URI, then a 400 will be thrown. \nRequest will require the following legacy roles: ORG_ADMIN and API","parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"},"description":"The notification key."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Maps an Identity's attribute key to a list of preferred notification mediums.","properties":{"key":{"type":"string","description":"The template notification key.","example":"cloud_manual_work_item_summary"},"mediums":{"type":"array","description":"List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future.","items":{"type":"string","enum":["EMAIL","SMS","PHONE","SLACK","TEAMS"]},"example":["EMAIL"]},"modified":{"type":"string","description":"Modified date of preference","format":"date-time","example":"2020-05-15T14:37:06.909Z"}}}}}},"responses":{"200":{"description":"The preferences were successfully replaced, and an echo of the new preferences are sent back to caller.","content":{"application/json":{"schema":{"type":"object","description":"Maps an Identity's attribute key to a list of preferred notification mediums.","properties":{"key":{"type":"string","description":"The template notification key.","example":"cloud_manual_work_item_summary"},"mediums":{"type":"array","description":"List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future.","items":{"type":"string","enum":["EMAIL","SMS","PHONE","SLACK","TEAMS"]},"example":["EMAIL"]},"modified":{"type":"string","description":"Modified date of preference","format":"date-time","example":"2020-05-15T14:37:06.909Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}}},"method":"put","path":"/notification-preferences/{key}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"key":"cloud_manual_work_item_summary","mediums":["EMAIL"],"modified":"2020-05-15T14:37:06.909Z"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Overwrite the preferences for the given notification key.","description":{"content":"In the notification world, a notification flows through these salient stages - \n 1. Interest matching, \n 2. Preferences \n 3. Template Rendering. \n\nThe default notification preferences make up a part of the second stage, along with user preferences (which is a future goal). The expectation is for admins to be able to set default preferences for their org, like opting in to or out of certain notifications, and configuring future preferences as we tack on more features. The key in the Dto is not necessary but if it is provided and doesn't match the key in the URI, then a 400 will be thrown. \nRequest will require the following legacy roles: ORG_ADMIN and API","type":"text/plain"},"url":{"path":["notification-preferences",":key"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The notification key.","type":"text/plain"},"type":"any","value":"","key":"key"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Overwrite the preferences for the given notification key.' (put-notification-preference)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Overwrite the preferences for the given notification key. + + + +In the notification world, a notification flows through these salient stages - + 1. Interest matching, + 2. Preferences + 3. Template Rendering. + +The default notification preferences make up a part of the second stage, along with user preferences (which is a future goal). The expectation is for admins to be able to set default preferences for their org, like opting in to or out of certain notifications, and configuring future preferences as we tack on more features. The key in the Dto is not necessary but if it is provided and doesn't match the key in the URI, then a 400 will be thrown. +Request will require the following legacy roles: ORG_ADMIN and API + +
Path Parameters
Request Body required
+ +The preferences were successfully replaced, and an echo of the new preferences are sent back to caller. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
\ No newline at end of file diff --git a/products/idn/api/beta/put-provisioning-policy.api.mdx b/products/idn/api/beta/put-provisioning-policy.api.mdx new file mode 100644 index 000000000..4d476ae67 --- /dev/null +++ b/products/idn/api/beta/put-provisioning-policy.api.mdx @@ -0,0 +1,90 @@ +--- +id: put-provisioning-policy +sidebar_label: Update Provisioning Policy by UsageType +hide_title: true +hide_table_of_contents: true +api: {"operationId":"putProvisioningPolicy","tags":["Sources"],"description":"This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow.\nTransforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.\nRefer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","security":[{"oauth2":["idn:provisioning-policy:manage","idn:provisioning-policy-source-admin-operations:manage"]}],"parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source ID.","example":"2c9180835d191a86015d28455b4a2329"},{"in":"path","name":"usageType","required":true,"schema":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"description":"The type of ProvisioningPolicy usage."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"the provisioning policy name","example":"example provisioning policy for inactive identities"},"description":{"type":"string","description":"the description of the provisioning policy","example":"this provisioning policy creates access based on an identity going inactive"},"usageType":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"userName"},"transform":{"type":"object","description":"The transform to apply to the field","example":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"default":{}},"attributes":{"type":"object","description":"Attributes required for the transform","example":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"}},"type":{"type":"string","description":"The type of the attribute.","example":"string"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","default":false,"example":false}}}}}}}}},"responses":{"200":{"description":"The ProvisioningPolicyDto was successfully replaced.","content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"the provisioning policy name","example":"example provisioning policy for inactive identities"},"description":{"type":"string","description":"the description of the provisioning policy","example":"this provisioning policy creates access based on an identity going inactive"},"usageType":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"userName"},"transform":{"type":"object","description":"The transform to apply to the field","example":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"default":{}},"attributes":{"type":"object","description":"Attributes required for the transform","example":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"}},"isRequired":{"type":"boolean","readOnly":true,"description":"Flag indicating whether or not the attribute is required.","default":false,"example":false},"type":{"type":"string","description":"The type of the attribute.","example":"string"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","default":false,"example":false}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/sources/{sourceId}/provisioning-policies/{usageType}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"example provisioning policy for inactive identities","description":"this provisioning policy creates access based on an identity going inactive","usageType":"CREATE","fields":[{"name":"userName","transform":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"attributes":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"},"type":"string","isMultiValued":false}]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update Provisioning Policy by UsageType","description":{"content":"This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow.\nTransforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.\nRefer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":sourceId","provisioning-policies",":usageType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source ID.","type":"text/plain"},"type":"any","value":"","key":"sourceId"},{"disabled":false,"description":{"content":"(Required) The type of ProvisioningPolicy usage.","type":"text/plain"},"type":"any","value":"","key":"usageType"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Provisioning Policy by UsageType' (put-provisioning-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Provisioning Policy by UsageType + + + +This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. +A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +
Path Parameters
Request Body required
    fields object[]
+ +The ProvisioningPolicyDto was successfully replaced. + +
Schema
    fields object[]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/put-reassignment-config.api.mdx b/products/idn/api/beta/put-reassignment-config.api.mdx new file mode 100644 index 000000000..cdd2de15b --- /dev/null +++ b/products/idn/api/beta/put-reassignment-config.api.mdx @@ -0,0 +1,99 @@ +--- +id: put-reassignment-config +sidebar_label: Update Reassignment Configuration +hide_title: true +hide_table_of_contents: true +api: {"operationId":"putReassignmentConfig","tags":["Work Reassignment"],"description":"Replaces existing Reassignment configuration for an identity with the newly provided configuration.","security":[{"oauth2":["idn:reassignment-configuration:update"]}],"parameters":[{"in":"path","name":"identityId","schema":{"type":"string"},"description":"unique identity id","required":true,"example":"2c91808781a71ddb0181b9090b5c504e"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"The request body for creation or update of a Reassignment Configuration for a single identity and work type","properties":{"reassignedFromId":{"type":"string","description":"The identity id to reassign an item from","example":"2c91808781a71ddb0181b9090b5c504e"},"reassignedToId":{"type":"string","description":"The identity id to reassign an item to","example":"2c91808781a71ddb0181b9090b53504a"},"configType":{"type":"string","description":"Enum list of valid work types that can be selected for a Reassignment Configuration","enum":["ACCESS_REQUESTS","CERTIFICATIONS","MANUAL_TASKS"],"example":"ACCESS_REQUESTS"},"startDate":{"type":"string","description":"The date from which to start reassigning work items","format":"date-time","example":"2022-07-21T11:13:12.345Z"},"endDate":{"type":"string","description":"The date from which to stop reassigning work items. If this is an null string it indicates a permanent reassignment.","format":"date-time","nullable":true,"example":"2022-07-30T17:00:00.000Z"}}}}}},"responses":{"200":{"description":"Reassignment Configuration updated","content":{"application/json":{"schema":{"type":"object","description":"The response body of a Reassignment Configuration for a single identity","properties":{"identity":{"type":"object","description":"The definition of an Identity according to the Reassignment Configuration service","properties":{"id":{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"},"name":{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}},"configDetails":{"type":"array","description":"Details of how work should be reassigned for an Identity","items":{"type":"object","description":"The request body of Reassignment Configuration Details for a specific identity and config type","properties":{"configType":{"type":"string","description":"Enum list of valid work types that can be selected for a Reassignment Configuration","enum":["ACCESS_REQUESTS","CERTIFICATIONS","MANUAL_TASKS"],"example":"ACCESS_REQUESTS"},"targetIdentity":{"type":"object","description":"The definition of an Identity according to the Reassignment Configuration service","properties":{"id":{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"},"name":{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}},"startDate":{"type":"string","description":"The date from which to start reassigning work items","format":"date-time","example":"2022-07-21T11:13:12.345Z"},"endDate":{"type":"string","description":"The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment.","format":"date-time","example":"0001-01-01T00:00:00Z"},"auditDetails":{"type":"object","description":"Audit details for the reassignment configuration of an identity","properties":{"created":{"type":"string","description":"Initial date and time when the record was created","format":"date-time","example":"2022-07-21T11:13:12.345Z"},"createdBy":{"type":"object","description":"The definition of an Identity according to the Reassignment Configuration service","properties":{"id":{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"},"name":{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}},"modified":{"type":"string","description":"Last modified date and time for the record","format":"date-time","example":"2022-07-21T11:13:12.345Z"},"modifiedBy":{"type":"object","description":"The definition of an Identity according to the Reassignment Configuration service","properties":{"id":{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"},"name":{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}}}}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/reassignment-configurations/{identityId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"reassignedFromId":"2c91808781a71ddb0181b9090b5c504e","reassignedToId":"2c91808781a71ddb0181b9090b53504a","configType":"ACCESS_REQUESTS","startDate":"2022-07-21T11:13:12.345Z","endDate":"2022-07-30T17:00:00.000Z"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update Reassignment Configuration","description":{"content":"Replaces existing Reassignment configuration for an identity with the newly provided configuration.","type":"text/plain"},"url":{"path":["reassignment-configurations",":identityId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) unique identity id","type":"text/plain"},"type":"any","value":"","key":"identityId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Reassignment Configuration' (put-reassignment-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Reassignment Configuration + + + +Replaces existing Reassignment configuration for an identity with the newly provided configuration. + +
Path Parameters
Request Body required
+ +Reassignment Configuration updated + +
Schema
    identity object
    + +The definition of an Identity according to the Reassignment Configuration service + +
    configDetails object[]
    + +Details of how work should be reassigned for an Identity + +
    targetIdentity object
    + +The definition of an Identity according to the Reassignment Configuration service + +
    auditDetails object
    + +Audit details for the reassignment configuration of an identity + +
    createdBy object
    + +The definition of an Identity according to the Reassignment Configuration service + +
    modifiedBy object
    + +The definition of an Identity according to the Reassignment Configuration service + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/put-service-desk-integration.api.mdx b/products/idn/api/beta/put-service-desk-integration.api.mdx new file mode 100644 index 000000000..36ba04eed --- /dev/null +++ b/products/idn/api/beta/put-service-desk-integration.api.mdx @@ -0,0 +1,147 @@ +--- +id: put-service-desk-integration +sidebar_label: Update a Service Desk integration +hide_title: true +hide_table_of_contents: true +api: {"tags":["Service Desk Integration"],"description":"Update an existing Service Desk integration by ID with updated value in JSON form as the request body. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","operationId":"putServiceDeskIntegration","parameters":[{"name":"id","in":"path","description":"ID of the Service Desk integration to update","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"anId"}}],"requestBody":{"description":"The specifics of the integration to update","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"},"modified":{"description":"Last modification date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}},{"type":"object","description":"Specification of a Service Desk integration","required":["description","type","attributes"],"properties":{"description":{"description":"Description of the Service Desk integration","type":"string","example":"A very nice Service Desk integration"},"type":{"description":"Service Desk integration types\n\n- ServiceNowSDIM\n- ServiceNow\n","type":"string","default":"ServiceNowSDIM","example":"ServiceNowSDIM"},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the identity that is the owner of this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the identity","example":"MyName"}}},"clusterRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the source cluster for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"cluster":{"description":"ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)","type":"string","example":"xyzzy999","deprecated":true},"managedSources":{"description":"Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)","type":"array","items":{"type":"string"},"deprecated":true,"example":["2c9180835d191a86015d28455b4a2329","2c5680835d191a85765d28455b4a9823"]},"provisioningConfig":{"description":"The 'provisioningConfig' property specifies the configuration used to provision integrations.","type":"object","properties":{"universalManager":{"description":"Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.","type":"boolean","readOnly":true,"example":true},"managedResourceRefs":{"description":"References to sources for the Service Desk integration template. May only be specified if universalManager is false.","type":"array","items":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"properties":{"type":{"description":"The type of object being referenced","enum":["SOURCE"],"example":"SOURCE"},"id":{"description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the source","example":"My Source"}}},"example":[{"type":"SOURCE","id":"2c9180855d191c59015d291ceb051111","name":"My Source 1"},{"type":"SOURCE","id":"2c9180855d191c59015d291ceb052222","name":"My Source 2"}]},"planInitializerScript":{"description":"This is a reference to a plan initializer script.","type":"object","properties":{"source":{"description":"This is a Rule that allows provisioning instruction changes.","type":"string","example":"\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n"}}},"noProvisioningRequests":{"description":"Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.","type":"boolean","example":true},"provisioningRequestExpiration":{"description":"When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.","type":"integer","format":"int32","example":7}}},"attributes":{"description":"Attributes of the Service Desk integration. Validation constraints enforced by the implementation.","type":"object","additionalProperties":true,"example":{"property":"value","key":"value"}},"beforeProvisioningRule":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to beforeProvisioningRule for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["RULE"],"example":"RULE"},"id":{"description":"ID of the rule","example":"2c91808568c529c60168cca6f90c1333"},"name":{"description":"Human-readable display name of the rule","example":"Example Rule"}}}}}]}}},"required":true},"responses":{"200":{"description":"ServiceDeskIntegrationDto as updated","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"},"modified":{"description":"Last modification date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}},{"type":"object","description":"Specification of a Service Desk integration","required":["description","type","attributes"],"properties":{"description":{"description":"Description of the Service Desk integration","type":"string","example":"A very nice Service Desk integration"},"type":{"description":"Service Desk integration types\n\n- ServiceNowSDIM\n- ServiceNow\n","type":"string","default":"ServiceNowSDIM","example":"ServiceNowSDIM"},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the identity that is the owner of this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the identity","example":"MyName"}}},"clusterRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the source cluster for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"cluster":{"description":"ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)","type":"string","example":"xyzzy999","deprecated":true},"managedSources":{"description":"Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)","type":"array","items":{"type":"string"},"deprecated":true,"example":["2c9180835d191a86015d28455b4a2329","2c5680835d191a85765d28455b4a9823"]},"provisioningConfig":{"description":"The 'provisioningConfig' property specifies the configuration used to provision integrations.","type":"object","properties":{"universalManager":{"description":"Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.","type":"boolean","readOnly":true,"example":true},"managedResourceRefs":{"description":"References to sources for the Service Desk integration template. May only be specified if universalManager is false.","type":"array","items":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"properties":{"type":{"description":"The type of object being referenced","enum":["SOURCE"],"example":"SOURCE"},"id":{"description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the source","example":"My Source"}}},"example":[{"type":"SOURCE","id":"2c9180855d191c59015d291ceb051111","name":"My Source 1"},{"type":"SOURCE","id":"2c9180855d191c59015d291ceb052222","name":"My Source 2"}]},"planInitializerScript":{"description":"This is a reference to a plan initializer script.","type":"object","properties":{"source":{"description":"This is a Rule that allows provisioning instruction changes.","type":"string","example":"\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n"}}},"noProvisioningRequests":{"description":"Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.","type":"boolean","example":true},"provisioningRequestExpiration":{"description":"When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.","type":"integer","format":"int32","example":7}}},"attributes":{"description":"Attributes of the Service Desk integration. Validation constraints enforced by the implementation.","type":"object","additionalProperties":true,"example":{"property":"value","key":"value"}},"beforeProvisioningRule":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to beforeProvisioningRule for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["RULE"],"example":"RULE"},"id":{"description":"ID of the rule","example":"2c91808568c529c60168cca6f90c1333"},"name":{"description":"Human-readable display name of the rule","example":"Example Rule"}}}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:service-desk-admin:manage","idn:service-desk-integration:manage"]}],"method":"put","path":"/service-desk-integrations/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"aName","description":"A very nice Service Desk integration","type":"ServiceNowSDIM","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":true},"clusterRef":{"type":true,"id":true,"name":true},"provisioningConfig":{"managedResourceRefs":[{"type":"SOURCE","id":"2c9180855d191c59015d291ceb051111","name":"My Source 1"},{"type":"SOURCE","id":"2c9180855d191c59015d291ceb052222","name":"My Source 2"}],"planInitializerScript":{"source":"\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n"},"noProvisioningRequests":true,"provisioningRequestExpiration":7},"attributes":{"property":"value","key":"value"},"beforeProvisioningRule":{"type":true,"id":true,"name":true}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update a Service Desk integration","description":{"content":"Update an existing Service Desk integration by ID with updated value in JSON form as the request body. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","type":"text/plain"},"url":{"path":["service-desk-integrations",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Service Desk integration to update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a Service Desk integration' (put-service-desk-integration)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a Service Desk integration + + + +Update an existing Service Desk integration by ID with updated value in JSON form as the request body. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +
Path Parameters
Request Body required
+ +The specifics of the integration to update + +
    ownerRef object
    + +Reference to the identity that is the owner of this Service Desk integration + +
    clusterRef object
    + +Reference to the source cluster for this Service Desk integration + +
    provisioningConfig object
    + +The 'provisioningConfig' property specifies the configuration used to provision integrations. + +
    managedResourceRefs object[]
    + +References to sources for the Service Desk integration template. May only be specified if universalManager is false. + +
    planInitializerScript object
    + +This is a reference to a plan initializer script. + +
    attributes object required
    + +Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + +
    beforeProvisioningRule object
    + +Reference to beforeProvisioningRule for this Service Desk integration + +
+ +ServiceDeskIntegrationDto as updated + +
Schema
    ownerRef object
    + +Reference to the identity that is the owner of this Service Desk integration + +
    clusterRef object
    + +Reference to the source cluster for this Service Desk integration + +
    provisioningConfig object
    + +The 'provisioningConfig' property specifies the configuration used to provision integrations. + +
    managedResourceRefs object[]
    + +References to sources for the Service Desk integration template. May only be specified if universalManager is false. + +
    planInitializerScript object
    + +This is a reference to a plan initializer script. + +
    attributes object
    + +Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + +
    beforeProvisioningRule object
    + +Reference to beforeProvisioningRule for this Service Desk integration + +
\\\\r\\\\n\\\\r\\\\n\\\\r\\\\n Before Provisioning Rule which changes disables and enables to a modify.\\\\r\\\\n \\n\"\n },\n \"noProvisioningRequests\": true,\n \"provisioningRequestExpiration\": 7\n },\n \"attributes\": {\n \"property\": \"value\",\n \"key\": \"value\"\n },\n \"beforeProvisioningRule\": {\n \"type\": true,\n \"id\": true,\n \"name\": true\n }\n}"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/put-source-attr-sync-config.api.mdx b/products/idn/api/beta/put-source-attr-sync-config.api.mdx new file mode 100644 index 000000000..4dda3f3ba --- /dev/null +++ b/products/idn/api/beta/put-source-attr-sync-config.api.mdx @@ -0,0 +1,105 @@ +--- +id: put-source-attr-sync-config +sidebar_label: Update Attribute Sync Config +hide_title: true +hide_table_of_contents: true +api: {"operationId":"putSourceAttrSyncConfig","tags":["Sources"],"description":"Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error.\n \nA token with ORG_ADMIN authority is required to call this API.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"The source id","example":"2c9180835d191a86015d28455b4a2329"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Specification of attribute sync configuration for a source","required":["source","attributes"],"properties":{"source":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Reference to the source which is the target of the attribute synchronization","example":[{"type":"SOURCE","id":"2c9180835d191a86015d28455b4b232a","name":"HR Active Directory"}]},"attributes":{"type":"array","description":"Attribute synchronization configuration for specific identity attributes in the context of a source","items":{"type":"object","description":"Specification of source attribute sync mapping configuration for an identity attribute","required":["name","displayName","enabled","target"],"properties":{"name":{"type":"string","description":"Name of the identity attribute","example":"email"},"displayName":{"type":"string","description":"Display name of the identity attribute","example":"Email"},"enabled":{"type":"boolean","description":"Determines whether or not the attribute is enabled for synchronization","example":true},"target":{"type":"string","description":"Name of the source account attribute to which the identity attribute value will be synchronized if enabled","example":"mail"}}},"example":[{"name":"email","displayName":"Email","enabled":true,"target":"mail"},{"name":"firstname","displayName":"First Name","enabled":false,"target":"givenName"}]}}}}}},"responses":{"200":{"description":"Updated attribute synchronization configuration for a source","content":{"application/json":{"schema":{"type":"object","description":"Specification of attribute sync configuration for a source","required":["source","attributes"],"properties":{"source":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Reference to the source which is the target of the attribute synchronization","example":[{"type":"SOURCE","id":"2c9180835d191a86015d28455b4b232a","name":"HR Active Directory"}]},"attributes":{"type":"array","description":"Attribute synchronization configuration for specific identity attributes in the context of a source","items":{"type":"object","description":"Specification of source attribute sync mapping configuration for an identity attribute","required":["name","displayName","enabled","target"],"properties":{"name":{"type":"string","description":"Name of the identity attribute","example":"email"},"displayName":{"type":"string","description":"Display name of the identity attribute","example":"Email"},"enabled":{"type":"boolean","description":"Determines whether or not the attribute is enabled for synchronization","example":true},"target":{"type":"string","description":"Name of the source account attribute to which the identity attribute value will be synchronized if enabled","example":"mail"}}},"example":[{"name":"email","displayName":"Email","enabled":true,"target":"mail"},{"name":"firstname","displayName":"First Name","enabled":false,"target":"givenName"}]}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/sources/{id}/attribute-sync-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"source":[{"type":"SOURCE","id":"2c9180835d191a86015d28455b4b232a","name":"HR Active Directory"}],"attributes":[{"name":"email","displayName":"Email","enabled":true,"target":"mail"},{"name":"firstname","displayName":"First Name","enabled":false,"target":"givenName"}]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update Attribute Sync Config","description":{"content":"Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error.\n \nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":id","attribute-sync-config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The source id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Attribute Sync Config' (put-source-attr-sync-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Attribute Sync Config + + + +Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the "enabled" field of the values in the "attributes" array is mutable. Attempting to change other attributes or add new values to the "attributes" array will result in an error. + +A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
Request Body required
    source object required
    + +Reference to the source which is the target of the attribute synchronization + +
    attributes object[] required
    + +Attribute synchronization configuration for specific identity attributes in the context of a source + +
+ +Updated attribute synchronization configuration for a source + +
Schema
    source object
    + +Reference to the source which is the target of the attribute synchronization + +
    attributes object[]
    + +Attribute synchronization configuration for specific identity attributes in the context of a source + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/put-source-schema.api.mdx b/products/idn/api/beta/put-source-schema.api.mdx new file mode 100644 index 000000000..0d1249617 --- /dev/null +++ b/products/idn/api/beta/put-source-schema.api.mdx @@ -0,0 +1,108 @@ +--- +id: put-source-schema +sidebar_label: Update Source Schema (Full) +hide_title: true +hide_table_of_contents: true +api: {"operationId":"putSourceSchema","tags":["Sources"],"description":"This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below.\n* id\n* name\n* created\n* modified\nAny attempt to modify these fields will result in an error response with a status code of 400.","parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source ID.","example":"2c9180835d191a86015d28455b4a2329"},{"in":"path","name":"schemaId","schema":{"type":"string"},"required":true,"description":"The Schema ID.","example":"2c9180835d191a86015d28455b4a2329"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Schema.","example":"2c9180835d191a86015d28455b4a2329"},"name":{"type":"string","description":"The name of the Schema.","example":"account"},"nativeObjectType":{"type":"string","description":"The name of the object type on the native system that the schema represents.","example":"User"},"identityAttribute":{"type":"string","description":"The name of the attribute used to calculate the unique identifier for an object in the schema.","example":"sAMAccountName"},"displayAttribute":{"type":"string","description":"The name of the attribute used to calculate the display value for an object in the schema.","example":"distinguishedName"},"hierarchyAttribute":{"type":"string","description":"The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.","example":"memberOf"},"includePermissions":{"type":"boolean","description":"Flag indicating whether or not the include permissions with the object data when aggregating the schema.","example":false},"features":{"type":"array","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING."},"description":"The features that the schema supports.","example":["PROVISIONING","NO_PERMISSIONS_PROVISIONING","GROUPS_HAVE_MEMBERS"]},"configuration":{"type":"object","description":"Holds any extra configuration data that the schema may require.","example":{"groupMemberAttribute":"member"}},"attributes":{"type":"array","description":"The attribute definitions which form the schema.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"sAMAccountName"},"type":{"type":"string","enum":["STRING","LONG","INT","BOOLEAN"],"description":"The underlying type of the value which an AttributeDefinition represents.","example":"STRING"},"schema":{"description":"A reference to the schema on the source to the attribute values map to.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"The object ID this reference applies to.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The human-readable display name of the object.","example":"group"}}},"description":{"type":"string","description":"A human-readable description of the attribute.","example":"The sAMAccountName attribute"},"isMulti":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","example":false},"isEntitlement":{"type":"boolean","description":"Flag indicating whether or not the attribute is an entitlement.","example":false},"isGroup":{"type":"boolean","description":"Flag indicating whether or not the attribute represents a group.\nThis can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute..\n","example":false}}},"example":[{"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":{"type":"string","description":"The date the Schema was created.","format":"date-time","example":"2019-12-24T22:32:58.104Z"},"modified":{"type":"string","description":"The date the Schema was last modified.","format":"date-time","example":"2019-12-31T20:22:28.104Z"}}}}}},"responses":{"200":{"description":"The Schema was successfully replaced.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Schema.","example":"2c9180835d191a86015d28455b4a2329"},"name":{"type":"string","description":"The name of the Schema.","example":"account"},"nativeObjectType":{"type":"string","description":"The name of the object type on the native system that the schema represents.","example":"User"},"identityAttribute":{"type":"string","description":"The name of the attribute used to calculate the unique identifier for an object in the schema.","example":"sAMAccountName"},"displayAttribute":{"type":"string","description":"The name of the attribute used to calculate the display value for an object in the schema.","example":"distinguishedName"},"hierarchyAttribute":{"type":"string","description":"The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.","example":"memberOf"},"includePermissions":{"type":"boolean","description":"Flag indicating whether or not the include permissions with the object data when aggregating the schema.","example":false},"features":{"type":"array","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING."},"description":"The features that the schema supports.","example":["PROVISIONING","NO_PERMISSIONS_PROVISIONING","GROUPS_HAVE_MEMBERS"]},"configuration":{"type":"object","description":"Holds any extra configuration data that the schema may require.","example":{"groupMemberAttribute":"member"}},"attributes":{"type":"array","description":"The attribute definitions which form the schema.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"sAMAccountName"},"type":{"type":"string","enum":["STRING","LONG","INT","BOOLEAN"],"description":"The underlying type of the value which an AttributeDefinition represents.","example":"STRING"},"schema":{"description":"A reference to the schema on the source to the attribute values map to.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"The object ID this reference applies to.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The human-readable display name of the object.","example":"group"}}},"description":{"type":"string","description":"A human-readable description of the attribute.","example":"The sAMAccountName attribute"},"isMulti":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","example":false},"isEntitlement":{"type":"boolean","description":"Flag indicating whether or not the attribute is an entitlement.","example":false},"isGroup":{"type":"boolean","description":"Flag indicating whether or not the attribute represents a group.\nThis can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute..\n","example":false}}},"example":[{"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":{"type":"string","description":"The date the Schema was created.","format":"date-time","example":"2019-12-24T22:32:58.104Z"},"modified":{"type":"string","description":"The date the Schema was last modified.","format":"date-time","example":"2019-12-31T20:22:28.104Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/sources/{sourceId}/schemas/{schemaId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"id":"2c9180835d191a86015d28455b4a2329","name":"account","nativeObjectType":"User","identityAttribute":"sAMAccountName","displayAttribute":"distinguishedName","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}],"created":"2019-12-24T22:32:58.104Z","modified":"2019-12-31T20:22:28.104Z"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update Source Schema (Full)","description":{"content":"This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below.\n* id\n* name\n* created\n* modified\nAny attempt to modify these fields will result in an error response with a status code of 400.","type":"text/plain"},"url":{"path":["sources",":sourceId","schemas",":schemaId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source ID.","type":"text/plain"},"type":"any","value":"","key":"sourceId"},{"disabled":false,"description":{"content":"(Required) The Schema ID.","type":"text/plain"},"type":"any","value":"","key":"schemaId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Source Schema (Full)' (put-source-schema)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Source Schema (Full) + + + +This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. +* id +* name +* created +* modified +Any attempt to modify these fields will result in an error response with a status code of 400. + +
Path Parameters
Request Body required
    attributes object[]
    + +The attribute definitions which form the schema. + +
    schema object
    + +A reference to the schema on the source to the attribute values map to. + +
+ +The Schema was successfully replaced. + +
Schema
    attributes object[]
    + +The attribute definitions which form the schema. + +
    schema object
    + +A reference to the schema on the source to the attribute values map to. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/put-source.api.mdx b/products/idn/api/beta/put-source.api.mdx new file mode 100644 index 000000000..de7a686f0 --- /dev/null +++ b/products/idn/api/beta/put-source.api.mdx @@ -0,0 +1,182 @@ +--- +id: put-source +sidebar_label: Update Source (Full) +hide_title: true +hide_table_of_contents: true +api: {"operationId":"putSource","security":[{"oauth2":["idn:sources:manage"]}],"tags":["Sources"],"description":"This API updates a source in IdentityNow, using a full object representation. In other words, the existing Source\nconfiguration is completely replaced.\n\nSome fields are immutable and cannot be changed, such as:\n\n* id\n* type\n* authoritative\n* connector\n* connectorClass\n* passwordPolicies\n\nAttempts to modify these fields will result in a 400 error.\n\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.\n","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Source id","example":"2c9180835d191a86015d28455b4a2329"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"the id of the Source","example":"2c91808568c529c60168cca6f90c1324"},"name":{"type":"string","description":"Human-readable name of the source","example":"My Source"},"description":{"type":"string","description":"Human-readable description of the source","example":"This is the corporate directory."},"owner":{"description":"Reference to an owning Identity Object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity","example":"MyName"}}},"cluster":{"description":"Reference to the associated Cluster","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"type":"string","description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"accountCorrelationConfig":{"description":"Reference to an Account Correlation Config object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG"],"example":"ACCOUNT_CORRELATION_CONFIG"},"id":{"type":"string","description":"ID of the account correlation config","example":"2c9180855d191c59015d28583727245a"},"name":{"type":"string","description":"Human-readable display name of the account correlation config","example":"Directory [source-62867] Account Correlation"}}},"accountCorrelationRule":{"description":"Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"managerCorrelationMapping":{"description":"Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity","type":"object","properties":{"accountAttribute":{"type":"string","description":"Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.","example":"manager"},"identityAttribute":{"type":"string","description":"Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.","example":"manager"}}},"managerCorrelationRule":{"description":"Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"beforeProvisioningRule":{"description":"Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"schemas":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"ID of the schema","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the schema","example":"MySchema"}}},"description":"List of references to Schema objects","example":[{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232a","name":"account"},{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232b","name":"group"}]},"passwordPolicies":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["PASSWORD_POLICY"],"example":"PASSWORD_POLICY"},"id":{"type":"string","description":"ID of the policy","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the policy","example":"My Password Policy"}}},"description":"List of references to the associated PasswordPolicy objects.","example":[{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb053980","name":"Corporate Password Policy"},{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb057777","name":"Vendor Password Policy"}]},"features":{"type":"array","description":"Optional features that can be supported by a source.","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING."},"example":["SYNC_PROVISIONING","MANAGER_LOOKUP","SEARCH","PROVISIONING","AUTHENTICATE","GROUP_PROVISIONING","PASSWORD"]},"type":{"type":"string","description":"Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ","example":"OpenLDAP - Direct"},"connector":{"type":"string","description":"Connector script name.","example":"active-directory"},"connectorClass":{"type":"string","description":"The fully qualified name of the Java class that implements the connector interface.","example":"sailpoint.connector.LDAPConnector"},"connectorAttributes":{"type":"object","description":"Connector specific configuration; will differ from type to type.","example":{"healthCheckTimeout":30,"authSearchAttributes":["cn","uid","mail"]}},"deleteThreshold":{"type":"integer","format":"int32","description":"Number from 0 to 100 that specifies when to skip the delete phase.","example":10},"authoritative":{"type":"boolean","description":"When true indicates the source is referenced by an IdentityProfile.","example":false},"managementWorkgroup":{"description":"Reference to Management Workgroup for this Source","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["GOVERNANCE_GROUP"],"example":"GOVERNANCE_GROUP"},"id":{"type":"string","description":"ID of the management workgroup","example":"2c91808568c529c60168cca6f90c2222"},"name":{"type":"string","description":"Human-readable display name of the management workgroup","example":"My Management Workgroup"}}},"healthy":{"type":"boolean","description":"When true indicates a healthy source","example":true},"status":{"type":"string","description":"A status identifier, giving specific information on why a source is healthy or not","example":"SOURCE_STATE_HEALTHY"},"since":{"type":"string","description":"Timestamp showing when a source health check was last performed","example":"2021-09-28T15:48:29.3801666300Z"},"connectorId":{"type":"string","description":"The id of connector","example":"active-directory"},"connectorName":{"type":"string","description":"The name of the connector that was chosen on source creation","example":"Active Directory"},"connectionType":{"type":"string","description":"The type of connection (direct or file)","example":"file"},"connectorImplementstionId":{"type":"string","description":"The connector implementstion id","example":"delimited-file"}},"required":["name","owner","connector"]}}}},"responses":{"200":{"description":"Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"the id of the Source","example":"2c91808568c529c60168cca6f90c1324"},"name":{"type":"string","description":"Human-readable name of the source","example":"My Source"},"description":{"type":"string","description":"Human-readable description of the source","example":"This is the corporate directory."},"owner":{"description":"Reference to an owning Identity Object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity","example":"MyName"}}},"cluster":{"description":"Reference to the associated Cluster","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"type":"string","description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"accountCorrelationConfig":{"description":"Reference to an Account Correlation Config object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG"],"example":"ACCOUNT_CORRELATION_CONFIG"},"id":{"type":"string","description":"ID of the account correlation config","example":"2c9180855d191c59015d28583727245a"},"name":{"type":"string","description":"Human-readable display name of the account correlation config","example":"Directory [source-62867] Account Correlation"}}},"accountCorrelationRule":{"description":"Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"managerCorrelationMapping":{"description":"Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity","type":"object","properties":{"accountAttribute":{"type":"string","description":"Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.","example":"manager"},"identityAttribute":{"type":"string","description":"Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.","example":"manager"}}},"managerCorrelationRule":{"description":"Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"beforeProvisioningRule":{"description":"Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"schemas":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"ID of the schema","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the schema","example":"MySchema"}}},"description":"List of references to Schema objects","example":[{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232a","name":"account"},{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232b","name":"group"}]},"passwordPolicies":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["PASSWORD_POLICY"],"example":"PASSWORD_POLICY"},"id":{"type":"string","description":"ID of the policy","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the policy","example":"My Password Policy"}}},"description":"List of references to the associated PasswordPolicy objects.","example":[{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb053980","name":"Corporate Password Policy"},{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb057777","name":"Vendor Password Policy"}]},"features":{"type":"array","description":"Optional features that can be supported by a source.","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING."},"example":["SYNC_PROVISIONING","MANAGER_LOOKUP","SEARCH","PROVISIONING","AUTHENTICATE","GROUP_PROVISIONING","PASSWORD"]},"type":{"type":"string","description":"Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ","example":"OpenLDAP - Direct"},"connector":{"type":"string","description":"Connector script name.","example":"active-directory"},"connectorClass":{"type":"string","description":"The fully qualified name of the Java class that implements the connector interface.","example":"sailpoint.connector.LDAPConnector"},"connectorAttributes":{"type":"object","description":"Connector specific configuration; will differ from type to type.","example":{"healthCheckTimeout":30,"authSearchAttributes":["cn","uid","mail"]}},"deleteThreshold":{"type":"integer","format":"int32","description":"Number from 0 to 100 that specifies when to skip the delete phase.","example":10},"authoritative":{"type":"boolean","description":"When true indicates the source is referenced by an IdentityProfile.","example":false},"managementWorkgroup":{"description":"Reference to Management Workgroup for this Source","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["GOVERNANCE_GROUP"],"example":"GOVERNANCE_GROUP"},"id":{"type":"string","description":"ID of the management workgroup","example":"2c91808568c529c60168cca6f90c2222"},"name":{"type":"string","description":"Human-readable display name of the management workgroup","example":"My Management Workgroup"}}},"healthy":{"type":"boolean","description":"When true indicates a healthy source","example":true},"status":{"type":"string","description":"A status identifier, giving specific information on why a source is healthy or not","example":"SOURCE_STATE_HEALTHY"},"since":{"type":"string","description":"Timestamp showing when a source health check was last performed","example":"2021-09-28T15:48:29.3801666300Z"},"connectorId":{"type":"string","description":"The id of connector","example":"active-directory"},"connectorName":{"type":"string","description":"The name of the connector that was chosen on source creation","example":"Active Directory"},"connectionType":{"type":"string","description":"The type of connection (direct or file)","example":"file"},"connectorImplementstionId":{"type":"string","description":"The connector implementstion id","example":"delimited-file"}},"required":["name","owner","connector"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/sources/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"My Source","description":"This is the corporate directory.","owner":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"MyName"},"cluster":{"type":"CLUSTER","id":"2c9180866166b5b0016167c32ef31a66","name":"Corporate Cluster"},"accountCorrelationConfig":{"type":"ACCOUNT_CORRELATION_CONFIG","id":"2c9180855d191c59015d28583727245a","name":"Directory [source-62867] Account Correlation"},"accountCorrelationRule":{"type":"RULE","id":"2c918085708c274401708c2a8a760001","name":"Example Rule"},"managerCorrelationMapping":{"accountAttribute":"manager","identityAttribute":"manager"},"managerCorrelationRule":{"type":"RULE","id":"2c918085708c274401708c2a8a760001","name":"Example Rule"},"beforeProvisioningRule":{"type":"RULE","id":"2c918085708c274401708c2a8a760001","name":"Example Rule"},"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":["SYNC_PROVISIONING","MANAGER_LOOKUP","SEARCH","PROVISIONING","AUTHENTICATE","GROUP_PROVISIONING","PASSWORD"],"type":"OpenLDAP - Direct","connector":"active-directory","connectorClass":"sailpoint.connector.LDAPConnector","connectorAttributes":{"healthCheckTimeout":30,"authSearchAttributes":["cn","uid","mail"]},"deleteThreshold":10,"authoritative":false,"managementWorkgroup":{"type":"GOVERNANCE_GROUP","id":"2c91808568c529c60168cca6f90c2222","name":"My Management Workgroup"},"healthy":true,"status":"SOURCE_STATE_HEALTHY","since":"2021-09-28T15:48:29.3801666300Z","connectorId":"active-directory","connectorName":"Active Directory","connectionType":"file","connectorImplementstionId":"delimited-file"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update Source (Full)","description":{"content":"This API updates a source in IdentityNow, using a full object representation. In other words, the existing Source\nconfiguration is completely replaced.\n\nSome fields are immutable and cannot be changed, such as:\n\n* id\n* type\n* authoritative\n* connector\n* connectorClass\n* passwordPolicies\n\nAttempts to modify these fields will result in a 400 error.\n\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.\n","type":"text/plain"},"url":{"path":["sources",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Source (Full)' (put-source)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Source (Full) + + + +This API updates a source in IdentityNow, using a full object representation. In other words, the existing Source +configuration is completely replaced. + +Some fields are immutable and cannot be changed, such as: + +* id +* type +* authoritative +* connector +* connectorClass +* passwordPolicies + +Attempts to modify these fields will result in a 400 error. + +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + + +
Path Parameters
Request Body required
    owner object required
    + +Reference to an owning Identity Object + +
    cluster object
    + +Reference to the associated Cluster + +
    accountCorrelationConfig object
    + +Reference to an Account Correlation Config object + +
    accountCorrelationRule object
    + +Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used. + +
    managerCorrelationMapping object
    + +Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + +
    managerCorrelationRule object
    + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
    beforeProvisioningRule object
    + +Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + +
    schemas object[]
    + +List of references to Schema objects + +
    passwordPolicies object[]
    + +List of references to the associated PasswordPolicy objects. + +
    managementWorkgroup object
    + +Reference to Management Workgroup for this Source + +
+ +Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design. + +
Schema
    owner object
    + +Reference to an owning Identity Object + +
    cluster object
    + +Reference to the associated Cluster + +
    accountCorrelationConfig object
    + +Reference to an Account Correlation Config object + +
    accountCorrelationRule object
    + +Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used. + +
    managerCorrelationMapping object
    + +Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + +
    managerCorrelationRule object
    + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
    beforeProvisioningRule object
    + +Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + +
    schemas object[]
    + +List of references to Schema objects + +
    passwordPolicies object[]
    + +List of references to the associated PasswordPolicy objects. + +
    managementWorkgroup object
    + +Reference to Management Workgroup for this Source + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/put-tenant-configuration.api.mdx b/products/idn/api/beta/put-tenant-configuration.api.mdx new file mode 100644 index 000000000..3c46063be --- /dev/null +++ b/products/idn/api/beta/put-tenant-configuration.api.mdx @@ -0,0 +1,95 @@ +--- +id: put-tenant-configuration +sidebar_label: Update Tenant-wide Reassignment Configuration settings +hide_title: true +hide_table_of_contents: true +api: {"operationId":"putTenantConfiguration","tags":["Work Reassignment"],"description":"Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings.","security":[{"oauth2":["idn:reassignment-tenant-configuration:update"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Tenant-wide Reassignment Configuration settings","properties":{"configDetails":{"type":"object","description":"Details of any tenant-wide Reassignment Configurations (eg. enabled/disabled)","properties":{"disabled":{"type":"boolean","nullable":true,"description":"Flag to determine if Reassignment Configuration is enabled or disabled for a tenant. When this flag is set to true, Reassignment Configuration is disabled.","default":false,"example":true}}}}}}}},"responses":{"200":{"description":"Tenant-wide Reassignment Configuration settings","content":{"application/json":{"schema":{"type":"object","description":"Tenant-wide Reassignment Configuration settings","properties":{"auditDetails":{"type":"object","description":"Audit details for the reassignment configuration of an identity","properties":{"created":{"type":"string","description":"Initial date and time when the record was created","format":"date-time","example":"2022-07-21T11:13:12.345Z"},"createdBy":{"type":"object","description":"The definition of an Identity according to the Reassignment Configuration service","properties":{"id":{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"},"name":{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}},"modified":{"type":"string","description":"Last modified date and time for the record","format":"date-time","example":"2022-07-21T11:13:12.345Z"},"modifiedBy":{"type":"object","description":"The definition of an Identity according to the Reassignment Configuration service","properties":{"id":{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"},"name":{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}}}},"configDetails":{"type":"object","description":"Details of any tenant-wide Reassignment Configurations (eg. enabled/disabled)","properties":{"disabled":{"type":"boolean","nullable":true,"description":"Flag to determine if Reassignment Configuration is enabled or disabled for a tenant. When this flag is set to true, Reassignment Configuration is disabled.","default":false,"example":true}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/reassignment-configurations/tenant-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"configDetails":{"disabled":true}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update Tenant-wide Reassignment Configuration settings","description":{"content":"Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings.","type":"text/plain"},"url":{"path":["reassignment-configurations","tenant-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Tenant-wide Reassignment Configuration settings' (put-tenant-configuration)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Tenant-wide Reassignment Configuration settings + + + +Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. + +
Request Body required
    configDetails object
    + +Details of any tenant-wide Reassignment Configurations (eg. enabled/disabled) + +
+ +Tenant-wide Reassignment Configuration settings + +
Schema
    auditDetails object
    + +Audit details for the reassignment configuration of an identity + +
    createdBy object
    + +The definition of an Identity according to the Reassignment Configuration service + +
    modifiedBy object
    + +The definition of an Identity according to the Reassignment Configuration service + +
    configDetails object
    + +Details of any tenant-wide Reassignment Configurations (eg. enabled/disabled) + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/query-password-info.api.mdx b/products/idn/api/beta/query-password-info.api.mdx new file mode 100644 index 000000000..34ef26418 --- /dev/null +++ b/products/idn/api/beta/query-password-info.api.mdx @@ -0,0 +1,87 @@ +--- +id: query-password-info +sidebar_label: Query Password Info +hide_title: true +hide_table_of_contents: true +api: {"operationId":"queryPasswordInfo","tags":["Password Management"],"description":"This API is used to query password related information. \n\nA token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) \nis required to call this API. \"API authority\" refers to a token that only has the \"client_credentials\" \ngrant type, and therefore no user context. A [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) \nor a token generated with the [authorization_code](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) \ngrant type will **NOT** work on this endpoint, and a `403 Forbidden` response \nwill be returned.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userName":{"type":"string","description":"The login name of the user","example":"Abby.Smith"},"sourceName":{"type":"string","description":"The display name of the source","example":"My-AD"}}},"example":{"userName":"Abby.Smith","sourceName":"My-AD"}}}},"responses":{"200":{"description":"Reference to the password info.","content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","example":"2c918085744fec4301746f9a5bce4605"},"sourceId":{"type":"string","example":"2c918083746f642c01746f990884012a"},"publicKeyId":{"type":"string","example":"N2M1OTJiMGEtMDJlZS00ZWU3LTkyYTEtNjA5YmI5NWE3ZWVh"},"publicKey":{"type":"string","description":"User's public key with Base64 encoding","example":"MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuGFkWi2J75TztpbaPKd36bJnIB3J8gZ6UcoS9oSDYsqBzPpTsfZXYaEf4Y4BKGgJIXmE/lwhwuj7mU1itdZ2qTSNFtnXA8Fn75c3UUkk+h+wdZbkuSmqlsJo3R1OnJkwkJggcAy9Jvk9jlcrNLWorpQ1w9raUvxtvfgkSdq153KxotenQ1HciSyZ0nA/Kw0UaucLnho8xdRowZs11afXGXA9IT9H6D8T6zUdtSxm0nAyH+mluma5LdTfaM50W3l/L8q56Vrqmx2pZIiwdx/0+g3Y++jV70zom0ZBkC1MmSoLMrQYG5OICNjr72f78B2PaGXfarQHqARLjKpMVt9YIQIDAQAB"},"accounts":{"type":"array","description":"Account info related to queried identity and source","items":{"type":"object","properties":{"accountId":{"type":"string","description":"Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350","example":"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com"},"accountName":{"type":"string","description":"Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008","example":"Abby.Smith"}}}},"policies":{"type":"array","description":"Password constraints","items":{"type":"string"},"example":["passwordRepeatedChar is 3","passwordMinAlpha is 1","passwordMinLength is 5","passwordMinNumeric is 1"]}}},"example":{"identityId":"2c918085744fec4301746f9a5bce4611","sourceId":"2c918083746f642c01746f9908840111","publicKeyId":"N2M1OTJiMGEtMDJlZS00ZWU3LTkyYTEtNjA5YmI5NWE3ZWVA","publicKey":"AIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuGFkWi2J75TztpbaPKd36bJnIB3J8gZ6UcoS9oSDYsqBzPpTsfZXYaEf4Y4BKGgJIXmE/lwhwuj7mU1itdZ2qTSNFtnXA8Fn75c3UUkk+h+wdZbkuSmqlsJo3R1OnJkwkJggcAy9Jvk9jlcrNLWorpQ1w9raUvxtvfgkSdq153KxotenQ1HciSyZ0nA/Kw0UaucLnho8xdRowZs11afXGXA9IT9H6D8T6zUdtSxm0nAyH+mluma5LdTfaM50W3l/L8q56Vrqmx2pZIiwdx/0+g3Y++jV70zom0ZBkC1MmSoLMrQYG5OICNjr72f78B2PaGXfarQHqARLjKpMVt9YIQIDAQAB","accounts":[{"accountId":"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com","accountName":"Abby.Smith"}],"policies":["passwordRepeatedChar is 3","passwordMinAlpha is 1","passwordMinLength is 5","passwordMinNumeric is 1"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/query-password-info","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"userName":"Abby.Smith","sourceName":"My-AD"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Query Password Info","description":{"content":"This API is used to query password related information. \n\nA token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) \nis required to call this API. \"API authority\" refers to a token that only has the \"client_credentials\" \ngrant type, and therefore no user context. A [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) \nor a token generated with the [authorization_code](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) \ngrant type will **NOT** work on this endpoint, and a `403 Forbidden` response \nwill be returned.\n","type":"text/plain"},"url":{"path":["query-password-info"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Query Password Info' (query-password-info)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Query Password Info + + + +This API is used to query password related information. + +A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) +is required to call this API. "API authority" refers to a token that only has the "client_credentials" +grant type, and therefore no user context. A [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) +or a token generated with the [authorization_code](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) +grant type will **NOT** work on this endpoint, and a `403 Forbidden` response +will be returned. + + +
Request Body required
+ +Reference to the password info. + +
Schema
    accounts object[]
    + +Account info related to queried identity and source + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/reassign-identity-certs-async.api.mdx b/products/idn/api/beta/reassign-identity-certs-async.api.mdx new file mode 100644 index 000000000..ffe5ded42 --- /dev/null +++ b/products/idn/api/beta/reassign-identity-certs-async.api.mdx @@ -0,0 +1,87 @@ +--- +id: reassign-identity-certs-async +sidebar_label: Reassign Certifications Asynchronously +hide_title: true +hide_table_of_contents: true +api: {"operationId":"reassignIdentityCertsAsync","tags":["Certifications"],"description":"This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity campaign certification ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reassign":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of item or identity being reassigned.","example":"ef38f94347e94562b5bb8424a56397d8"},"type":{"type":"string","description":"The type of item or identity being reassigned.","enum":["TARGET_SUMMARY","ITEM","IDENTITY_SUMMARY"],"example":"ITEM"}},"required":["id","type"]}},"reassignTo":{"type":"string","description":"The ID of the identity to which the certification is reassigned","example":"ef38f94347e94562b5bb8424a56397d8"},"reason":{"type":"string","description":"The reason comment for why the reassign was made","example":"reassigned for some reason"}},"required":["reassign","reassignTo","reason"]}}}},"responses":{"200":{"description":"A certification task object for the reassignment which can be queried for status.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The task id","example":"abcd-ef12-3456"},"certificationId":{"type":"string","description":"The certification id","example":"ef38f94347e94562b5bb8424a56397d8"},"type":{"type":"string","enum":["REASSIGN"]},"status":{"type":"string","enum":["QUEUED","IN_PROGRESS","SUCCESS","ERROR"]},"errors":{"type":"array","items":{"type":"string"},"description":"Any errors executing the task (Optional).","example":[]}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/certifications/{id}/reassign-async","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"reassign":[{"id":"ef38f94347e94562b5bb8424a56397d8","type":"ITEM"}],"reassignTo":"ef38f94347e94562b5bb8424a56397d8","reason":"reassigned for some reason"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Reassign Certifications Asynchronously","description":{"content":"This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.","type":"text/plain"},"url":{"path":["certifications",":id","reassign-async"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identity campaign certification ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Reassign Certifications Asynchronously' (reassign-identity-certs-async)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Reassign Certifications Asynchronously + + + +This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +
Path Parameters
Request Body required
    reassign object[] required
+ +A certification task object for the reassignment which can be queried for status. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/refresh-identity-profile.api.mdx b/products/idn/api/beta/refresh-identity-profile.api.mdx new file mode 100644 index 000000000..4ad56cf19 --- /dev/null +++ b/products/idn/api/beta/refresh-identity-profile.api.mdx @@ -0,0 +1,88 @@ +--- +id: refresh-identity-profile +sidebar_label: Refreshes all identities under profile +hide_title: true +hide_table_of_contents: true +api: {"operationId":"refreshIdentityProfile","tags":["Identity Profiles"],"description":"This refreshes all identities under the profile\nA token with ORG_ADMIN authority is required to call this API to refresh identities under this Identity Profile.","parameters":[{"in":"path","name":"identity-profile-id","schema":{"type":"string","format":"uuid"},"required":true,"description":"The Identity Profile ID to be refreshed","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:identity-profile:manage"]}],"method":"post","path":"/identity-profiles/{identity-profile-id}/refresh-identities","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Refreshes all identities under profile","description":{"content":"This refreshes all identities under the profile\nA token with ORG_ADMIN authority is required to call this API to refresh identities under this Identity Profile.","type":"text/plain"},"url":{"path":["identity-profiles",":identity-profile-id","refresh-identities"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Identity Profile ID to be refreshed","type":"text/plain"},"type":"any","value":"","key":"identity-profile-id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Refreshes all identities under profile' (refresh-identity-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Refreshes all identities under profile + + + +This refreshes all identities under the profile +A token with ORG_ADMIN authority is required to call this API to refresh identities under this Identity Profile. + +
Path Parameters
+ +Accepted - Returned if the request was successfully accepted into the system. + +
Schema
  • object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/reject-access-request.api.mdx b/products/idn/api/beta/reject-access-request.api.mdx new file mode 100644 index 000000000..6f9be067d --- /dev/null +++ b/products/idn/api/beta/reject-access-request.api.mdx @@ -0,0 +1,91 @@ +--- +id: reject-access-request +sidebar_label: Rejects an access request approval. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"rejectAccessRequest","tags":["Access Request Approvals"],"description":"This endpoint rejects an access request approval. Only the owner of the approval and admin users are allowed to perform this action.","parameters":[{"in":"path","name":"approvalId","schema":{"type":"string"},"required":true,"description":"The id of the approval.","example":"2c91808b7294bea301729568c68c002e"}],"requestBody":{"description":"Reviewer's comment.","required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"comment":{"type":"string"}}}}}},"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/access-request-approvals/{approvalId}/reject","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"comment":"string"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Rejects an access request approval.","description":{"content":"This endpoint rejects an access request approval. Only the owner of the approval and admin users are allowed to perform this action.","type":"text/plain"},"url":{"path":["access-request-approvals",":approvalId","reject"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The id of the approval.","type":"text/plain"},"type":"any","value":"","key":"approvalId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Rejects an access request approval.' (reject-access-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Rejects an access request approval. + + + +This endpoint rejects an access request approval. Only the owner of the approval and admin users are allowed to perform this action. + +
Path Parameters
Request Body
+ +Reviewer's comment. + +
+ +Accepted - Returned if the request was successfully accepted into the system. + +
Schema
  • object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/reject-approval-item.api.mdx b/products/idn/api/beta/reject-approval-item.api.mdx new file mode 100644 index 000000000..39ca84e0b --- /dev/null +++ b/products/idn/api/beta/reject-approval-item.api.mdx @@ -0,0 +1,67 @@ +--- +id: reject-approval-item +sidebar_label: Reject an Approval Item +hide_title: true +hide_table_of_contents: true +api: {"operationId":"rejectApprovalItem","tags":["Work Items"],"description":"This API rejects an Approval Item. Either an admin, or the owning/current user must make this request.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the work item","example":"ef38f94347e94562b5bb8424a56397d8"},{"in":"path","name":"approvalItemId","schema":{"type":"string"},"required":true,"description":"The ID of the approval item.","example":"1211bcaa32112bcef6122adb21cef1ac"}],"responses":{"200":{"description":"A work items details object.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the work item","example":"2c9180835d2e5168015d32f890ca1581"},"requesterId":{"type":"string","description":"ID of the requester","example":"2c9180835d2e5168015d32f890ca1581"},"requesterDisplayName":{"type":"string","description":"The displayname of the requester","example":"John Smith"},"ownerId":{"type":"string","description":"The ID of the owner","example":"2c9180835d2e5168015d32f890ca1581"},"ownerName":{"type":"string","description":"The name of the owner","example":"Jason Smith"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z"},"description":{"type":"string","description":"The description of the work item","example":"Create account on source 'AD'"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"},"type":{"type":"string","enum":["UNKNOWN","GENERIC","CERTIFICATION","REMEDIATION","DELEGATION","APPROVAL","VIOLATIONREVIEW","FORM","POLICYVIOLATION","CHALLENGE","IMPACTANALYSIS","SIGNOFF","EVENT","MANUALACTION","TEST"],"example":"GENERIC","description":"The type of the work item"},"remediationItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the certification","example":"2c9180835d2e5168015d32f890ca1581"},"targetId":{"type":"string","description":"The ID of the certification target","example":"2c9180835d2e5168015d32f890ca1581"},"targetName":{"type":"string","description":"The name of the certification target","example":"john.smith"},"targetDisplayName":{"type":"string","description":"The display name of the certification target","example":"emailAddress"},"applicationName":{"type":"string","description":"The name of the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute being certified","example":"phoneNumber"},"attributeOperation":{"type":"string","description":"The operation of the certification on the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute being certified","example":"512-555-1212"},"nativeIdentity":{"type":"string","description":"The native identity of the target","example":"jason.smith2"}}},"approvalItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the approval item","example":"2c9180835d2e5168015d32f890ca1581"},"account":{"type":"string","description":"The account referenced by the approval item","example":"john.smith"},"application":{"type":"string","description":"The name the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute","example":"emailAddress"},"attributeOperation":{"type":"string","description":"The operation of the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute","example":"a@b.com"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"}}},"name":{"type":"string","description":"The work item name","example":"Account Create"},"completed":{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z"},"numItems":{"type":"integer","description":"The number of items in the work item","example":19},"errors":{"type":"array","items":{"type":"string"},"example":["The work item ID that was specified was not found."]}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}}},"method":"post","path":"/work-items/{id}/reject/{approvalItemId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Reject an Approval Item","description":{"content":"This API rejects an Approval Item. Either an admin, or the owning/current user must make this request.","type":"text/plain"},"url":{"path":["work-items",":id","reject",":approvalItemId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the work item","type":"text/plain"},"type":"any","value":"","key":"id"},{"disabled":false,"description":{"content":"(Required) The ID of the approval item.","type":"text/plain"},"type":"any","value":"","key":"approvalItemId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Reject an Approval Item' (reject-approval-item)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Reject an Approval Item + + + +This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. + +
Path Parameters
+ +A work items details object. + +
Schema
    remediationItems object
    approvalItems object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

\ No newline at end of file diff --git a/products/idn/api/beta/reject-approval-items-in-bulk.api.mdx b/products/idn/api/beta/reject-approval-items-in-bulk.api.mdx new file mode 100644 index 000000000..2238092fc --- /dev/null +++ b/products/idn/api/beta/reject-approval-items-in-bulk.api.mdx @@ -0,0 +1,67 @@ +--- +id: reject-approval-items-in-bulk +sidebar_label: Bulk reject Approval Items +hide_title: true +hide_table_of_contents: true +api: {"operationId":"rejectApprovalItemsInBulk","tags":["Work Items"],"description":"This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the work item","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"A work items details object.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the work item","example":"2c9180835d2e5168015d32f890ca1581"},"requesterId":{"type":"string","description":"ID of the requester","example":"2c9180835d2e5168015d32f890ca1581"},"requesterDisplayName":{"type":"string","description":"The displayname of the requester","example":"John Smith"},"ownerId":{"type":"string","description":"The ID of the owner","example":"2c9180835d2e5168015d32f890ca1581"},"ownerName":{"type":"string","description":"The name of the owner","example":"Jason Smith"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z"},"description":{"type":"string","description":"The description of the work item","example":"Create account on source 'AD'"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"},"type":{"type":"string","enum":["UNKNOWN","GENERIC","CERTIFICATION","REMEDIATION","DELEGATION","APPROVAL","VIOLATIONREVIEW","FORM","POLICYVIOLATION","CHALLENGE","IMPACTANALYSIS","SIGNOFF","EVENT","MANUALACTION","TEST"],"example":"GENERIC","description":"The type of the work item"},"remediationItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the certification","example":"2c9180835d2e5168015d32f890ca1581"},"targetId":{"type":"string","description":"The ID of the certification target","example":"2c9180835d2e5168015d32f890ca1581"},"targetName":{"type":"string","description":"The name of the certification target","example":"john.smith"},"targetDisplayName":{"type":"string","description":"The display name of the certification target","example":"emailAddress"},"applicationName":{"type":"string","description":"The name of the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute being certified","example":"phoneNumber"},"attributeOperation":{"type":"string","description":"The operation of the certification on the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute being certified","example":"512-555-1212"},"nativeIdentity":{"type":"string","description":"The native identity of the target","example":"jason.smith2"}}},"approvalItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the approval item","example":"2c9180835d2e5168015d32f890ca1581"},"account":{"type":"string","description":"The account referenced by the approval item","example":"john.smith"},"application":{"type":"string","description":"The name the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute","example":"emailAddress"},"attributeOperation":{"type":"string","description":"The operation of the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute","example":"a@b.com"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"}}},"name":{"type":"string","description":"The work item name","example":"Account Create"},"completed":{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z"},"numItems":{"type":"integer","description":"The number of items in the work item","example":19},"errors":{"type":"array","items":{"type":"string"},"example":["The work item ID that was specified was not found."]}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}}},"method":"post","path":"/work-items/bulk-reject/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Bulk reject Approval Items","description":{"content":"This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request.","type":"text/plain"},"url":{"path":["work-items","bulk-reject",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the work item","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Bulk reject Approval Items' (reject-approval-items-in-bulk)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Bulk reject Approval Items + + + +This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. + +
Path Parameters
+ +A work items details object. + +
Schema
    remediationItems object
    approvalItems object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

\ No newline at end of file diff --git a/products/idn/api/beta/reject-non-employee-request.api.mdx b/products/idn/api/beta/reject-non-employee-request.api.mdx new file mode 100644 index 000000000..e8ab55e7b --- /dev/null +++ b/products/idn/api/beta/reject-non-employee-request.api.mdx @@ -0,0 +1,79 @@ +--- +id: reject-non-employee-request +sidebar_label: Reject a Non-Employee Request +hide_title: true +hide_table_of_contents: true +api: {"operationId":"rejectNonEmployeeRequest","security":[{"oauth2":["idn:nelm:manage"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This endpoint will reject an approval item request and notify user.","parameters":[{"in":"path","name":"id","description":"Non-Employee approval item id (UUID)","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"comment":{"type":"string","description":"Comment on the approval item.","maxLength":4000}},"required":["comment"]}}}},"responses":{"200":{"description":"Non-Employee approval item object.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee approval item id","example":"2c1e388b-1e55-4b0a-ab5c-897f1204159c"},"approver":{"description":"Reference to the associated Identity","type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}},"accountName":{"type":"string","description":"Requested identity account name","example":"test.account"},"approvalStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status"},"approvalOrder":{"type":"number","description":"Approval order","example":1},"comment":{"type":"string","description":"comment of approver"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}},{"type":"object","properties":{"nonEmployeeRequest":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee request id."},"requester":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}},"example":{"type":"IDENTITY","id":"2c9180866166b5b0016167c32ef31a66","name":"William Smith"}}}}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/non-employee-approvals/{id}/reject","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"comment":"string"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Reject a Non-Employee Request","description":{"content":"This endpoint will reject an approval item request and notify user.","type":"text/plain"},"url":{"path":["non-employee-approvals",":id","reject"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Non-Employee approval item id (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Reject a Non-Employee Request' (reject-non-employee-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Reject a Non-Employee Request + + + +This endpoint will reject an approval item request and notify user. + +
Path Parameters
Request Body required
+ +Non-Employee approval item object. + +
Schema
    approver object
    + +Reference to the associated Identity + +
    nonEmployeeRequest object
    requester object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/reload-account.api.mdx b/products/idn/api/beta/reload-account.api.mdx new file mode 100644 index 000000000..54042f9f7 --- /dev/null +++ b/products/idn/api/beta/reload-account.api.mdx @@ -0,0 +1,88 @@ +--- +id: reload-account +sidebar_label: Reload Account +hide_title: true +hide_table_of_contents: true +api: {"operationId":"reloadAccount","tags":["Accounts"],"description":"This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. \nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:accounts-state:manage"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The account id","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"202":{"description":"Async task details","content":{"application/json":{"schema":{"description":"Accounts async response containing details on started async process","required":["id"],"type":"object","properties":{"id":{"description":"id of the task","type":"string","example":"2c91808474683da6017468693c260195"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/accounts/{id}/reload","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Reload Account","description":{"content":"This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. \nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts",":id","reload"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The account id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Reload Account' (reload-account)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Reload Account + + + +This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. +A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
+ +Async task details + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/remove-tags-to-many-object.api.mdx b/products/idn/api/beta/remove-tags-to-many-object.api.mdx new file mode 100644 index 000000000..a3abd8cda --- /dev/null +++ b/products/idn/api/beta/remove-tags-to-many-object.api.mdx @@ -0,0 +1,81 @@ +--- +id: remove-tags-to-many-object +sidebar_label: Remove Tags from Multiple Objects +hide_title: true +hide_table_of_contents: true +api: {"operationId":"removeTagsToManyObject","tags":["Tagged Objects"],"description":"This API removes tags from multiple objects.\n\nA token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","requestBody":{"description":"Supported object types are ROLE, IDENTITY and SOD_POLICY.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"objectRefs":{"type":"array","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}},"tags":{"type":"array","items":{"type":"string"},"description":"Label to be applied to an Object","example":["BU_FINANCE","PCI"]},"operation":{"type":"string","enum":["APPEND","MERGE"],"default":"APPEND","description":"If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object.\n\nIf MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored.","example":"MERGE"}}}}}},"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/tagged-objects/bulk-remove","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"objectRefs":[{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"}],"tags":["BU_FINANCE","PCI"],"operation":"MERGE"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Remove Tags from Multiple Objects","description":{"content":"This API removes tags from multiple objects.\n\nA token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["tagged-objects","bulk-remove"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Remove Tags from Multiple Objects' (remove-tags-to-many-object)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Remove Tags from Multiple Objects + + + +This API removes tags from multiple objects. + +A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +
Request Body required
+ +Supported object types are ROLE, IDENTITY and SOD_POLICY. + +
    objectRefs object[]
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/requestable-objects.tag.mdx b/products/idn/api/beta/requestable-objects.tag.mdx new file mode 100644 index 000000000..73415f57f --- /dev/null +++ b/products/idn/api/beta/requestable-objects.tag.mdx @@ -0,0 +1,23 @@ +--- +id: requestable-objects +title: "Requestable Objects" +description: "Requestable Objects" +custom_edit_url: null +--- + + + +Use this API to implement requestable object functionality. +With this functionality in place, administrators can determine which access items can be requested with the [Access Request APIs](https://developer.sailpoint.com/idn/api/beta/access-requests), along with their statuses. +This can be helpful for administrators who are implementing and customizing access request functionality as a way of checking which items are requestable as they are created, assigned, and made available. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/role-insights.tag.mdx b/products/idn/api/beta/role-insights.tag.mdx new file mode 100644 index 000000000..9391ab42b --- /dev/null +++ b/products/idn/api/beta/role-insights.tag.mdx @@ -0,0 +1,16 @@ +--- +id: role-insights +title: "Role Insights" +description: "Role Insights" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/roles.tag.mdx b/products/idn/api/beta/roles.tag.mdx new file mode 100644 index 000000000..34eaf38d6 --- /dev/null +++ b/products/idn/api/beta/roles.tag.mdx @@ -0,0 +1,57 @@ +--- +id: roles +title: "Roles" +description: "Roles" +custom_edit_url: null +--- + + + +Use this API to implement and customize role functionality. +With this functionality in place, administrators can create roles and configure them for use throughout IdentityNow. +IdentityNow can use established criteria to automatically assign the roles to qualified users. This enables users to get all the access they need quickly and securely and administrators to spend their time on other tasks. + +Entitlements represent the most granular level of access in IdentityNow. +Access profiles represent the next level and often group entitlements. +Roles represent the broadest level of access and often group access profiles. + +For example, an Active Directory source in IdentityNow can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +An administrator can then create an even broader set of access in the form of a role grouping the 'AD Developers' access profile with another profile, 'GitHub Developers,' grouping entitlements for the GitHub source. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +When users need both the 'AD Developers' access profile and the 'GitHub Developers' access profile, they can request access to the role grouping both. + +Roles often represent positions within organizations. +For example, an organization's accountant can access all the tools the organization's accountants need with the 'Accountant' role. +If the accountant switches to engineering, a qualified member of the organization can quickly revoke the accountant's 'Accountant' access and grant access to the 'Engineer' role instead, granting access to all the tools the organization's engineers need. + +In IdentityNow, adminstrators can use the Access drop-down menu and select Roles to view, configure, and delete existing roles, as well as create new ones. +Administrators can enable and disable the role, and they can also make the following configurations: + +- Manage Access: Manage the role's access by adding or removing access profiles. + +- Define Assignment: Define the criteria IdentityNow uses to assign the role to identities. +Use the first option, 'Standard Criteria,' to provide specific criteria for assignment like specific account attributes, entitlements, or identity attributes. +Use the second, 'Identity List,' to specify the identities for assignment. + +- Access Requests: Configure roles to be requestable and establish an approval process for any requests that the role be granted or revoked. +Do not configure a role to be requestable without establishing a secure access request approval process for that role first. + +Refer to [Working with Roles](https://documentation.sailpoint.com/saas/help/provisioning/roles.html) for more information about roles. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/run-campaign-remediation-scan.api.mdx b/products/idn/api/beta/run-campaign-remediation-scan.api.mdx new file mode 100644 index 000000000..cbdc71d7d --- /dev/null +++ b/products/idn/api/beta/run-campaign-remediation-scan.api.mdx @@ -0,0 +1,88 @@ +--- +id: run-campaign-remediation-scan +sidebar_label: Run Campaign Remediation Scan +hide_title: true +hide_table_of_contents: true +api: {"operationId":"runCampaignRemediationScan","tags":["Certification Campaigns"],"description":"Kicks off remediation scan task for a certification campaign.\nRequires roles of CERT_ADMIN and ORG_ADMIN","parameters":[{"in":"path","name":"id","schema":{"type":"string","example":"2c91808571bcfcf80171c23e4b4221fc"},"required":true,"description":"The ID of the campaign for which remediation scan is being run."}],"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/campaigns/{id}/run-remediation-scan","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Run Campaign Remediation Scan","description":{"content":"Kicks off remediation scan task for a certification campaign.\nRequires roles of CERT_ADMIN and ORG_ADMIN","type":"text/plain"},"url":{"path":["campaigns",":id","run-remediation-scan"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the campaign for which remediation scan is being run.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Run Campaign Remediation Scan' (run-campaign-remediation-scan)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Run Campaign Remediation Scan + + + +Kicks off remediation scan task for a certification campaign. +Requires roles of CERT_ADMIN and ORG_ADMIN + +
Path Parameters
+ +Accepted - Returned if the request was successfully accepted into the system. + +
Schema
  • object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/run-campaign-report.api.mdx b/products/idn/api/beta/run-campaign-report.api.mdx new file mode 100644 index 000000000..2b08abd11 --- /dev/null +++ b/products/idn/api/beta/run-campaign-report.api.mdx @@ -0,0 +1,88 @@ +--- +id: run-campaign-report +sidebar_label: Run Campaign Report +hide_title: true +hide_table_of_contents: true +api: {"operationId":"runCampaignReport","tags":["Certification Campaigns"],"description":"Runs a report for a certification campaign.\nRequires the following roles: CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN.","parameters":[{"in":"path","name":"id","schema":{"type":"string","example":"2c91808571bcfcf80171c23e4b4221fc"},"required":true,"description":"The ID of the campaign for which report is being run."},{"in":"path","name":"type","schema":{"type":"string","enum":["CAMPAIGN_COMPOSITION_REPORT","CAMPAIGN_REMEDIATION_STATUS_REPORT","CAMPAIGN_STATUS_REPORT","CERTIFICATION_SIGNOFF_REPORT"]},"required":true,"description":"The type of the report to run."}],"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/campaigns/{id}/run-report/{type}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Run Campaign Report","description":{"content":"Runs a report for a certification campaign.\nRequires the following roles: CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN.","type":"text/plain"},"url":{"path":["campaigns",":id","run-report",":type"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the campaign for which report is being run.","type":"text/plain"},"type":"any","value":"","key":"id"},{"disabled":false,"description":{"content":"(Required) The type of the report to run.","type":"text/plain"},"type":"any","value":"","key":"type"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Run Campaign Report' (run-campaign-report)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Run Campaign Report + + + +Runs a report for a certification campaign. +Requires the following roles: CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN. + +
Path Parameters
+ +Accepted - Returned if the request was successfully accepted into the system. + +
Schema
  • object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/run-sod-all-policies-for-org.api.mdx b/products/idn/api/beta/run-sod-all-policies-for-org.api.mdx new file mode 100644 index 000000000..e363eb497 --- /dev/null +++ b/products/idn/api/beta/run-sod-all-policies-for-org.api.mdx @@ -0,0 +1,76 @@ +--- +id: run-sod-all-policies-for-org +sidebar_label: Runs all policies for org +hide_title: true +hide_table_of_contents: true +api: {"operationId":"runSodAllPoliciesForOrg","tags":["SOD Policy"],"description":"Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided.\nRequires role of ORG_ADMIN.","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"filteredPolicyList":{"type":"array","description":"Multi-policy report will be run for this list of ids","items":{"type":"string"}}}},"example":{"filteredPolicyList":["b868cd40-ffa4-4337-9c07-1a51846cfa94","63a07a7b-39a4-48aa-956d-50c827deba2a"]}}}},"responses":{"200":{"description":"Reference to the violation report run task.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object","properties":{"status":{"type":"string","enum":["SUCCESS","WARNING","ERROR","TERMINATED","TEMP_ERROR","PENDING"]}}}]},"example":{"status":"PENDING","type":"REPORT_RESULT","id":"37b3b32a-f394-46f8-acad-b5223969fa68","name":"Multi Query Report"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sod-violation-report/run","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"filteredPolicyList":["string"]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Runs all policies for org","description":{"content":"Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided.\nRequires role of ORG_ADMIN.","type":"text/plain"},"url":{"path":["sod-violation-report","run"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Runs all policies for org' (run-sod-all-policies-for-org)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Runs all policies for org + + + +Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. +Requires role of ORG_ADMIN. + +
Request Body
+ +Reference to the violation report run task. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/run-sod-policy.api.mdx b/products/idn/api/beta/run-sod-policy.api.mdx new file mode 100644 index 000000000..de042bbd5 --- /dev/null +++ b/products/idn/api/beta/run-sod-policy.api.mdx @@ -0,0 +1,88 @@ +--- +id: run-sod-policy +sidebar_label: Runs SOD policy violation report +hide_title: true +hide_table_of_contents: true +api: {"operationId":"runSodPolicy","tags":["SOD Policy"],"description":"This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message.\nRequires role of ORG_ADMIN.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The SOD policy ID to run.","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"Reference to the violation report run task.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object","properties":{"status":{"type":"string","enum":["SUCCESS","WARNING","ERROR","TERMINATED","TEMP_ERROR","PENDING"]}}}]},"example":{"status":"PENDING","type":"REPORT_RESULT","id":"2e8d8180-24bc-4d21-91c6-7affdb473b0d","name":"policy-xyz"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sod-policies/{id}/violation-report/run","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Runs SOD policy violation report","description":{"content":"This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message.\nRequires role of ORG_ADMIN.","type":"text/plain"},"url":{"path":["sod-policies",":id","violation-report","run"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The SOD policy ID to run.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Runs SOD policy violation report' (run-sod-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Runs SOD policy violation report + + + +This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. +Requires role of ORG_ADMIN. + +
Path Parameters
+ +Reference to the violation report run task. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/search-attribute-configuration.tag.mdx b/products/idn/api/beta/search-attribute-configuration.tag.mdx new file mode 100644 index 000000000..3de8cde31 --- /dev/null +++ b/products/idn/api/beta/search-attribute-configuration.tag.mdx @@ -0,0 +1,16 @@ +--- +id: search-attribute-configuration +title: "Search Attribute Configuration" +description: "Search Attribute Configuration" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/search-form-definitions-by-tenant.api.mdx b/products/idn/api/beta/search-form-definitions-by-tenant.api.mdx new file mode 100644 index 000000000..36943ec56 --- /dev/null +++ b/products/idn/api/beta/search-form-definitions-by-tenant.api.mdx @@ -0,0 +1,87 @@ +--- +id: search-form-definitions-by-tenant +sidebar_label: Export form definitions by tenant. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Custom Forms"],"description":"No parameters required.","operationId":"searchFormDefinitionsByTenant","parameters":[{"name":"offset","in":"query","description":"Offset\n\nInteger specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nThe offset value is record-based, not page-based, and the index starts at 0.","schema":{"type":"integer","format":"int64","default":0,"x-go-name":"Offset"},"example":250,"required":false,"x-go-name":"Offset"},{"name":"limit","in":"query","description":"Limit\n\nInteger 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).\nIf it is not specified, a default limit is used.","schema":{"type":"integer","format":"int64","maxLength":250,"minLength":0,"default":250,"x-go-name":"Limit"},"example":250,"required":false,"x-go-name":"Limit"},{"name":"filters","in":"query","description":"Filters\n\nFilter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\nname: eq, gt, sw, in\ndescription: eq, gt, sw, in\ncreated: eq, gt, sw, in\nmodified: eq, gt, sw, in","schema":{"type":"string","x-go-name":"Filters"},"example":"name sw \"my form\"","required":false,"x-go-name":"Filters"},{"name":"sorters","in":"query","description":"Sorters\n\nItem will be sorted in the returned array if the sorters expression evaluates to true for that item. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/#sorting-results).\nSorting is supported for the following fields:\nname\ndescription\ncreated\nmodified","schema":{"type":"string","default":"name","x-go-name":"Sorters"},"example":"name","required":false,"x-go-name":"Sorters"}],"responses":{"200":{"description":"Returns a list of form definitions by tenant","content":{"application/json":{"schema":{"properties":{"count":{"description":"Count number of Results","example":1,"format":"int64","type":"integer","x-go-name":"Count"},"results":{"description":"Results holds a list of FormDefinitionResponse items","items":{"properties":{"created":{"description":"Created is the date the form definition was created","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Created"},"description":{"description":"Description is the form definition description","example":"My form description","type":"string","x-go-name":"Description"},"formConditions":{"description":"FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form","items":{"description":"FormCondition represent a form conditional","properties":{"effects":{"description":"Effects is a list of effects","items":{"description":"ConditionEffect is the effect produced by a condition","properties":{"config":{"additionalProperties":{},"description":"Config is a arbitrary map that holds a configuration based on EffectType","example":{},"type":"object","x-go-name":"Config"},"effectType":{"description":"EffectType is the type of effect to perform when the conditions are evaluated for this logic block\nHIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","enum":["HIDE","SHOW","DISABLE","ENABLE","REQUIRE","OPTIONAL","SUBMIT_MESSAGE","SUBMIT_NOTIFICATION","SET_DEFAULT_VALUE"],"example":"HIDE","type":"string","x-go-enum-desc":"HIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","x-go-name":"EffectType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Effects"},"ruleOperator":{"description":"RuleOperator is a ConditionRuleLogicalOperatorType value\nAND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","enum":["AND","OR"],"example":"AND","type":"string","x-go-enum-desc":"AND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","x-go-name":"RuleOperator"},"rules":{"description":"Rules is a list of rules","items":{"properties":{"operator":{"description":"Operator is a ConditionRuleComparisonOperatorType value\nEQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","enum":["EQ","NE","CO","NOT_CO","IN","NOT_IN","EM","NOT_EM","SW","NOT_SW","EW","NOT_EW"],"example":"EQ","type":"string","x-go-enum-desc":"EQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","x-go-name":"Operator"},"source":{"description":"Source, if the sourceType is ConditionRuleSourceTypeInput then the source type is the name of the form input to accept. While if the sourceType is ConditionRuleSourceTypeElement\nthen source is the name of a technical key of an element to retrieve its value","example":"department","type":"string","x-go-name":"Source"},"sourceType":{"description":"SourceType defines what type of object is being selected. Either a reference to a form input (by input name), or a form element (by technical key)\nINPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","enum":["INPUT","ELEMENT"],"example":"ELEMENT","type":"string","x-go-enum-desc":"INPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","x-go-name":"SourceType"},"value":{"description":"Value is the value based on the ValueType","example":"Engineering","x-go-name":"Value"},"valueType":{"description":"ValueType is a ConditionRuleValueType type\nSTRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","enum":["STRING","STRING_LIST","INPUT","ELEMENT","LIST","BOOLEAN"],"example":"STRING","type":"string","x-go-enum-desc":"STRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","x-go-name":"ValueType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Rules"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormConditions"},"formElements":{"description":"FormElements is a list of nested form elements","items":{"properties":{"config":{"additionalProperties":{},"description":"Config is a config object","example":{"label":"Department"},"type":"object","x-go-name":"Config"},"elementType":{"description":"ElementType is a FormElementType value\nTEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","enum":["TEXT","TOGGLE","TEXTAREA","HIDDEN","PHONE","EMAIL","SELECT","DATE","SECTION","COLUMNS"],"example":"TEXT","type":"string","x-go-enum-desc":"TEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","x-go-name":"ElementType"},"id":{"description":"ID is a form element identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"key":{"description":"Key is the technical key","example":"department","type":"string","x-go-name":"Key"},"validations":{"description":"FormElementValidationsSet is a set of FormElementValidation items","example":[{"validationType":"REQUIRED"}],"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormElements"},"formInput":{"description":"FormInput is a list of form inputs that are required when creating a form-instance object","items":{"properties":{"description":{"description":"Description is the description for this form input value","example":"A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic","type":"string","x-go-name":"Description"},"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"label":{"description":"Label is the name for this form input value","example":"input1","type":"string","x-go-name":"Label"},"type":{"description":"Type is a FormDefinitionInputType value\nSTRING FormDefinitionInputTypeString","enum":["STRING"],"example":"STRING","type":"string","x-go-enum-desc":"STRING FormDefinitionInputTypeString","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormInput"},"id":{"description":"FormDefinitionID is a unique guid identifying this form definition","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"FormDefinitionID"},"modified":{"description":"Modified is the last date the form definition was modified","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Modified"},"name":{"description":"Name is the form definition name","example":"My form","type":"string","x-go-name":"Name"},"owner":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a FormOwnerType value\nIDENTITY FormOwnerTypeIdentity","enum":["IDENTITY"],"example":"IDENTITY","type":"string","x-go-enum-desc":"IDENTITY FormOwnerTypeIdentity","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"usedBy":{"description":"UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used","items":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a FormUsedByType value\nWORKFLOW FormUsedByTypeWorkflow\nSOURCE FormUsedByTypeSource","enum":["WORKFLOW","SOURCE"],"example":"WORKFLOW","type":"string","x-go-enum-desc":"WORKFLOW FormUsedByTypeWorkflow\nSOURCE FormUsedByTypeSource","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"UsedBy"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Results"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}}}},"400":{"description":"An error with the request occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"401":{"description":"An error with the authorization occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"403":{"description":"An error with the user permissions occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"title":"Error is the standard API error response type.","type":"object","properties":{"detailCode":{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"trackingId":{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"}}}},"500":{"description":"An internal server error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}}},"security":[{"oauth2":["sp:forms:manage"]}],"method":"get","path":"/form-definitions","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Export form definitions by tenant.","description":{"content":"No parameters required.","type":"text/plain"},"url":{"path":["form-definitions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Offset\n\nInteger specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nThe offset value is record-based, not page-based, and the index starts at 0.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Limit\n\nInteger 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).\nIf it is not specified, a default limit is used.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Filters\n\nFilter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\nname: eq, gt, sw, in\ndescription: eq, gt, sw, in\ncreated: eq, gt, sw, in\nmodified: eq, gt, sw, in","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sorters\n\nItem will be sorted in the returned array if the sorters expression evaluates to true for that item. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/#sorting-results).\nSorting is supported for the following fields:\nname\ndescription\ncreated\nmodified","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Export form definitions by tenant.' (search-form-definitions-by-tenant)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Export form definitions by tenant. + + + +No parameters required. + +
Query Parameters
    name: eq, gt, sw, in\ndescription: eq, gt, sw, in\ncreated: eq, gt, sw, in\nmodified: eq, gt, sw, in","schema":{"type":"string","x-go-name":"Filters"},"example":"name sw \"my form\"","required":false,"x-go-name":"Filters"}}>name\ndescription\ncreated\nmodified","schema":{"type":"string","default":"name","x-go-name":"Sorters"},"example":"name","required":false,"x-go-name":"Sorters"}}>
+ +Returns a list of form definitions by tenant + +
Schema
    results object[]
    + +Results holds a list of FormDefinitionResponse items + +
    formConditions object[]
    + +FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form + +
    effects object[]
    + +Effects is a list of effects + +
    config object
    + +Config is a arbitrary map that holds a configuration based on EffectType + +
    rules object[]
    + +Rules is a list of rules + +
    formElements object[]
    + +FormElements is a list of nested form elements + +
    config object
    + +Config is a config object + +
    formInput object[]
    + +FormInput is a list of form inputs that are required when creating a form-instance object + +
    owner object
    usedBy object[]
    + +UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used + +
+ +An error with the request occurred + +
Schema
    messages object[]
+ +An error with the authorization occurred + +
Schema
    messages object[]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
+ +Too many requests + +
Schema
    messages object[]
+ +An internal server error occurred + +
Schema
    messages object[]
\ No newline at end of file diff --git a/products/idn/api/beta/search-form-element-data-by-element-id.api.mdx b/products/idn/api/beta/search-form-element-data-by-element-id.api.mdx new file mode 100644 index 000000000..9c23ec6fe --- /dev/null +++ b/products/idn/api/beta/search-form-element-data-by-element-id.api.mdx @@ -0,0 +1,60 @@ +--- +id: search-form-element-data-by-element-id +sidebar_label: Retrieves dynamic data by element. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Custom Forms"],"description":"Parameter `{formInstanceID}` should match a form instance ID.\nParameter `{formElementID}` should match a form element ID at the data source configuration.","operationId":"searchFormElementDataByElementID","parameters":[{"name":"formInstanceID","in":"path","description":"Form instance ID","required":true,"schema":{"type":"string","x-go-name":"FormInstanceID"},"example":"00000000-0000-0000-0000-000000000000","x-go-name":"FormInstanceID"},{"name":"formElementID","in":"path","description":"Form element ID","required":true,"schema":{"type":"string","x-go-name":"FormElementID"},"example":1,"x-go-name":"FormElementID"},{"name":"limit","in":"query","description":"Limit\n\nInteger 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).\nIf it is not specified, a default limit is used.","schema":{"type":"integer","format":"int64","maxLength":250,"minLength":0,"default":250,"x-go-name":"Limit"},"example":250,"required":false,"x-go-name":"Limit"},{"name":"filters","in":"query","description":"Filters\n\nFilter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\nvalue: eq, ne, in\nlabel: eq, ne, in\nsubLabel: eq, ne, in","schema":{"type":"string","x-go-name":"Filters"},"example":"label sw \"my label\"","required":false,"x-go-name":"Filters"}],"responses":{"200":{"description":"Retrieves dynamic data to aid in correctly completing a valid form by form element ID from data source configuration","content":{"application/json":{"schema":{"properties":{"results":{"description":"Results holds a list of FormElementDataSourceConfigOptions items","example":"{\"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\"}]}","items":{"type":"object","properties":{"label":{"description":"Label is the main label to display to the user when selecting this option","type":"string","example":"regression-test-access-request-07c55dd6-3056-430a-86b5-fccc395bb6c5","x-go-name":"Label"},"subLabel":{"description":"SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option","type":"string","example":"","x-go-name":"SubLabel"},"value":{"description":"Value is the value to save as an entry when the user selects this option","type":"string","example":"e96674448eba4ca1ba04eee999a8f3cd","x-go-name":"Value"}},"x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Results"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}}}},"400":{"description":"An error with the request occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"401":{"description":"An error with the authorization occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"403":{"description":"An error with the user permissions occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"404":{"description":"An error with the item not found","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"title":"Error is the standard API error response type.","type":"object","properties":{"detailCode":{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"trackingId":{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"}}}},"500":{"description":"An internal server error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}}},"security":[{"oauth2":[]}],"method":"get","path":"/form-instances/{formInstanceID}/data-source/{formElementID}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Retrieves dynamic data by element.","description":{"content":"Parameter `{formInstanceID}` should match a form instance ID.\nParameter `{formElementID}` should match a form element ID at the data source configuration.","type":"text/plain"},"url":{"path":["form-instances",":formInstanceID","data-source",":formElementID"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Limit\n\nInteger 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).\nIf it is not specified, a default limit is used.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Filters\n\nFilter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\nvalue: eq, ne, in\nlabel: eq, ne, in\nsubLabel: eq, ne, in","type":"text/plain"},"key":"filters","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Form instance ID","type":"text/plain"},"type":"any","value":"","key":"formInstanceID"},{"disabled":false,"description":{"content":"(Required) Form element ID","type":"text/plain"},"type":"any","value":"","key":"formElementID"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Retrieves dynamic data by element.' (search-form-element-data-by-element-id)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieves dynamic data by element. + + + +Parameter `{formInstanceID}` should match a form instance ID. +Parameter `{formElementID}` should match a form element ID at the data source configuration. + +
Path Parameters
Query Parameters
    value: eq, ne, in\nlabel: eq, ne, in\nsubLabel: eq, ne, in","schema":{"type":"string","x-go-name":"Filters"},"example":"label sw \"my label\"","required":false,"x-go-name":"Filters"}}>
+ +Retrieves dynamic data to aid in correctly completing a valid form by form element ID from data source configuration + +
Schema
    results object[]
    + +Results holds a list of FormElementDataSourceConfigOptions items + +
+ +An error with the request occurred + +
Schema
    messages object[]
+ +An error with the authorization occurred + +
Schema
    messages object[]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
+ +An error with the item not found + +
Schema
    messages object[]
+ +Too many requests + +
Schema
    messages object[]
+ +An internal server error occurred + +
Schema
    messages object[]
\ No newline at end of file diff --git a/products/idn/api/beta/search-form-instances-by-tenant.api.mdx b/products/idn/api/beta/search-form-instances-by-tenant.api.mdx new file mode 100644 index 000000000..8b08d69cc --- /dev/null +++ b/products/idn/api/beta/search-form-instances-by-tenant.api.mdx @@ -0,0 +1,99 @@ +--- +id: search-form-instances-by-tenant +sidebar_label: List form instances by tenant. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Custom Forms"],"description":"No parameters required.","operationId":"searchFormInstancesByTenant","responses":{"200":{"description":"Returns a list of form instances by tenant","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"description":"Count number of Results","type":"integer","format":"int64","example":1,"x-go-name":"Count"},"results":{"description":"Results holds a list of FormInstanceResponse items","type":"array","items":{"properties":{"created":{"description":"Created is the date the form instance was assigned","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Created"},"createdBy":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a form instance created by type enum value\nWORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution\nSOURCE FormInstanceCreatedByTypeSource","enum":["WORKFLOW_EXECUTION","SOURCE"],"example":"WORKFLOW_EXECUTION","type":"string","x-go-enum-desc":"WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution\nSOURCE FormInstanceCreatedByTypeSource","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"expire":{"description":"Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record","example":"2023-08-12T20:14:57.74486Z","type":"string","x-go-name":"Expire"},"formConditions":{"description":"FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form","items":{"description":"FormCondition represent a form conditional","properties":{"effects":{"description":"Effects is a list of effects","items":{"description":"ConditionEffect is the effect produced by a condition","properties":{"config":{"additionalProperties":{},"description":"Config is a arbitrary map that holds a configuration based on EffectType","example":{},"type":"object","x-go-name":"Config"},"effectType":{"description":"EffectType is the type of effect to perform when the conditions are evaluated for this logic block\nHIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","enum":["HIDE","SHOW","DISABLE","ENABLE","REQUIRE","OPTIONAL","SUBMIT_MESSAGE","SUBMIT_NOTIFICATION","SET_DEFAULT_VALUE"],"example":"HIDE","type":"string","x-go-enum-desc":"HIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations\nSHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations\nDISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations\nENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations\nREQUIRE ConditionEffectTypeRequire\nOPTIONAL ConditionEffectTypeOptional\nSUBMIT_MESSAGE ConditionEffectTypeSubmitMessage\nSUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification\nSET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose","x-go-name":"EffectType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Effects"},"ruleOperator":{"description":"RuleOperator is a ConditionRuleLogicalOperatorType value\nAND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","enum":["AND","OR"],"example":"AND","type":"string","x-go-enum-desc":"AND ConditionRuleLogicalOperatorTypeAnd\nOR ConditionRuleLogicalOperatorTypeOr","x-go-name":"RuleOperator"},"rules":{"description":"Rules is a list of rules","items":{"properties":{"operator":{"description":"Operator is a ConditionRuleComparisonOperatorType value\nEQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","enum":["EQ","NE","CO","NOT_CO","IN","NOT_IN","EM","NOT_EM","SW","NOT_SW","EW","NOT_EW"],"example":"EQ","type":"string","x-go-enum-desc":"EQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality\nNE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality\nCO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value\nNOT_CO ConditionRuleComparisonOperatorTypeNotContains\nIN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values\nNOT_IN ConditionRuleComparisonOperatorTypeNotIncludes\nEM ConditionRuleComparisonOperatorTypeEmpty\nNOT_EM ConditionRuleComparisonOperatorTypeNotEmpty\nSW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive\nNOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith\nEW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive\nNOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith","x-go-name":"Operator"},"source":{"description":"Source, if the sourceType is ConditionRuleSourceTypeInput then the source type is the name of the form input to accept. While if the sourceType is ConditionRuleSourceTypeElement\nthen source is the name of a technical key of an element to retrieve its value","example":"department","type":"string","x-go-name":"Source"},"sourceType":{"description":"SourceType defines what type of object is being selected. Either a reference to a form input (by input name), or a form element (by technical key)\nINPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","enum":["INPUT","ELEMENT"],"example":"ELEMENT","type":"string","x-go-enum-desc":"INPUT ConditionRuleSourceTypeInput\nELEMENT ConditionRuleSourceTypeElement","x-go-name":"SourceType"},"value":{"description":"Value is the value based on the ValueType","example":"Engineering","x-go-name":"Value"},"valueType":{"description":"ValueType is a ConditionRuleValueType type\nSTRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","enum":["STRING","STRING_LIST","INPUT","ELEMENT","LIST","BOOLEAN"],"example":"STRING","type":"string","x-go-enum-desc":"STRING ConditionRuleValueTypeString ConditionRuleValueTypeString the value field is a static string\nSTRING_LIST ConditionRuleValueTypeStringList ConditionRuleValueTypeStringList the value field is an array of string values\nINPUT ConditionRuleValueTypeInput ConditionRuleValueTypeInput the value field is a reference to a form input by\nELEMENT ConditionRuleValueTypeElement ConditionRuleValueTypeElement the value field is a reference to form element (by technical key)\nLIST ConditionRuleValueTypeList\nBOOLEAN ConditionRuleValueTypeBoolean","x-go-name":"ValueType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Rules"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormConditions"},"formData":{"additionalProperties":{},"description":"FormData is the data provided by the form on submit. The data is in a key -> value map","example":{"department":"Engineering"},"type":"object","x-go-name":"FormData"},"formDefinitionId":{"description":"FormDefinitionID is the id of the form definition that created this form","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"FormDefinitionID"},"formElements":{"description":"FormElements is the configuration of the form, this would be a repeat of the fields from the form-config","items":{"properties":{"config":{"additionalProperties":{},"description":"Config is a config object","example":{"label":"Department"},"type":"object","x-go-name":"Config"},"elementType":{"description":"ElementType is a FormElementType value\nTEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","enum":["TEXT","TOGGLE","TEXTAREA","HIDDEN","PHONE","EMAIL","SELECT","DATE","SECTION","COLUMNS"],"example":"TEXT","type":"string","x-go-enum-desc":"TEXT FormElementTypeText\nTOGGLE FormElementTypeToggle\nTEXTAREA FormElementTypeTextArea\nHIDDEN FormElementTypeHidden\nPHONE FormElementTypePhone\nEMAIL FormElementTypeEmail\nSELECT FormElementTypeSelect\nDATE FormElementTypeDate\nSECTION FormElementTypeSection\nCOLUMNS FormElementTypeColumns","x-go-name":"ElementType"},"id":{"description":"ID is a form element identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"key":{"description":"Key is the technical key","example":"department","type":"string","x-go-name":"Key"},"validations":{"description":"FormElementValidationsSet is a set of FormElementValidation items","example":[{"validationType":"REQUIRED"}],"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormElements"},"formErrors":{"description":"FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors","items":{"properties":{"key":{"description":"Key is the technical key","example":"department","type":"string","x-go-name":"Key"},"messages":{"description":"Messages is a list of web.ErrorMessage items","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"type":"array","x-go-name":"Messages"},"value":{"description":"Value is the value associated with a Key","example":"Engineering","x-go-name":"Value"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"FormErrors"},"formInput":{"additionalProperties":{},"description":"FormInput is an object of form input labels to value","example":{"input1":"Sales"},"type":"object","x-go-name":"FormInput"},"id":{"description":"FormInstanceID is a unique guid identifying this form instance","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"FormInstanceID"},"modified":{"description":"Modified is the last date the form instance was modified","example":"2023-07-12T20:14:57.74486Z","format":"date-time","type":"string","x-go-name":"Modified"},"recipients":{"description":"Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it","items":{"properties":{"id":{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"},"type":{"description":"Type is a FormInstanceRecipientType value\nIDENTITY FormInstanceRecipientIdentity","enum":["IDENTITY"],"example":"IDENTITY","type":"string","x-go-enum-desc":"IDENTITY FormInstanceRecipientIdentity","x-go-name":"Type"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Recipients"},"standAloneForm":{"default":false,"description":"StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form","example":false,"type":"boolean","x-go-name":"StandAloneForm"},"standAloneFormUrl":{"description":"StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI","example":"https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"StandAloneFormURL"},"state":{"description":"State the state of the form instance\nASSIGNED FormInstanceStateAssigned\nIN_PROGRESS FormInstanceStateInProgress\nSUBMITTED FormInstanceStateSubmitted\nCOMPLETED FormInstanceStateCompleted\nCANCELLED FormInstanceStateCancelled","enum":["ASSIGNED","IN_PROGRESS","SUBMITTED","COMPLETED","CANCELLED"],"example":"ASSIGNED","type":"string","x-go-enum-desc":"ASSIGNED FormInstanceStateAssigned\nIN_PROGRESS FormInstanceStateInProgress\nSUBMITTED FormInstanceStateSubmitted\nCOMPLETED FormInstanceStateCompleted\nCANCELLED FormInstanceStateCancelled","x-go-name":"State"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"x-go-name":"Results"}},"x-go-package":"github.com/sailpoint/sp-forms/domain"}}}},"400":{"description":"An error with the request occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"401":{"description":"An error with the authorization occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"403":{"description":"An error with the user permissions occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"title":"Error is the standard API error response type.","type":"object","properties":{"detailCode":{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"trackingId":{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"}}}},"500":{"description":"An internal server error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}}},"security":[{"oauth2":["sp:forms:manage"]}],"method":"get","path":"/form-instances","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List form instances by tenant.","description":{"content":"No parameters required.","type":"text/plain"},"url":{"path":["form-instances"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List form instances by tenant.' (search-form-instances-by-tenant)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List form instances by tenant. + + + +No parameters required. + +
+ +Returns a list of form instances by tenant + +
Schema
    results object[]
    + +Results holds a list of FormInstanceResponse items + +
    createdBy object
    formConditions object[]
    + +FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form + +
    effects object[]
    + +Effects is a list of effects + +
    config object
    + +Config is a arbitrary map that holds a configuration based on EffectType + +
    rules object[]
    + +Rules is a list of rules + +
    formData object
    + +FormData is the data provided by the form on submit. The data is in a key -\> value map + +
    formElements object[]
    + +FormElements is the configuration of the form, this would be a repeat of the fields from the form-config + +
    config object
    + +Config is a config object + +
    formErrors object[]
    + +FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors + +
    messages object[]
    + +Messages is a list of web.ErrorMessage items + +
    formInput object
    + +FormInput is an object of form input labels to value + +
    recipients object[]
    + +Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it + +
+ +An error with the request occurred + +
Schema
    messages object[]
+ +An error with the authorization occurred + +
Schema
    messages object[]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
+ +Too many requests + +
Schema
    messages object[]
+ +An internal server error occurred + +
Schema
    messages object[]
\ No newline at end of file diff --git a/products/idn/api/beta/search-pre-defined-select-options.api.mdx b/products/idn/api/beta/search-pre-defined-select-options.api.mdx new file mode 100644 index 000000000..1ce9bd569 --- /dev/null +++ b/products/idn/api/beta/search-pre-defined-select-options.api.mdx @@ -0,0 +1,51 @@ +--- +id: search-pre-defined-select-options +sidebar_label: List predefined select options. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Custom Forms"],"description":"No parameters required.","operationId":"searchPreDefinedSelectOptions","responses":{"200":{"description":"Returns a list of available predefined select options","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"description":"Results holds a list of PreDefinedSelectOption items","type":"array","items":{"type":"string","description":"PreDefinedSelectOption pre-defined select options","example":"IDENTITY","x-go-package":"github.com/sailpoint/sp-forms/domain"},"x-go-name":"Results"}},"x-go-package":"github.com/sailpoint/sp-forms/domain"}}}},"400":{"description":"An error with the request occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"401":{"description":"An error with the authorization occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"403":{"description":"An error with the user permissions occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"title":"Error is the standard API error response type.","type":"object","properties":{"detailCode":{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"trackingId":{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"}}}},"500":{"description":"An internal server error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}}},"security":[{"oauth2":["sp:forms:manage"]}],"method":"get","path":"/form-definitions/predefined-select-options","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"List predefined select options.","description":{"content":"No parameters required.","type":"text/plain"},"url":{"path":["form-definitions","predefined-select-options"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List predefined select options.' (search-pre-defined-select-options)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List predefined select options. + + + +No parameters required. + +
+ +Returns a list of available predefined select options + +
Schema
+ +An error with the request occurred + +
Schema
    messages object[]
+ +An error with the authorization occurred + +
Schema
    messages object[]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
+ +Too many requests + +
Schema
    messages object[]
+ +An internal server error occurred + +
Schema
    messages object[]
\ No newline at end of file diff --git a/products/idn/api/beta/segments.tag.mdx b/products/idn/api/beta/segments.tag.mdx new file mode 100644 index 000000000..fe6a9112b --- /dev/null +++ b/products/idn/api/beta/segments.tag.mdx @@ -0,0 +1,16 @@ +--- +id: segments +title: "Segments" +description: "Segments" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/send-test-notification.api.mdx b/products/idn/api/beta/send-test-notification.api.mdx new file mode 100644 index 000000000..978d266b4 --- /dev/null +++ b/products/idn/api/beta/send-test-notification.api.mdx @@ -0,0 +1,87 @@ +--- +id: send-test-notification +sidebar_label: Send Test Notification +hide_title: true +hide_table_of_contents: true +api: {"operationId":"sendTestNotification","tags":["Notifications"],"description":"Send a Test Notification","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"The template notification key.","example":"cloud_manual_work_item_summary"},"medium":{"type":"string","description":"The notification medium. Has to be one of the following enum values.","enum":["EMAIL","SLACK","TEAMS"]},"context":{"type":"object","description":"A Json object that denotes the context specific to the template."}}},"example":{"key":"cloud_manual_work_item_summary","medium":"EMAIL","context":{"numberOfPendingTasks":"4","ownerId":"201327fda1c44704ac01181e963d463c"}}}}},"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/send-test-notification","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"key":"cloud_manual_work_item_summary","medium":"EMAIL","context":{}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Send Test Notification","description":{"content":"Send a Test Notification","type":"text/plain"},"url":{"path":["send-test-notification"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Send Test Notification' (send-test-notification)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Send Test Notification + + + +Send a Test Notification + +
Request Body required
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/service-desk-integration.tag.mdx b/products/idn/api/beta/service-desk-integration.tag.mdx new file mode 100644 index 000000000..07c77c709 --- /dev/null +++ b/products/idn/api/beta/service-desk-integration.tag.mdx @@ -0,0 +1,44 @@ +--- +id: service-desk-integration +title: "Service Desk Integration" +description: "Service Desk Integration" +custom_edit_url: null +--- + + + +Use this API to build an integration between IdentityNow and a service desk ITSM (IT service management) solution. +Once an administrator builds this integration between IdentityNow and a service desk, users can use IdentityNow to raise and track tickets that are synchronized between IdentityNow and the service desk. + +In IdentityNow, administrators can create a service desk integration (sometimes also called an SDIM, or Service Desk Integration Module) by going to Admin > Connections > Service Desk and selecting 'Create.' + +To create a Generic Service Desk integration, for example, administrators must provide the required information on the General Settings page, the Connectivity and Authentication information, Ticket Creation information, Status Mapping information, and Requester Source information on the Configure page. +Refer to [Integrating SailPoint with Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) for more information about the process of setting up a Generic Service Desk in IdentityNow. + +Administrators can create various service desk integrations, all with their own nuances. +The following service desk integrations are available: + +- [Atlassian Cloud Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_cloud/help/integrating_jira_cloud_sd/introduction.html) + +- [Atlassian Server Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_server/help/integrating_jira_server_sd/introduction.html) + +- [BMC Helix ITSM Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_ITSM_sd/help/integrating_bmc_helix_itsm_sd/intro.html) + +- [BMC Helix Remedyforce Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_remedyforce_sd/help/integrating_bmc_helix_remedyforce_sd/intro.html) + +- [Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) + +- [ServiceNow Service Desk](https://documentation.sailpoint.com/connectors/servicenow/sdim/help/integrating_servicenow_sdim/intro.html) + +- [Zendesk Service Desk](https://documentation.sailpoint.com/connectors/zendesk/help/integrating_zendesk_sd/introduction.html) + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/set-campaign-reports-config.api.mdx b/products/idn/api/beta/set-campaign-reports-config.api.mdx new file mode 100644 index 000000000..f3ff22945 --- /dev/null +++ b/products/idn/api/beta/set-campaign-reports-config.api.mdx @@ -0,0 +1,80 @@ +--- +id: set-campaign-reports-config +sidebar_label: Set Campaign Reports Configuration +hide_title: true +hide_table_of_contents: true +api: {"operationId":"setCampaignReportsConfig","tags":["Certification Campaigns"],"description":"Overwrites configuration for campaign reports.\nRequires roles CERT_ADMIN and ORG_ADMIN.","requestBody":{"required":true,"description":"Campaign Report Configuration","content":{"application/json":{"schema":{"type":"object","title":"Campaign Reports Configuration","properties":{"identityAttributeColumns":{"type":"array","items":{"type":"string"},"example":["firstname","lastname"]}}}}}},"responses":{"200":{"description":"The persisted Campaign Report Configuration","content":{"application/json":{"schema":{"type":"object","title":"Campaign Reports Configuration","properties":{"identityAttributeColumns":{"type":"array","items":{"type":"string"},"example":["firstname","lastname"]}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/campaigns/reports-configuration","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"identityAttributeColumns":["firstname","lastname"]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Set Campaign Reports Configuration","description":{"content":"Overwrites configuration for campaign reports.\nRequires roles CERT_ADMIN and ORG_ADMIN.","type":"text/plain"},"url":{"path":["campaigns","reports-configuration"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Set Campaign Reports Configuration' (set-campaign-reports-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Set Campaign Reports Configuration + + + +Overwrites configuration for campaign reports. +Requires roles CERT_ADMIN and ORG_ADMIN. + +
Request Body required
+ +Campaign Report Configuration + +
+ +The persisted Campaign Report Configuration + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/set-campaign-template-schedule.api.mdx b/products/idn/api/beta/set-campaign-template-schedule.api.mdx new file mode 100644 index 000000000..cdc1a7419 --- /dev/null +++ b/products/idn/api/beta/set-campaign-template-schedule.api.mdx @@ -0,0 +1,159 @@ +--- +id: set-campaign-template-schedule +sidebar_label: Sets a Campaign Template's Schedule +hide_title: true +hide_table_of_contents: true +api: {"operationId":"setCampaignTemplateSchedule","tags":["Certification Campaigns"],"description":"Sets the schedule for a campaign template. If a schedule already exists, it will be overwritten with the new one.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the campaign template being scheduled."}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have 'hours' set, but not 'days'; a WEEKLY schedule can have both 'hours' and 'days' set.","enum":["DAILY","WEEKLY","MONTHLY","ANNUALLY","CALENDAR"]},"months":{"type":"object","description":"Specifies which months of a schedule are active. Only valid for ANNUALLY schedule types. Examples:\n\nOn February and March:\n* type LIST\n* values \"2\", \"3\"\n\nEvery 3 months, starting in January (quarterly):\n* type LIST\n* values \"1\"\n* interval 3\n\nEvery two months between July and December:\n* type RANGE\n* values \"7\", \"12\"\n* interval 2\n","properties":{"type":{"type":"string","enum":["LIST","RANGE"]},"values":{"type":"array","items":{"type":"string"}},"interval":{"type":"integer"}},"required":["type","values"]},"days":{"type":"object","description":"Specifies which day(s) a schedule is active for. This is required for all schedule types except DAILY.\nThe \"values\" field holds different data depending on the type of schedule:\n* WEEKLY: days of the week (1-7)\n* MONTHLY: days of the month (1-31, L, L-1...)\n* ANNUALLY: if the \"months\" field is also set: days of the month (1-31, L, L-1...); otherwise: ISO-8601 dates without year (\"--12-31\")\n* CALENDAR: ISO-8601 dates (\"2020-12-31\")\n\nNote that CALENDAR only supports the LIST type, and ANNUALLY does not support the RANGE type when provided\nwith ISO-8601 dates without year.\n\nExamples:\n\nOn Sundays:\n* type LIST\n* values \"1\"\n\nThe second to last day of the month:\n* type LIST\n* values \"L-1\"\n\nFrom the 20th to the last day of the month:\n* type RANGE\n* values \"20\", \"L\"\n\nEvery March 2nd:\n* type LIST\n* values \"--03-02\"\n\nOn March 2nd, 2021:\n* type: LIST\n* values \"2021-03-02\"\n","properties":{"type":{"type":"string","enum":["LIST","RANGE"]},"values":{"type":"array","items":{"type":"string"}},"interval":{"type":"integer"}},"required":["type","values"]},"hours":{"type":"object","description":"Specifies which hour(s) a schedule is active for. Examples:\n\nEvery three hours starting from 8AM, inclusive:\n* type LIST\n* values \"8\"\n* interval 3\n\nDuring business hours:\n* type RANGE\n* values \"9\", \"5\"\n\nAt 5AM, noon, and 5PM:\n* type LIST\n* values \"5\", \"12\", \"17\"\n","properties":{"type":{"type":"string","enum":["LIST","RANGE"]},"values":{"type":"array","items":{"type":"string"}},"interval":{"type":"integer"}},"required":["type","values"]},"expiration":{"type":"string","format":"date-time","description":"Specifies the time after which this schedule will no longer occur."},"timeZoneId":{"type":"string","description":"The time zone to use when running the schedule. For instance, if the schedule is a DAILY schedule that runs at 1AM, and this field is set to \"CST\", the schedule will run at 1AM CST."}},"required":["type","hours"],"example":{"type":"MONTHLY","hours":{"type":"LIST","values":["0"]},"days":{"type":"LIST","values":["1"]}}},"examples":{"Monthly":{"description":"Runs on the 15th and last day of the month, at 5PM.","value":{"type":"MONTHLY","hours":{"type":"LIST","values":["17"]},"days":{"type":"LIST","values":["15"]}}},"Once a year":{"description":"Runs every January 1st at midnight.","value":{"type":"ANNUALLY","hours":{"type":"LIST","values":["0"]},"days":{"type":"LIST","values":["--01-01"]}}},"Quarterly":{"description":"Runs once a quarter (every 3 months) on the first of the month at 1AM.","value":{"type":"ANNUALLY","hours":{"type":"LIST","values":["1"]},"days":{"type":"LIST","values":["1"]},"months":{"type":"LIST","values":["1"],"interval":3}}},"Yearly on Specific Days":{"description":"Runs on March 12 and December 5 at 1AM, every year.","value":{"type":"ANNUALLY","hours":{"type":"LIST","values":["1"]},"days":{"type":"LIST","values":["--03-12","--12-05"]}}},"On a Specific Date":{"description":"Runs at 1AM on February 18th, 2020","value":{"type":"CALENDAR","hours":{"type":"LIST","values":["1"]},"days":{"type":"LIST","values":["2020-02-18"]}}}}}}},"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/campaign-templates/{id}/schedule","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"type":"MONTHLY","hours":{"type":"LIST","values":["0"]},"days":{"type":"LIST","values":["1"]}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Sets a Campaign Template's Schedule","description":{"content":"Sets the schedule for a campaign template. If a schedule already exists, it will be overwritten with the new one.","type":"text/plain"},"url":{"path":["campaign-templates",":id","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the campaign template being scheduled.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Sets a Campaign Template's Schedule' (set-campaign-template-schedule)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Sets a Campaign Template's Schedule + + + +Sets the schedule for a campaign template. If a schedule already exists, it will be overwritten with the new one. + +
Path Parameters
Request Body
    months object
    + +Specifies which months of a schedule are active. Only valid for ANNUALLY schedule types. Examples: + +On February and March: +* type LIST +* values "2", "3" + +Every 3 months, starting in January (quarterly): +* type LIST +* values "1" +* interval 3 + +Every two months between July and December: +* type RANGE +* values "7", "12" +* interval 2 + + +
    days object
    + +Specifies which day(s) a schedule is active for. This is required for all schedule types except DAILY. +The "values" field holds different data depending on the type of schedule: +* WEEKLY: days of the week (1-7) +* MONTHLY: days of the month (1-31, L, L-1...) +* ANNUALLY: if the "months" field is also set: days of the month (1-31, L, L-1...); otherwise: ISO-8601 dates without year ("--12-31") +* CALENDAR: ISO-8601 dates ("2020-12-31") + +Note that CALENDAR only supports the LIST type, and ANNUALLY does not support the RANGE type when provided +with ISO-8601 dates without year. + +Examples: + +On Sundays: +* type LIST +* values "1" + +The second to last day of the month: +* type LIST +* values "L-1" + +From the 20th to the last day of the month: +* type RANGE +* values "20", "L" + +Every March 2nd: +* type LIST +* values "--03-02" + +On March 2nd, 2021: +* type: LIST +* values "2021-03-02" + + +
    hours object required
    + +Specifies which hour(s) a schedule is active for. Examples: + +Every three hours starting from 8AM, inclusive: +* type LIST +* values "8" +* interval 3 + +During business hours: +* type RANGE +* values "9", "5" + +At 5AM, noon, and 5PM: +* type LIST +* values "5", "12", "17" + + +
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/set-identity-password.api.mdx b/products/idn/api/beta/set-identity-password.api.mdx new file mode 100644 index 000000000..b3cec3161 --- /dev/null +++ b/products/idn/api/beta/set-identity-password.api.mdx @@ -0,0 +1,116 @@ +--- +id: set-identity-password +sidebar_label: Set Identity's Password +hide_title: true +hide_table_of_contents: true +api: {"operationId":"setIdentityPassword","tags":["Password Management"],"description":"This API is used to set a password for an identity. \n\nAn identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their IDN user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow).\n\nA token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity's password or the password of any of the identity's accounts. \n\"API authority\" refers to a token that only has the \"client_credentials\" grant type.\n\nYou can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). \nTo do so, follow these steps:\n\n1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. \n\n2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. \n\n3. Use [Set Identity's Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password:\n\n```java\nimport javax.crypto.Cipher;\nimport java.security.KeyFactory;\nimport java.security.PublicKey;\nimport java.security.spec.X509EncodedKeySpec;\nimport java util.Base64;\n\nString encrypt(String publicKey, String toEncrypt) throws Exception {\n byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey);\n byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes(\"UTF-8\"));\n return Base64.getEncoder().encodeToString(encryptedBytes);\n}\n\nprivate byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception {\n PublicKey key = KeyFactory.getInstance(\"RSA\").generatePublic(new X509EncodedKeySpec(publicKeyBytes));\n String transformation = \"RSA/ECB/PKCS1Padding\";\n Cipher cipher = Cipher.getInstance(transformation);\n cipher.init(1, key);\n return cipher.doFinal(toEncryptBytes);\n}\n``` \n\nIn this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. \n\nYou can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. \n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","description":"The identity ID that requested the password change","example":"8a807d4c73c545510173c545f0a002ff"},"encryptedPassword":{"type":"string","description":"The RSA encrypted password","example":"XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A=="},"publicKeyId":{"type":"string","description":"The encryption key ID","example":"YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2"},"accountId":{"type":"string","description":"Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350","example":"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com"},"sourceId":{"type":"string","description":"The ID of the source for which identity is requesting the password change","example":"8a807d4c73c545510173c545d4b60246"}}},"example":{"identityId":"8a807d4c73c545510173c545f0a002ff","encryptedPassword":"GIAP7TaAg7Y2EJtFojokBDvHQ/iXF3qk0z0+eLusqXMSkEhAfr34GydFLy+BM2uZB94cwbTYKi9rRrCRRdh8610VeqpRDjhuc28nOPYqTJOx09IGJdr8dl4mbhC1f21JCqMBBrFSA4VQQvd6OMVsceoXTjDI0aKahRYNjlMlsOuaIUZeNQxWBydLuR6vYG3qAKEPCzYZbvyYuBUylUWArfqwV4dgwKGDgDkTLBkQU9LVu3rssc+BXaex6l6JcBDiPg7wvKD1G3lZ+BaGrMknbx3j0T2Uivg+HxwTf7PmtAua6O9M7F984c79KM+sYFTU37MAdlWZu/cy+w2DdHVdCg==","publicKeyId":"YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2","accountId":"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com","sourceId":"8a807d4c73c545510173c545d4b60246"}}}},"responses":{"202":{"description":"Reference to the password change.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","nullable":true,"description":"The password change request ID","example":"089899f13a8f4da7824996191587bab9"},"state":{"type":"string","enum":["IN_PROGRESS","FINISHED","FAILED"],"description":"Password change state"}}},"examples":{"Password change is in progress":{"value":{"state":"IN_PROGRESS","requestId":"089899f13a8f4da7824996191587bab9"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/set-password","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"identityId":"8a807d4c73c545510173c545f0a002ff","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","sourceId":"8a807d4c73c545510173c545d4b60246"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Set Identity's Password","description":{"content":"This API is used to set a password for an identity. \n\nAn identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their IDN user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow).\n\nA token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity's password or the password of any of the identity's accounts. \n\"API authority\" refers to a token that only has the \"client_credentials\" grant type.\n\nYou can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). \nTo do so, follow these steps:\n\n1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. \n\n2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. \n\n3. Use [Set Identity's Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password:\n\n```java\nimport javax.crypto.Cipher;\nimport java.security.KeyFactory;\nimport java.security.PublicKey;\nimport java.security.spec.X509EncodedKeySpec;\nimport java util.Base64;\n\nString encrypt(String publicKey, String toEncrypt) throws Exception {\n byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey);\n byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes(\"UTF-8\"));\n return Base64.getEncoder().encodeToString(encryptedBytes);\n}\n\nprivate byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception {\n PublicKey key = KeyFactory.getInstance(\"RSA\").generatePublic(new X509EncodedKeySpec(publicKeyBytes));\n String transformation = \"RSA/ECB/PKCS1Padding\";\n Cipher cipher = Cipher.getInstance(transformation);\n cipher.init(1, key);\n return cipher.doFinal(toEncryptBytes);\n}\n``` \n\nIn this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. \n\nYou can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. \n","type":"text/plain"},"url":{"path":["set-password"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Set Identity's Password' (set-identity-password)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Set Identity's Password + + + +This API is used to set a password for an identity. + +An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their IDN user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). + +A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity's password or the password of any of the identity's accounts. +"API authority" refers to a token that only has the "client_credentials" grant type. + +You can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). +To do so, follow these steps: + +1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. + +2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. + +3. Use [Set Identity's Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password: + +```java +import javax.crypto.Cipher; +import java.security.KeyFactory; +import java.security.PublicKey; +import java.security.spec.X509EncodedKeySpec; +import java util.Base64; + +String encrypt(String publicKey, String toEncrypt) throws Exception { + byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey); + byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes("UTF-8")); + return Base64.getEncoder().encodeToString(encryptedBytes); +} + +private byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception { + PublicKey key = KeyFactory.getInstance("RSA").generatePublic(new X509EncodedKeySpec(publicKeyBytes)); + String transformation = "RSA/ECB/PKCS1Padding"; + Cipher cipher = Cipher.getInstance(transformation); + cipher.init(1, key); + return cipher.doFinal(toEncryptBytes); +} +``` + +In this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. + +You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. + + +
Request Body required
+ +Reference to the password change. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/set-mfa-config.api.mdx b/products/idn/api/beta/set-mfa-config.api.mdx new file mode 100644 index 000000000..d6e313982 --- /dev/null +++ b/products/idn/api/beta/set-mfa-config.api.mdx @@ -0,0 +1,75 @@ +--- +id: set-mfa-config +sidebar_label: Set MFA method configuration +hide_title: true +hide_table_of_contents: true +api: {"operationId":"setMFAConfig","tags":["MFA Configuration"],"description":"This API sets the configuration of a given MFA method. A token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:mfa-configuration:manage"]}],"parameters":[{"in":"path","name":"method","schema":{"type":"string","example":"okta-verify"},"required":true,"description":"The name of the MFA method. The currently supported method name is okta-verify."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If MFA method is enabled."},"host":{"type":"string","description":"The server host name or IP address of the MFA provider.","example":"example.com"},"accessKey":{"type":"string","description":"The secret key for authenticating requests to the MFA provider."},"identityAttribute":{"type":"string","description":"Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider.","example":"email"}}},"example":{"enabled":true,"host":"www.example.com","accessKey":"dk778Y3QlA5UqocYpdU3rEkzrK2D497y","identityAttribute":"email"}}}},"responses":{"200":{"description":"MFA configuration of a given method.","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If MFA method is enabled."},"host":{"type":"string","description":"The server host name or IP address of the MFA provider.","example":"example.com"},"accessKey":{"type":"string","description":"The secret key for authenticating requests to the MFA provider."},"identityAttribute":{"type":"string","description":"Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider.","example":"email"}}},"example":{"enabled":true,"host":"www.example.com","accessKey":"dk778Y3QlA5UqocYpdU3rEkzrK2D497y","identityAttribute":"email"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/mfa/{method}/config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"enabled":true,"host":"example.com","accessKey":"string","identityAttribute":"email"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Set MFA method configuration","description":{"content":"This API sets the configuration of a given MFA method. A token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["mfa",":method","config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The name of the MFA method. The currently supported method name is okta-verify.","type":"text/plain"},"type":"any","value":"","key":"method"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Set MFA method configuration' (set-mfa-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Set MFA method configuration + + + +This API sets the configuration of a given MFA method. A token with ORG_ADMIN authority is required to call this API. + +
Path Parameters
Request Body required
+ +MFA configuration of a given method. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/show-preview-data-source.api.mdx b/products/idn/api/beta/show-preview-data-source.api.mdx new file mode 100644 index 000000000..d47855056 --- /dev/null +++ b/products/idn/api/beta/show-preview-data-source.api.mdx @@ -0,0 +1,63 @@ +--- +id: show-preview-data-source +sidebar_label: Preview form definition data source. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Custom Forms"],"operationId":"showPreviewDataSource","parameters":[{"name":"formDefinitionID","in":"path","description":"Form definition ID","required":true,"schema":{"type":"string","x-go-name":"FormDefinitionID"},"example":"00000000-0000-0000-0000-000000000000","x-go-name":"FormDefinitionID"},{"name":"limit","in":"query","description":"Limit\n\nInteger 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).\nIf it is not specified, a default limit is used.","schema":{"type":"integer","format":"int64","maxLength":250,"minLength":0,"default":10,"x-go-name":"Limit"},"example":10,"required":false,"x-go-name":"Limit"},{"name":"filters","in":"query","description":"Filters\n\nFilter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\nvalue: eq, gt, sw, in\nlabel: eq, gt, sw, in\nsubLabel: eq, gt, sw, in","schema":{"type":"string","x-go-name":"Filters"},"example":"label sw \"my label\"","required":false,"x-go-name":"Filters"},{"name":"query","in":"query","description":"Query\n\nString specifying to query against","schema":{"type":"string","x-go-name":"Query"},"example":"support","required":false,"x-go-name":"Query"}],"requestBody":{"description":"Body is the request payload to create a form definition dynamic schema","content":{"application/json":{"schema":{"properties":{"dataSource":{"properties":{"config":{"properties":{"aggregationBucketField":{"description":"AggregationBucketField is the aggregation bucket field name","example":"attributes.cloudStatus.exact","type":"string","x-go-name":"AggregationBucketField"},"indices":{"description":"Indices is a list of indices to use","example":["identities"],"items":{"enum":["accessprofiles","accountactivities","entitlements","identities","events","roles","*"],"type":"string","x-go-enum-desc":"accessprofiles SearchIndexAccessProfiles\naccountactivities SearchIndexAccountActivities\nentitlements SearchIndexEntitlements\nidentities SearchIndexIdentities\nevents SearchIndexEvents\nroles SearchIndexRoles\n* SearchIndexWildcard"},"type":"array","x-go-name":"Indices"},"objectType":{"description":"ObjectType is a PreDefinedSelectOption value\nIDENTITY PreDefinedSelectOptionIdentity\nACCESS_PROFILE PreDefinedSelectOptionAccessProfile\nSOURCES PreDefinedSelectOptionSources\nROLE PreDefinedSelectOptionRole\nENTITLEMENT PreDefinedSelectOptionEntitlement","enum":["IDENTITY","ACCESS_PROFILE","SOURCES","ROLE","ENTITLEMENT"],"example":"IDENTITY","type":"string","x-go-enum-desc":"IDENTITY PreDefinedSelectOptionIdentity\nACCESS_PROFILE PreDefinedSelectOptionAccessProfile\nSOURCES PreDefinedSelectOptionSources\nROLE PreDefinedSelectOptionRole\nENTITLEMENT PreDefinedSelectOptionEntitlement","x-go-name":"ObjectType"},"query":{"description":"Query is a text","example":"*","type":"string","x-go-name":"Query"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"},"dataSourceType":{"description":"DataSourceType is a FormElementDataSourceType value\nSTATIC FormElementDataSourceTypeStatic\nINTERNAL FormElementDataSourceTypeInternal\nSEARCH FormElementDataSourceTypeSearch","enum":["STATIC","INTERNAL","SEARCH"],"example":"STATIC","type":"string","x-go-enum-desc":"STATIC FormElementDataSourceTypeStatic\nINTERNAL FormElementDataSourceTypeInternal\nSEARCH FormElementDataSourceTypeSearch","x-go-name":"DataSourceType"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}}},"required":false},"responses":{"200":{"description":"Returns a preview of a form definition data source","content":{"application/json":{"schema":{"description":"PreviewDataSourceResponse is the response sent by /form-definitions/{formDefinitionID}/data-source endpoint","properties":{"results":{"description":"Results holds a list of FormElementDataSourceConfigOptions items","example":"{\"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\"}]}","items":{"type":"object","properties":{"label":{"description":"Label is the main label to display to the user when selecting this option","type":"string","example":"regression-test-access-request-07c55dd6-3056-430a-86b5-fccc395bb6c5","x-go-name":"Label"},"subLabel":{"description":"SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option","type":"string","example":"","x-go-name":"SubLabel"},"value":{"description":"Value is the value to save as an entry when the user selects this option","type":"string","example":"e96674448eba4ca1ba04eee999a8f3cd","x-go-name":"Value"}},"x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Results"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}}}},"400":{"description":"An error with the request occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"401":{"description":"An error with the authorization occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"403":{"description":"An error with the user permissions occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"404":{"description":"An error with the item not found","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"title":"Error is the standard API error response type.","type":"object","properties":{"detailCode":{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"trackingId":{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"}}}},"500":{"description":"An internal server error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}}},"security":[{"oauth2":["sp:forms:manage"]}],"description":"Preview form definition data source.","method":"post","path":"/form-definitions/{formDefinitionID}/data-source","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"dataSource":{"config":{"aggregationBucketField":"attributes.cloudStatus.exact","indices":["identities"],"objectType":"IDENTITY","query":"*"},"dataSourceType":"STATIC"}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Preview form definition data source.","description":{"type":"text/plain"},"url":{"path":["form-definitions",":formDefinitionID","data-source"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Limit\n\nInteger 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).\nIf it is not specified, a default limit is used.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Filters\n\nFilter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\nvalue: eq, gt, sw, in\nlabel: eq, gt, sw, in\nsubLabel: eq, gt, sw, in","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Query\n\nString specifying to query against","type":"text/plain"},"key":"query","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Form definition ID","type":"text/plain"},"type":"any","value":"","key":"formDefinitionID"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Preview form definition data source.' (show-preview-data-source)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Preview form definition data source. + + + +Preview form definition data source. + +
Path Parameters
Query Parameters
    value: eq, gt, sw, in\nlabel: eq, gt, sw, in\nsubLabel: eq, gt, sw, in","schema":{"type":"string","x-go-name":"Filters"},"example":"label sw \"my label\"","required":false,"x-go-name":"Filters"}}>
Request Body
+ +Body is the request payload to create a form definition dynamic schema + +
    dataSource object
    config object
+ +Returns a preview of a form definition data source + +
Schema
    results object[]
    + +Results holds a list of FormElementDataSourceConfigOptions items + +
+ +An error with the request occurred + +
Schema
    messages object[]
+ +An error with the authorization occurred + +
Schema
    messages object[]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
+ +An error with the item not found + +
Schema
    messages object[]
+ +Too many requests + +
Schema
    messages object[]
+ +An internal server error occurred + +
Schema
    messages object[]
\ No newline at end of file diff --git a/products/idn/api/beta/sidebar.js b/products/idn/api/beta/sidebar.js new file mode 100644 index 000000000..9050313a7 --- /dev/null +++ b/products/idn/api/beta/sidebar.js @@ -0,0 +1 @@ +module.exports = [{"type":"doc","id":"api/beta/identitynow-beta-api"},{"type":"category","label":"Access Profiles","link":{"type":"doc","id":"api/beta/access-profiles"},"items":[{"type":"doc","id":"api/beta/list-access-profiles","label":"List Access Profiles","className":"api-method get"},{"type":"doc","id":"api/beta/create-access-profile","label":"Create an Access Profile","className":"api-method post"},{"type":"doc","id":"api/beta/get-access-profile","label":"Get an Access Profile","className":"api-method get"},{"type":"doc","id":"api/beta/patch-access-profile","label":"Patch a specified Access Profile","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-access-profile","label":"Delete the specified Access Profile","className":"api-method delete"},{"type":"doc","id":"api/beta/delete-access-profiles-in-bulk","label":"Delete Access Profile(s)","className":"api-method post"},{"type":"doc","id":"api/beta/get-access-profile-entitlements","label":"List Access Profile's Entitlements","className":"api-method get"}]},{"type":"category","label":"Access Request Approvals","link":{"type":"doc","id":"api/beta/access-request-approvals"},"items":[{"type":"doc","id":"api/beta/list-pending-approvals","label":"Pending Access Request Approvals List","className":"api-method get"},{"type":"doc","id":"api/beta/list-completed-approvals","label":"Completed Access Request Approvals List","className":"api-method get"},{"type":"doc","id":"api/beta/approve-access-request","label":"Approves an access request approval.","className":"api-method post"},{"type":"doc","id":"api/beta/reject-access-request","label":"Rejects an access request approval.","className":"api-method post"},{"type":"doc","id":"api/beta/forward-access-request","label":"Forwards an access request approval to a new owner.","className":"api-method post"},{"type":"doc","id":"api/beta/get-access-request-approval-summary","label":"Get the number of pending, approved and rejected access requests approvals","className":"api-method get"}]},{"type":"category","label":"Access Requests","link":{"type":"doc","id":"api/beta/access-requests"},"items":[{"type":"doc","id":"api/beta/create-access-request","label":"Submit an Access Request","className":"api-method post"},{"type":"doc","id":"api/beta/cancel-access-request","label":"Cancel Access Request","className":"api-method post"},{"type":"doc","id":"api/beta/close-access-request","label":"Close Access Request","className":"api-method post"},{"type":"doc","id":"api/beta/get-access-request-config","label":"Get Access Request Configuration","className":"api-method get"},{"type":"doc","id":"api/beta/update-access-request-config","label":"Update Access Request Configuration","className":"api-method put"},{"type":"doc","id":"api/beta/list-access-request-status","label":"Access Request Status","className":"api-method get"}]},{"type":"category","label":"Account Activities","link":{"type":"doc","id":"api/beta/account-activities"},"items":[{"type":"doc","id":"api/beta/list-account-activities","label":"List Account Activities","className":"api-method get"},{"type":"doc","id":"api/beta/get-account-activity","label":"Get Account Activity","className":"api-method get"}]},{"type":"category","label":"Account Aggregations","link":{"type":"doc","id":"api/beta/account-aggregations"},"items":[{"type":"doc","id":"api/beta/get-account-aggregation-status","label":"In-progress Account Aggregation status","className":"api-method get"}]},{"type":"category","label":"Accounts","link":{"type":"doc","id":"api/beta/accounts"},"items":[{"type":"doc","id":"api/beta/list-accounts","label":"Accounts List","className":"api-method get"},{"type":"doc","id":"api/beta/create-account","label":"Create Account","className":"api-method post"},{"type":"doc","id":"api/beta/get-account","label":"Account Details","className":"api-method get"},{"type":"doc","id":"api/beta/update-account","label":"Update Account","className":"api-method patch"},{"type":"doc","id":"api/beta/put-account","label":"Update Account","className":"api-method put"},{"type":"doc","id":"api/beta/delete-account","label":"Delete Account","className":"api-method delete"},{"type":"doc","id":"api/beta/get-account-entitlements","label":"Account Entitlements","className":"api-method get"},{"type":"doc","id":"api/beta/reload-account","label":"Reload Account","className":"api-method post"},{"type":"doc","id":"api/beta/enable-account","label":"Enable Account","className":"api-method post"},{"type":"doc","id":"api/beta/disable-account","label":"Disable Account","className":"api-method post"},{"type":"doc","id":"api/beta/unlock-account","label":"Unlock Account","className":"api-method post"},{"type":"doc","id":"api/beta/enable-account-for-identity","label":"Enable IDN Account for Identity","className":"api-method post"},{"type":"doc","id":"api/beta/disable-account-for-identity","label":"Disable IDN Account for Identity","className":"api-method post"},{"type":"doc","id":"api/beta/enable-accounts-for-identities","label":"Enable IDN Accounts for Identities","className":"api-method post"},{"type":"doc","id":"api/beta/disable-accounts-for-identities","label":"Disable IDN Accounts for Identities","className":"api-method post"}]},{"type":"category","label":"Certification Campaigns","link":{"type":"doc","id":"api/beta/certification-campaigns"},"items":[{"type":"doc","id":"api/beta/get-active-campaigns","label":"List Campaigns","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/create-campaign","label":"Create a campaign","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/delete-campaigns","label":"Deletes Campaigns","className":"api-method post"},{"type":"doc","id":"api/beta/get-campaign","label":"Get a campaign","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/update-campaign","label":"Update a Campaign","className":"api-method patch"},{"type":"doc","id":"api/beta/start-campaign","label":"Activate a Campaign","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/complete-campaign","label":"Complete a Campaign","className":"api-method post"},{"type":"doc","id":"api/beta/run-campaign-remediation-scan","label":"Run Campaign Remediation Scan","className":"api-method post"},{"type":"doc","id":"api/beta/move","label":"Reassign Certifications","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-campaign-reports","label":"Get Campaign Reports","className":"api-method get"},{"type":"doc","id":"api/beta/run-campaign-report","label":"Run Campaign Report","className":"api-method post"},{"type":"doc","id":"api/beta/get-campaign-reports-config","label":"Get Campaign Reports Configuration","className":"api-method get"},{"type":"doc","id":"api/beta/set-campaign-reports-config","label":"Set Campaign Reports Configuration","className":"api-method put"},{"type":"doc","id":"api/beta/list-campaign-templates","label":"List Campaign Templates","className":"api-method get"},{"type":"doc","id":"api/beta/create-campaign-template","label":"Create a Campaign Template","className":"api-method post"},{"type":"doc","id":"api/beta/get-campaign-template","label":"Get a Campaign Template","className":"api-method get"},{"type":"doc","id":"api/beta/patch-campaign-template","label":"Update a Campaign Template","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-campaign-template","label":"Delete a Campaign Template","className":"api-method delete"},{"type":"doc","id":"api/beta/generate-campaign-template","label":"Generate a Campaign from Template","className":"api-method post"},{"type":"doc","id":"api/beta/get-campaign-template-schedule","label":"Gets a Campaign Template's Schedule","className":"api-method get"},{"type":"doc","id":"api/beta/set-campaign-template-schedule","label":"Sets a Campaign Template's Schedule","className":"api-method put"},{"type":"doc","id":"api/beta/delete-campaign-template-schedule","label":"Deletes a Campaign Template's Schedule","className":"api-method delete"}]},{"type":"category","label":"Certifications","link":{"type":"doc","id":"api/beta/certifications"},"items":[{"type":"doc","id":"api/beta/reassign-identity-certs-async","label":"Reassign Certifications Asynchronously","className":"api-method post"},{"type":"doc","id":"api/beta/get-identity-certification-task-status","label":"Certification Task Status","className":"api-method get"},{"type":"doc","id":"api/beta/get-identity-certification-pending-tasks","label":"Pending Certification Tasks","className":"api-method get"},{"type":"doc","id":"api/beta/get-identity-certification-item-permissions","label":"Permissions for Entitlement Certification Item","className":"api-method get"},{"type":"doc","id":"api/beta/list-certification-reviewers","label":"List of Reviewers for the certification","className":"api-method get"}]},{"type":"category","label":"Connector Rule Management","link":{"type":"doc","id":"api/beta/connector-rule-management"},"items":[{"type":"doc","id":"api/beta/get-connector-rule-list","label":"List Connector Rules","className":"api-method get"},{"type":"doc","id":"api/beta/create-connector-rule","label":"Create Connector Rule","className":"api-method post"},{"type":"doc","id":"api/beta/get-connector-rule","label":"Connector-Rule by ID","className":"api-method get"},{"type":"doc","id":"api/beta/update-connector-rule","label":"Update a Connector Rule","className":"api-method put"},{"type":"doc","id":"api/beta/delete-connector-rule","label":"Delete a Connector-Rule","className":"api-method delete"},{"type":"doc","id":"api/beta/validate-connector-rule","label":"Validate Connector Rule","className":"api-method post"}]},{"type":"category","label":"Connectors","link":{"type":"doc","id":"api/beta/connectors"},"items":[{"type":"doc","id":"api/beta/get-connector-list","label":"Gets connector list","className":"api-method get"}]},{"type":"category","label":"Custom Forms","link":{"type":"doc","id":"api/beta/custom-forms"},"items":[{"type":"doc","id":"api/beta/search-form-definitions-by-tenant","label":"Export form definitions by tenant.","className":"api-method get"},{"type":"doc","id":"api/beta/create-form-definition","label":"Creates a form definition.","className":"api-method post"},{"type":"doc","id":"api/beta/get-form-definition-by-key","label":"Return a form definition.","className":"api-method get"},{"type":"doc","id":"api/beta/delete-form-definition","label":"Deletes a form definition.","className":"api-method delete"},{"type":"doc","id":"api/beta/patch-form-definition","label":"Patch a form definition.","className":"api-method patch"},{"type":"doc","id":"api/beta/show-preview-data-source","label":"Preview form definition data source.","className":"api-method post"},{"type":"doc","id":"api/beta/export-form-definitions-by-tenant","label":"List form definitions by tenant.","className":"api-method get"},{"type":"doc","id":"api/beta/create-form-definition-dynamic-schema","label":"Generate JSON Schema dynamically.","className":"api-method post"},{"type":"doc","id":"api/beta/import-form-definitions","label":"Import form definitions from export.","className":"api-method post"},{"type":"doc","id":"api/beta/search-form-instances-by-tenant","label":"List form instances by tenant.","className":"api-method get"},{"type":"doc","id":"api/beta/create-form-instance","label":"Creates a form instance.","className":"api-method post"},{"type":"doc","id":"api/beta/get-form-instance-by-key","label":"Returns a form instance.","className":"api-method get"},{"type":"doc","id":"api/beta/patch-form-instance","label":"Patch a form instance.","className":"api-method patch"},{"type":"doc","id":"api/beta/search-form-element-data-by-element-id","label":"Retrieves dynamic data by element.","className":"api-method get"},{"type":"doc","id":"api/beta/search-pre-defined-select-options","label":"List predefined select options.","className":"api-method get"}]},{"type":"category","label":"Custom Password Instructions","link":{"type":"doc","id":"api/beta/custom-password-instructions"},"items":[{"type":"doc","id":"api/beta/create-custom-password-instructions","label":"Create Custom Password Instructions","className":"api-method post"},{"type":"doc","id":"api/beta/get-custom-password-instructions","label":"Get Custom Password Instructions by Page ID","className":"api-method get"},{"type":"doc","id":"api/beta/delete-custom-password-instructions","label":"Delete Custom Password Instructions by page ID","className":"api-method delete"}]},{"type":"category","label":"Entitlements","link":{"type":"doc","id":"api/beta/entitlements"},"items":[{"type":"doc","id":"api/beta/list-entitlements","label":"Gets a list of entitlements.","className":"api-method get"},{"type":"doc","id":"api/beta/get-entitlement","label":"Get an entitlement","className":"api-method get"},{"type":"doc","id":"api/beta/patch-entitlement","label":"Patch an entitlement","className":"api-method patch"},{"type":"doc","id":"api/beta/list-entitlement-parents","label":"List of entitlements parents","className":"api-method get"},{"type":"doc","id":"api/beta/list-entitlement-children","label":"List of entitlements children","className":"api-method get"},{"type":"doc","id":"api/beta/update-entitlements-in-bulk","label":"Bulk update an entitlement list","className":"api-method post"},{"type":"doc","id":"api/beta/get-entitlement-request-config","label":"Get Entitlement Request Config","className":"api-method get"},{"type":"doc","id":"api/beta/put-entitlement-request-config","label":"Replace Entitlement Request Config","className":"api-method put"}]},{"type":"category","label":"Governance Groups","link":{"type":"doc","id":"api/beta/governance-groups"},"items":[{"type":"doc","id":"api/beta/list-workgroups","label":"List Governance Groups","className":"api-method get"},{"type":"doc","id":"api/beta/create-workgroup","label":"Create a new Governance Group.","className":"api-method post"},{"type":"doc","id":"api/beta/get-workgroup","label":"Get an Governance Groups","className":"api-method get"}]},{"type":"category","label":"IAI Access Request Recommendations","link":{"type":"doc","id":"api/beta/iai-access-request-recommendations"},"items":[{"type":"doc","id":"api/beta/get-access-request-recommendations","label":"Identity Access Request Recommendations","className":"api-method get"},{"type":"doc","id":"api/beta/add-access-request-recommendations-ignored-item","label":"Notification of Ignored Access Request Recommendations","className":"api-method post"},{"type":"doc","id":"api/beta/get-access-request-recommendations-ignored-items","label":"List of Ignored Access Request Recommendations","className":"api-method get"},{"type":"doc","id":"api/beta/add-access-request-recommendations-requested-item","label":"Notification of Requested Access Request Recommendations","className":"api-method post"},{"type":"doc","id":"api/beta/get-access-request-recommendations-requested-items","label":"List of Requested Access Request Recommendations","className":"api-method get"},{"type":"doc","id":"api/beta/add-access-request-recommendations-viewed-item","label":"Notification of Viewed Access Request Recommendations","className":"api-method post"},{"type":"doc","id":"api/beta/get-access-request-recommendations-viewed-items","label":"List of Viewed Access Request Recommendations","className":"api-method get"},{"type":"doc","id":"api/beta/add-access-request-recommendations-viewed-items","label":"Notification of Viewed Access Request Recommendations in Bulk","className":"api-method post"},{"type":"doc","id":"api/beta/get-message-catalogs","label":"Get Message catalogs","className":"api-method get"}]},{"type":"category","label":"IAI Common Access","link":{"type":"doc","id":"api/beta/iai-common-access"},"items":[{"type":"doc","id":"api/beta/get-common-access","label":"Get a paginated list of common access","className":"api-method get"},{"type":"doc","id":"api/beta/create-common-access","label":"Create common access items","className":"api-method post"},{"type":"doc","id":"api/beta/update-common-access-status-in-bulk","label":"Bulk update common access status","className":"api-method post"}]},{"type":"category","label":"IAI Outliers","link":{"type":"doc","id":"api/beta/iai-outliers"},"items":[{"type":"doc","id":"api/beta/get-identity-outlier-snapshots","label":"IAI Identity Outliers Summary","className":"api-method get"},{"type":"doc","id":"api/beta/get-latest-identity-outlier-snapshots","label":"IAI Identity Outliers Latest Summary","className":"api-method get"},{"type":"doc","id":"api/beta/get-identity-outliers","label":"IAI Get Identity Outliers","className":"api-method get"},{"type":"doc","id":"api/beta/get-peer-group-outliers-contributing-features","label":"Get identity outlier's contibuting features","className":"api-method get"},{"type":"doc","id":"api/beta/ignore-identity-outliers","label":"IAI Identity Outliers Ignore","className":"api-method post"},{"type":"doc","id":"api/beta/un-ignore-identity-outliers","label":"IAI Identity Outliers Unignore","className":"api-method post"},{"type":"doc","id":"api/beta/export-outliers-zip","label":"IAI Identity Outliers Export","className":"api-method get"}]},{"type":"category","label":"IAI Peer Group Strategies","link":{"type":"doc","id":"api/beta/iai-peer-group-strategies"},"items":[{"type":"doc","id":"api/beta/get-peer-group-outliers","label":"Identity Outliers List","className":"menu__list-item--deprecated api-method get"}]},{"type":"category","label":"IAI Recommendations","link":{"type":"doc","id":"api/beta/iai-recommendations"},"items":[{"type":"doc","id":"api/beta/get-recommendations","label":"Returns a Recommendation Based on Object","className":"api-method post"},{"type":"doc","id":"api/beta/get-recommendations-config","label":"Get certification recommendation config values","className":"api-method get"},{"type":"doc","id":"api/beta/update-recommendations-config","label":"Update certification recommendation config values","className":"api-method put"},{"type":"doc","id":"api/beta/get-message-catalogs","label":"Get Message catalogs","className":"api-method get"}]},{"type":"category","label":"IAI Role Mining","link":{"type":"doc","id":"api/beta/iai-role-mining"},"items":[{"type":"doc","id":"api/beta/create-role-mining-sessions","label":"Create a role mining session","className":"api-method post"},{"type":"doc","id":"api/beta/get-role-mining-sessions","label":"Retrieves all role mining sessions","className":"api-method get"},{"type":"doc","id":"api/beta/patch-role-mining-session","label":"Patch a role mining session","className":"api-method patch"},{"type":"doc","id":"api/beta/get-role-mining-session","label":"Get a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/get-role-mining-session-status","label":"Get role mining session status state","className":"api-method get"},{"type":"doc","id":"api/beta/get-potential-role-summaries","label":"Retrieves all potential role summaries","className":"api-method get"},{"type":"doc","id":"api/beta/get-potential-role","label":"Retrieves a specific potential role","className":"api-method get"},{"type":"doc","id":"api/beta/patch-potential-role","label":"Update a potential role","className":"api-method patch"},{"type":"doc","id":"api/beta/get-potential-role-applications","label":"Retrieves the applications of a potential role for a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/get-entitlements-potential-role","label":"Retrieves entitlements for a potential role in a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/get-entitlement-distribution-potential-role","label":"Retrieves entitlement popularity distribution for a potential role in a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/update-entitlements-potential-role","label":"Edit entitlements for a potential role to exclude some entitlements","className":"api-method post"},{"type":"doc","id":"api/beta/get-identities-potential-role","label":"Retrieves identities for a potential role in a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/export-role-mining-potential-role","label":"Export (download) details for a potential role in a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/export-role-mining-potential-role-async","label":"Asynchronously export details for a potential role in a role mining session and upload to S3","className":"api-method post"},{"type":"doc","id":"api/beta/export-role-mining-potential-role-status","label":"Retrieve status of a potential role export job","className":"api-method get"},{"type":"doc","id":"api/beta/download-role-mining-potential-role-zip","label":"Export (download) details for a potential role in a role mining session","className":"api-method get"},{"type":"doc","id":"api/beta/create-potential-role-provision-request","label":"Create request to provision a potential role into an actual role.","className":"api-method post"},{"type":"doc","id":"api/beta/get-excluded-entitlements-potential-role","label":"Retrieves excluded entitlements for a potential role in a role mining session","className":"api-method get"}]},{"type":"category","label":"Identities","link":{"type":"doc","id":"api/beta/identities"},"items":[{"type":"doc","id":"api/beta/synchronize-attributes-for-identity","label":"Attribute synchronization for single identity.","className":"api-method post"},{"type":"doc","id":"api/beta/list-identities","label":"List Identities","className":"api-method get"},{"type":"doc","id":"api/beta/get-identity","label":"Identity Details","className":"api-method get"},{"type":"doc","id":"api/beta/delete-identity","label":"Deletes an identity.","className":"api-method delete"},{"type":"doc","id":"api/beta/start-identity-processing","label":"Process a list of identityIds","className":"api-method post"}]},{"type":"category","label":"Identity History","link":{"type":"doc","id":"api/beta/identity-history"},"items":[{"type":"doc","id":"api/beta/list-historical-identities","label":"Lists all the identities","className":"api-method get"},{"type":"doc","id":"api/beta/get-historical-identity","label":"Get latest snapshot of identity","className":"api-method get"},{"type":"doc","id":"api/beta/list-identity-access-items","label":"Gets a list of access items for the identity filtered by item type","className":"api-method get"},{"type":"doc","id":"api/beta/list-identity-snapshots","label":"Lists all the snapshots for the identity","className":"api-method get"},{"type":"doc","id":"api/beta/get-identity-snapshot-summary","label":"Gets the summary for the event count for a specific identity","className":"api-method get"},{"type":"doc","id":"api/beta/get-identity-snapshot","label":"Gets an identity snapshot at a given date","className":"api-method get"},{"type":"doc","id":"api/beta/list-identity-snapshot-access-items","label":"Gets the list of identity access items at a given date filterd by item type","className":"api-method get"},{"type":"doc","id":"api/beta/get-historical-identity-events","label":"Lists all events for the given identity","className":"api-method get"},{"type":"doc","id":"api/beta/get-identity-start-date","label":"Gets the start date of the identity","className":"api-method get"},{"type":"doc","id":"api/beta/compare-identity-snapshots","label":"Gets a difference of count for each access item types for the given identity between 2 snapshots","className":"api-method get"},{"type":"doc","id":"api/beta/compare-identity-snapshots-access-type","label":"Gets a list of differences of specific accessType for the given identity between 2 snapshots","className":"api-method get"}]},{"type":"category","label":"Identity Profiles","link":{"type":"doc","id":"api/beta/identity-profiles"},"items":[{"type":"doc","id":"api/beta/list-identity-profiles","label":"Identity Profiles list","className":"api-method get"},{"type":"doc","id":"api/beta/create-identity-profile","label":"Create an Identity Profile","className":"api-method post"},{"type":"doc","id":"api/beta/delete-identity-profiles","label":"Delete Identity Profiles","className":"api-method post"},{"type":"doc","id":"api/beta/export-identity-profiles","label":"Export Identity Profiles","className":"api-method get"},{"type":"doc","id":"api/beta/import-identity-profiles","label":"Import Identity Profiles","className":"api-method post"},{"type":"doc","id":"api/beta/generate-identity-preview","label":"Generate Identity Profile Preview","className":"api-method post"},{"type":"doc","id":"api/beta/get-identity-profile","label":"Gets a single Identity Profile","className":"api-method get"},{"type":"doc","id":"api/beta/delete-identity-profile","label":"Delete an Identity Profile","className":"api-method delete"},{"type":"doc","id":"api/beta/update-identity-profile","label":"Update the Identity Profile","className":"api-method patch"},{"type":"doc","id":"api/beta/get-default-identity-attribute-config","label":"Default identity attribute config","className":"api-method get"},{"type":"doc","id":"api/beta/refresh-identity-profile","label":"Refreshes all identities under profile","className":"api-method post"}]},{"type":"category","label":"Lifecycle States","link":{"type":"doc","id":"api/beta/lifecycle-states"},"items":[{"type":"doc","id":"api/beta/list-lifecycle-states","label":"Lifecycle State","className":"api-method get"},{"type":"doc","id":"api/beta/update-lifecycle-states","label":"Update Lifecycle State","className":"api-method patch"}]},{"type":"category","label":"Managed Clients","link":{"type":"doc","id":"api/beta/managed-clients"},"items":[{"type":"doc","id":"api/beta/get-managed-client-status","label":"Specified Managed Client Status.","className":"api-method get"},{"type":"doc","id":"api/beta/update-managed-client-status","label":"Handle status request from client","className":"api-method post"}]},{"type":"category","label":"Managed Clusters","link":{"type":"doc","id":"api/beta/managed-clusters"},"items":[{"type":"doc","id":"api/beta/get-managed-cluster","label":"Get a specified ManagedCluster.","className":"api-method get"},{"type":"doc","id":"api/beta/get-client-log-configuration","label":"Get managed cluster's log configuration","className":"api-method get"},{"type":"doc","id":"api/beta/put-client-log-configuration","label":"Update managed cluster's log configuration","className":"api-method put"},{"type":"doc","id":"api/beta/get-managed-clusters","label":"Retrieve all Managed Clusters.","className":"api-method get"}]},{"type":"category","label":"MFA Configuration","link":{"type":"doc","id":"api/beta/mfa-configuration"},"items":[{"type":"doc","id":"api/beta/get-mfa-config","label":"Configuration of a MFA method","className":"api-method get"},{"type":"doc","id":"api/beta/set-mfa-config","label":"Set MFA method configuration","className":"api-method put"},{"type":"doc","id":"api/beta/test-mfa-config","label":"MFA method's test configuration","className":"api-method get"}]},{"type":"category","label":"Non-Employee Lifecycle Management","link":{"type":"doc","id":"api/beta/non-employee-lifecycle-management"},"items":[{"type":"doc","id":"api/beta/create-non-employee-record","label":"Create Non-Employee Record","className":"api-method post"},{"type":"doc","id":"api/beta/list-non-employee-records","label":"List Non-Employee Records","className":"api-method get"},{"type":"doc","id":"api/beta/get-non-employee-record","label":"Get a Non-Employee Record","className":"api-method get"},{"type":"doc","id":"api/beta/update-non-employee-record","label":"Update Non-Employee Record","className":"api-method put"},{"type":"doc","id":"api/beta/patch-non-employee-record","label":"Patch Non-Employee Record","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-non-employee-record","label":"Delete Non-Employee Record","className":"api-method delete"},{"type":"doc","id":"api/beta/delete-non-employee-record-in-bulk","label":"Delete Multiple Non-Employee Records","className":"api-method post"},{"type":"doc","id":"api/beta/create-non-employee-request","label":"Create Non-Employee Request","className":"api-method post"},{"type":"doc","id":"api/beta/list-non-employee-requests","label":"List Non-Employee Requests","className":"api-method get"},{"type":"doc","id":"api/beta/get-non-employee-request","label":"Get a Non-Employee Request","className":"api-method get"},{"type":"doc","id":"api/beta/delete-non-employee-request","label":"Delete Non-Employee Request","className":"api-method delete"},{"type":"doc","id":"api/beta/get-non-employee-request-summary","label":"Get Summary of Non-Employee Requests","className":"api-method get"},{"type":"doc","id":"api/beta/create-non-employee-source","label":"Create Non-Employee Source","className":"api-method post"},{"type":"doc","id":"api/beta/list-non-employee-sources","label":"List Non-Employee Sources","className":"api-method get"},{"type":"doc","id":"api/beta/get-non-employee-source","label":"Get a Non-Employee Source","className":"api-method get"},{"type":"doc","id":"api/beta/patch-non-employee-source","label":"Patch a Non-Employee Source","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-non-employee-source","label":"Delete Non-Employee Source","className":"api-method delete"},{"type":"doc","id":"api/beta/export-non-employee-records","label":"Exports Non-Employee Records to CSV","className":"api-method get"},{"type":"doc","id":"api/beta/import-non-employee-records-in-bulk","label":"Imports, or Updates, Non-Employee Records","className":"api-method post"},{"type":"doc","id":"api/beta/get-non-employee-bulk-upload-status","label":"Bulk upload status on source","className":"api-method get"},{"type":"doc","id":"api/beta/export-non-employee-source-schema-template","label":"Exports Source Schema Template","className":"api-method get"},{"type":"doc","id":"api/beta/list-non-employee-approval","label":"Get List of Non-Employee Approval Requests","className":"api-method get"},{"type":"doc","id":"api/beta/get-non-employee-approval","label":"Get a non-employee approval item detail","className":"api-method get"},{"type":"doc","id":"api/beta/approve-non-employee-request","label":"Approve a Non-Employee Request","className":"api-method post"},{"type":"doc","id":"api/beta/reject-non-employee-request","label":"Reject a Non-Employee Request","className":"api-method post"},{"type":"doc","id":"api/beta/get-non-employee-approval-summary","label":"Get Summary of Non-Employee Approval Requests","className":"api-method get"},{"type":"doc","id":"api/beta/get-non-employee-source-schema-attributes","label":"List Schema Attributes Non-Employee Source","className":"api-method get"},{"type":"doc","id":"api/beta/create-non-employee-source-schema-attributes","label":"Create Non-Employee Source Schema Attribute","className":"api-method post"},{"type":"doc","id":"api/beta/delete-non-employee-source-schema-attributes","label":"Delete all custom schema attributes","className":"api-method delete"},{"type":"doc","id":"api/beta/get-non-employee-schema-attribute","label":"Get Schema Attribute Non-Employee Source","className":"api-method get"},{"type":"doc","id":"api/beta/patch-non-employee-schema-attribute","label":"Patch Non-Employee Source's Schema Attribute","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-non-employee-schema-attribute","label":"Delete Non-Employee Source's Schema Attribute","className":"api-method delete"}]},{"type":"category","label":"Notifications","link":{"type":"doc","id":"api/beta/notifications"},"items":[{"type":"doc","id":"api/beta/put-mail-from-attributes","label":"Change MAIL FROM domain","className":"api-method put"},{"type":"doc","id":"api/beta/get-mail-from-attributes","label":"Get MAIL FROM Attributes","className":"api-method get"},{"type":"doc","id":"api/beta/list-notification-template-defaults","label":"List Notification Template Defaults","className":"api-method get"},{"type":"doc","id":"api/beta/list-notification-templates","label":"List Notification Templates","className":"api-method get"},{"type":"doc","id":"api/beta/create-notification-template","label":"Create Notification Template","className":"api-method post"},{"type":"doc","id":"api/beta/get-notification-template","label":"Get Notification Template By Id","className":"api-method get"},{"type":"doc","id":"api/beta/delete-notification-templates-in-bulk","label":"Bulk Delete Notification Templates","className":"api-method post"},{"type":"doc","id":"api/beta/get-notifications-template-context","label":"Get Notification Template Context","className":"api-method get"},{"type":"doc","id":"api/beta/get-notification-preference","label":"Get Notification Preferences for tenant.","className":"api-method get"},{"type":"doc","id":"api/beta/put-notification-preference","label":"Overwrite the preferences for the given notification key.","className":"api-method put"},{"type":"doc","id":"api/beta/send-test-notification","label":"Send Test Notification","className":"api-method post"},{"type":"doc","id":"api/beta/list-from-addresses","label":"List From Addresses","className":"api-method get"},{"type":"doc","id":"api/beta/create-verified-from-address","label":"Create Verified From Address","className":"api-method post"},{"type":"doc","id":"api/beta/delete-verified-from-address","label":"Delete Verified From Address","className":"api-method delete"},{"type":"doc","id":"api/beta/get-dkim-attributes","label":"Get DKIM Attributes","className":"api-method get"},{"type":"doc","id":"api/beta/create-domain-dkim","label":"Verify domain address via DKIM","className":"api-method post"}]},{"type":"category","label":"OAuth Clients","link":{"type":"doc","id":"api/beta/o-auth-clients"},"items":[{"type":"doc","id":"api/beta/list-oauth-clients","label":"List OAuth Clients","className":"api-method get"},{"type":"doc","id":"api/beta/create-oauth-client","label":"Create OAuth Client","className":"api-method post"},{"type":"doc","id":"api/beta/get-oauth-client","label":"Get OAuth Client","className":"api-method get"},{"type":"doc","id":"api/beta/delete-oauth-client","label":"Delete OAuth Client","className":"api-method delete"},{"type":"doc","id":"api/beta/patch-oauth-client","label":"Patch OAuth Client","className":"api-method patch"}]},{"type":"category","label":"Org Config","link":{"type":"doc","id":"api/beta/org-config"},"items":[{"type":"doc","id":"api/beta/get-org-config","label":"Get Org configuration settings","className":"api-method get"},{"type":"doc","id":"api/beta/patch-org-config","label":"Patch an Org configuration property","className":"api-method patch"},{"type":"doc","id":"api/beta/get-valid-time-zones","label":"Get list of time zones","className":"api-method get"}]},{"type":"category","label":"Password Configuration","link":{"type":"doc","id":"api/beta/password-configuration"},"items":[{"type":"doc","id":"api/beta/get-password-org-config","label":"Get Password Org Config","className":"api-method get"},{"type":"doc","id":"api/beta/update-password-org-config","label":"Update Password Org Config","className":"api-method put"},{"type":"doc","id":"api/beta/create-password-org-config","label":"Create Password Org Config","className":"api-method post"}]},{"type":"category","label":"Password Dictionary","link":{"type":"doc","id":"api/beta/password-dictionary"},"items":[{"type":"doc","id":"api/beta/get-password-dictionary","label":"Get Password Dictionary","className":"api-method get"},{"type":"doc","id":"api/beta/update-password-dictionary","label":"Update Password Dictionary","className":"api-method put"}]},{"type":"category","label":"Password Management","link":{"type":"doc","id":"api/beta/password-management"},"items":[{"type":"doc","id":"api/beta/generate-digit-token","label":"Generate a digit token","className":"api-method post"},{"type":"doc","id":"api/beta/query-password-info","label":"Query Password Info","className":"api-method post"},{"type":"doc","id":"api/beta/set-identity-password","label":"Set Identity's Password","className":"api-method post"},{"type":"doc","id":"api/beta/get-identity-password-change-status","label":"Get Password Change Request Status","className":"api-method get"}]},{"type":"category","label":"Password Sync Groups","link":{"type":"doc","id":"api/beta/password-sync-groups"},"items":[{"type":"doc","id":"api/beta/get-password-sync-groups","label":"Get Password Sync Group List","className":"api-method get"},{"type":"doc","id":"api/beta/create-password-sync-group","label":"Create Password Sync Group","className":"api-method post"},{"type":"doc","id":"api/beta/get-password-sync-group","label":"Get Password Sync Group by ID","className":"api-method get"},{"type":"doc","id":"api/beta/update-password-sync-group","label":"Update Password Sync Group by ID","className":"api-method put"},{"type":"doc","id":"api/beta/delete-password-sync-group","label":"Delete Password Sync Group by ID","className":"api-method delete"}]},{"type":"category","label":"Personal Access Tokens","link":{"type":"doc","id":"api/beta/personal-access-tokens"},"items":[{"type":"doc","id":"api/beta/list-personal-access-tokens","label":"List Personal Access Tokens","className":"api-method get"},{"type":"doc","id":"api/beta/create-personal-access-token","label":"Create Personal Access Token","className":"api-method post"},{"type":"doc","id":"api/beta/patch-personal-access-token","label":"Patch Personal Access Token","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-personal-access-token","label":"Delete Personal Access Token","className":"api-method delete"}]},{"type":"category","label":"Public Identities Config","link":{"type":"doc","id":"api/beta/public-identities-config"},"items":[{"type":"doc","id":"api/beta/get-public-identity-config","label":"Get Public Identity Config","className":"api-method get"},{"type":"doc","id":"api/beta/update-public-identity-config","label":"Update Public Identity Config","className":"api-method put"}]},{"type":"category","label":"Requestable Objects","link":{"type":"doc","id":"api/beta/requestable-objects"},"items":[{"type":"doc","id":"api/beta/list-requestable-objects","label":"Requestable Objects List","className":"api-method get"}]},{"type":"category","label":"Role Insights","link":{"type":"doc","id":"api/beta/role-insights"},"items":[{"type":"doc","id":"api/beta/create-role-insight-requests","label":"A request to generate insights for roles","className":"api-method post"},{"type":"doc","id":"api/beta/get-role-insights-requests","label":"Returns the metadata for a request in order to generate insights for roles.","className":"api-method get"},{"type":"doc","id":"api/beta/get-role-insights-summary","label":"Get role insights summary information","className":"api-method get"},{"type":"doc","id":"api/beta/get-role-insights","label":"Get role insights","className":"api-method get"},{"type":"doc","id":"api/beta/get-role-insight","label":"Get a single role insight","className":"api-method get"},{"type":"doc","id":"api/beta/get-role-insights-entitlements-changes","label":"Get entitlement insights for a role","className":"api-method get"},{"type":"doc","id":"api/beta/download-role-insights-entitlements-changes","label":"Download entitlement insights for a role","className":"api-method get"},{"type":"doc","id":"api/beta/get-role-insights-current-entitlements","label":"Get current entitlement for a role","className":"api-method get"},{"type":"doc","id":"api/beta/get-entitlement-changes-identities","label":"Get identities for a suggested entitlement (for a role)","className":"api-method get"}]},{"type":"category","label":"Roles","link":{"type":"doc","id":"api/beta/roles"},"items":[{"type":"doc","id":"api/beta/list-roles","label":"List Roles","className":"api-method get"},{"type":"doc","id":"api/beta/create-role","label":"Create a Role","className":"api-method post"},{"type":"doc","id":"api/beta/get-role","label":"Get a Role","className":"api-method get"},{"type":"doc","id":"api/beta/patch-role","label":"Patch a specified Role","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-role","label":"Delete a Role","className":"api-method delete"},{"type":"doc","id":"api/beta/bulk-delete-roles","label":"Delete Role(s)","className":"api-method post"},{"type":"doc","id":"api/beta/get-role-assigned-identities","label":"Identities assigned a Role","className":"api-method get"}]},{"type":"category","label":"Search Attribute Configuration","link":{"type":"doc","id":"api/beta/search-attribute-configuration"},"items":[{"type":"doc","id":"api/beta/create-search-attribute-config","label":"Configure/create extended search attributes in IdentityNow.","className":"api-method post"},{"type":"doc","id":"api/beta/get-search-attribute-config","label":"Retrieve a list of extended search attributes in IdentityNow.","className":"api-method get"},{"type":"doc","id":"api/beta/get-single-search-attribute-config","label":"Get the details of a specific extended search attribute in IdentityNow.","className":"api-method get"},{"type":"doc","id":"api/beta/delete-search-attribute-config","label":"Delete an extended search attribute in IdentityNow.","className":"api-method delete"},{"type":"doc","id":"api/beta/patch-search-attribute-config","label":"Update the details of a specific extended search attribute in IdentityNow.","className":"api-method patch"}]},{"type":"category","label":"Segments","link":{"type":"doc","id":"api/beta/segments"},"items":[{"type":"doc","id":"api/beta/create-segment","label":"Create Segment","className":"api-method post"},{"type":"doc","id":"api/beta/list-segments","label":"List Segments","className":"api-method get"},{"type":"doc","id":"api/beta/get-segment","label":"Get a Segment by its ID","className":"api-method get"},{"type":"doc","id":"api/beta/delete-segment","label":"Delete Segment by ID","className":"api-method delete"},{"type":"doc","id":"api/beta/patch-segment","label":"Update a Segment","className":"api-method patch"}]},{"type":"category","label":"Service Desk Integration","link":{"type":"doc","id":"api/beta/service-desk-integration"},"items":[{"type":"doc","id":"api/beta/get-service-desk-integration-list","label":"List existing Service Desk Integrations","className":"api-method get"},{"type":"doc","id":"api/beta/create-service-desk-integration","label":"Create new Service Desk integration","className":"api-method post"},{"type":"doc","id":"api/beta/get-service-desk-integration","label":"Get a Service Desk integration","className":"api-method get"},{"type":"doc","id":"api/beta/put-service-desk-integration","label":"Update a Service Desk integration","className":"api-method put"},{"type":"doc","id":"api/beta/delete-service-desk-integration","label":"Delete a Service Desk integration","className":"api-method delete"},{"type":"doc","id":"api/beta/patch-service-desk-integration","label":"Service Desk Integration Update PATCH","className":"api-method patch"},{"type":"doc","id":"api/beta/get-service-desk-integration-types","label":"Service Desk Integration Types List.","className":"api-method get"},{"type":"doc","id":"api/beta/get-service-desk-integration-template","label":"Service Desk integration template by scriptName.","className":"api-method get"},{"type":"doc","id":"api/beta/get-status-check-details","label":"Get the time check configuration","className":"api-method get"},{"type":"doc","id":"api/beta/update-status-check-details","label":"Update the time check configuration","className":"api-method put"}]},{"type":"category","label":"SOD Policy","link":{"type":"doc","id":"api/beta/sod-policy"},"items":[{"type":"doc","id":"api/beta/create-sod-policy","label":"Create SOD policy","className":"api-method post"},{"type":"doc","id":"api/beta/list-sod-policies","label":"List SOD policies","className":"api-method get"},{"type":"doc","id":"api/beta/get-sod-policy","label":"Get SOD policy by ID","className":"api-method get"},{"type":"doc","id":"api/beta/update-sod-policy","label":"Update SOD policy by ID","className":"api-method put"},{"type":"doc","id":"api/beta/delete-sod-policy","label":"Delete SOD policy by ID","className":"api-method delete"},{"type":"doc","id":"api/beta/patch-sod-policy","label":"Patch a SOD policy","className":"api-method patch"},{"type":"doc","id":"api/beta/get-sod-policy-schedule","label":"Get SOD policy schedule","className":"api-method get"},{"type":"doc","id":"api/beta/update-policy-schedule","label":"Update SOD Policy schedule","className":"api-method put"},{"type":"doc","id":"api/beta/delete-sod-policy-schedule","label":"Delete SOD policy schedule","className":"api-method delete"},{"type":"doc","id":"api/beta/run-sod-policy","label":"Runs SOD policy violation report","className":"api-method post"},{"type":"doc","id":"api/beta/get-sod-violation-report-status","label":"Get SOD violation report status","className":"api-method get"},{"type":"doc","id":"api/beta/get-sod-violation-report-run-status","label":"Get violation report run status","className":"api-method get"},{"type":"doc","id":"api/beta/run-sod-all-policies-for-org","label":"Runs all policies for org","className":"api-method post"},{"type":"doc","id":"api/beta/get-sod-all-report-run-status","label":"Get multi-report run task status","className":"api-method get"},{"type":"doc","id":"api/beta/download-default-violation-report","label":"Download violation report","className":"api-method get"},{"type":"doc","id":"api/beta/download-custom-violation-report","label":"Download custom violation report","className":"api-method get"}]},{"type":"category","label":"SOD Violations","link":{"type":"doc","id":"api/beta/sod-violations"},"items":[{"type":"doc","id":"api/beta/predict-sod-violations","label":"Predict SOD violations for the given identity if they were granted the given access.","className":"api-method post"}]},{"type":"category","label":"Sources","link":{"type":"doc","id":"api/beta/sources"},"items":[{"type":"doc","id":"api/beta/list-sources","label":"Lists all sources in IdentityNow.","className":"api-method get"},{"type":"doc","id":"api/beta/create-source","label":"Creates a source in IdentityNow.","className":"api-method post"},{"type":"doc","id":"api/beta/get-source","label":"Get Source by ID","className":"api-method get"},{"type":"doc","id":"api/beta/put-source","label":"Update Source (Full)","className":"api-method put"},{"type":"doc","id":"api/beta/update-source","label":"Update Source (Partial)","className":"api-method patch"},{"type":"doc","id":"api/beta/delete","label":"Delete Source by ID","className":"api-method delete"},{"type":"doc","id":"api/beta/get-source-attr-sync-config","label":"Attribute Sync Config","className":"api-method get"},{"type":"doc","id":"api/beta/put-source-attr-sync-config","label":"Update Attribute Sync Config","className":"api-method put"},{"type":"doc","id":"api/beta/test-source-connection","label":"Check connection for source connector.","className":"api-method post"},{"type":"doc","id":"api/beta/peek-resource-objects","label":"Peek source connector's resource objects","className":"api-method post"},{"type":"doc","id":"api/beta/ping-cluster","label":"Ping cluster for source connector","className":"api-method post"},{"type":"doc","id":"api/beta/test-source-configuration","label":"Test configuration for source connector","className":"api-method post"},{"type":"doc","id":"api/beta/get-source-config","label":"Gets source config with language translations","className":"api-method get"},{"type":"doc","id":"api/beta/list-provisioning-policies","label":"Lists ProvisioningPolicies","className":"api-method get"},{"type":"doc","id":"api/beta/create-provisioning-policy","label":"Create Provisioning Policy","className":"api-method post"},{"type":"doc","id":"api/beta/get-provisioning-policy","label":"Get Provisioning Policy by UsageType","className":"api-method get"},{"type":"doc","id":"api/beta/put-provisioning-policy","label":"Update Provisioning Policy by UsageType","className":"api-method put"},{"type":"doc","id":"api/beta/update-provisioning-policy","label":"Partial update of Provisioning Policy","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-provisioning-policy","label":"Delete Provisioning Policy by UsageType","className":"api-method delete"},{"type":"doc","id":"api/beta/update-provisioning-policies-in-bulk","label":"Bulk Update Provisioning Policies","className":"api-method post"},{"type":"doc","id":"api/beta/list-source-schemas","label":"Lists the Schemas that exist on the specified Source in IdentityNow.","className":"api-method get"},{"type":"doc","id":"api/beta/create-source-schema","label":"Creates a new Schema on the specified Source in IdentityNow.","className":"api-method post"},{"type":"doc","id":"api/beta/get-source-schema","label":"Get Source Schema by ID","className":"api-method get"},{"type":"doc","id":"api/beta/put-source-schema","label":"Update Source Schema (Full)","className":"api-method put"},{"type":"doc","id":"api/beta/update-source-schema","label":"Update Source Schema (Partial)","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-source-schema","label":"Delete Source Schema by ID","className":"api-method delete"},{"type":"doc","id":"api/beta/get-source-accounts-schema","label":"Downloads source accounts schema template","className":"api-method get"},{"type":"doc","id":"api/beta/import-source-accounts-schema","label":"Uploads source accounts schema template","className":"api-method post"},{"type":"doc","id":"api/beta/get-source-entitlements-schema","label":"Downloads source entitlements schema template","className":"api-method get"},{"type":"doc","id":"api/beta/import-source-entitlements-schema","label":"Uploads source entitlements schema template","className":"api-method post"},{"type":"doc","id":"api/beta/import-source-connector-file","label":"Upload connector file to source","className":"api-method post"},{"type":"doc","id":"api/beta/sync-attributes-for-source","label":"Synchronize single source attributes.","className":"api-method post"},{"type":"doc","id":"api/beta/get-source-entitlement-request-config","label":"Get Source Entitlement Request Configuration","className":"api-method get"},{"type":"doc","id":"api/beta/update-source-entitlement-request-config","label":"Update Source Entitlement Request Configuration","className":"api-method put"}]},{"type":"category","label":"SP-Config","link":{"type":"doc","id":"api/beta/sp-config"},"items":[{"type":"doc","id":"api/beta/export-sp-config","label":"Initiates configuration objects export job","className":"api-method post"},{"type":"doc","id":"api/beta/get-sp-config-export-status","label":"Get export job status","className":"api-method get"},{"type":"doc","id":"api/beta/get-sp-config-export","label":"Download export job result.","className":"api-method get"},{"type":"doc","id":"api/beta/import-sp-config","label":"Initiates configuration objects import job","className":"api-method post"},{"type":"doc","id":"api/beta/get-sp-config-import-status","label":"Get import job status","className":"api-method get"},{"type":"doc","id":"api/beta/get-sp-config-import","label":"Download import job result","className":"api-method get"},{"type":"doc","id":"api/beta/list-sp-config-objects","label":"Get config object details","className":"api-method get"}]},{"type":"category","label":"Tagged Objects","link":{"type":"doc","id":"api/beta/tagged-objects"},"items":[{"type":"doc","id":"api/beta/list-tagged-objects","label":"List Tagged Objects","className":"api-method get"},{"type":"doc","id":"api/beta/add-tag-to-object","label":"Add Tag to Object","className":"api-method post"},{"type":"doc","id":"api/beta/list-tagged-objects-by-type","label":"List Tagged Objects","className":"api-method get"},{"type":"doc","id":"api/beta/get-tagged-object","label":"Get Tagged Object","className":"api-method get"},{"type":"doc","id":"api/beta/update-tagged-object","label":"Update Tagged Object","className":"api-method put"},{"type":"doc","id":"api/beta/delete-tagged-object","label":"Delete Tagged Object","className":"api-method delete"},{"type":"doc","id":"api/beta/add-tags-to-many-objects","label":"Tag Multiple Objects","className":"api-method post"},{"type":"doc","id":"api/beta/remove-tags-to-many-object","label":"Remove Tags from Multiple Objects","className":"api-method post"}]},{"type":"category","label":"Transforms","link":{"type":"doc","id":"api/beta/transforms"},"items":[{"type":"doc","id":"api/beta/list-transforms","label":"List transforms","className":"api-method get"},{"type":"doc","id":"api/beta/create-transform","label":"Create transform","className":"api-method post"},{"type":"doc","id":"api/beta/get-transform","label":"Transform by ID","className":"api-method get"},{"type":"doc","id":"api/beta/update-transform","label":"Update a transform","className":"api-method put"},{"type":"doc","id":"api/beta/delete-transform","label":"Delete a transform","className":"api-method delete"}]},{"type":"category","label":"Triggers","link":{"type":"doc","id":"api/beta/triggers"},"items":[{"type":"doc","id":"api/beta/list-triggers","label":"List Triggers","className":"api-method get"},{"type":"doc","id":"api/beta/create-subscription","label":"Create a Subscription","className":"api-method post"},{"type":"doc","id":"api/beta/list-subscriptions","label":"List Subscriptions","className":"api-method get"},{"type":"doc","id":"api/beta/update-subscription","label":"Update a Subscription","className":"api-method put"},{"type":"doc","id":"api/beta/patch-subscription","label":"Patch a Subscription","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-subscription","label":"Delete a Subscription","className":"api-method delete"},{"type":"doc","id":"api/beta/test-subscription-filter","label":"Validate a Subscription Filter","className":"api-method post"},{"type":"doc","id":"api/beta/list-trigger-invocation-status","label":"List Latest Invocation Statuses","className":"api-method get"},{"type":"doc","id":"api/beta/complete-trigger-invocation","label":"Complete Trigger Invocation","className":"api-method post"},{"type":"doc","id":"api/beta/start-test-trigger-invocation","label":"Start a Test Invocation","className":"api-method post"}]},{"type":"category","label":"Work Items","link":{"type":"doc","id":"api/beta/work-items"},"items":[{"type":"doc","id":"api/beta/list-work-items","label":"List Work Items","className":"api-method get"},{"type":"doc","id":"api/beta/get-completed-work-items","label":"Completed Work Items","className":"api-method get"},{"type":"doc","id":"api/beta/get-count-work-items","label":"Count Work Items","className":"api-method get"},{"type":"doc","id":"api/beta/get-count-completed-work-items","label":"Count Completed Work Items","className":"api-method get"},{"type":"doc","id":"api/beta/get-work-items-summary","label":"Work Items Summary","className":"api-method get"},{"type":"doc","id":"api/beta/get-work-item","label":"Get a Work Item","className":"api-method get"},{"type":"doc","id":"api/beta/complete-work-item","label":"Complete a Work Item","className":"api-method post"},{"type":"doc","id":"api/beta/forward-work-item","label":"Forward a Work Item","className":"api-method post"},{"type":"doc","id":"api/beta/approve-approval-item","label":"Approve an Approval Item","className":"api-method post"},{"type":"doc","id":"api/beta/reject-approval-item","label":"Reject an Approval Item","className":"api-method post"},{"type":"doc","id":"api/beta/approve-approval-items-in-bulk","label":"Bulk approve Approval Items","className":"api-method post"},{"type":"doc","id":"api/beta/reject-approval-items-in-bulk","label":"Bulk reject Approval Items","className":"api-method post"},{"type":"doc","id":"api/beta/submit-account-selection","label":"Submit Account Selections","className":"api-method post"}]},{"type":"category","label":"Workflows","link":{"type":"doc","id":"api/beta/workflows"},"items":[{"type":"doc","id":"api/beta/create-workflow","label":"Create Workflow","className":"api-method post"},{"type":"doc","id":"api/beta/list-workflows","label":"List Workflows","className":"api-method get"},{"type":"doc","id":"api/beta/get-workflow","label":"Get Workflow By Id","className":"api-method get"},{"type":"doc","id":"api/beta/update-workflow","label":"Update Workflow","className":"api-method put"},{"type":"doc","id":"api/beta/patch-workflow","label":"Patch Workflow","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-workflow","label":"Delete Workflow By Id","className":"api-method delete"},{"type":"doc","id":"api/beta/test-workflow","label":"Test Workflow By Id","className":"api-method post"},{"type":"doc","id":"api/beta/list-workflow-executions","label":"List Workflow Executions","className":"api-method get"},{"type":"doc","id":"api/beta/get-workflow-execution","label":"Get a Workflow Execution","className":"api-method get"},{"type":"doc","id":"api/beta/get-workflow-execution-history","label":"Get Workflow Execution History","className":"api-method get"},{"type":"doc","id":"api/beta/cancel-workflow-execution","label":"Cancel Workflow Execution by ID","className":"api-method post"},{"type":"doc","id":"api/beta/list-complete-workflow-library","label":"List Complete Workflow Library","className":"api-method get"},{"type":"doc","id":"api/beta/list-workflow-library-actions","label":"List Workflow Library Actions","className":"api-method get"},{"type":"doc","id":"api/beta/list-workflow-library-triggers","label":"List Workflow Library Triggers","className":"api-method get"},{"type":"doc","id":"api/beta/list-workflow-library-operators","label":"List Workflow Library Operators","className":"api-method get"},{"type":"doc","id":"api/beta/post-workflow-external-trigger","label":"Generate External Trigger OAuth Client","className":"api-method post"},{"type":"doc","id":"api/beta/post-external-execute-workflow","label":"Execute Workflow via External Trigger","className":"api-method post"},{"type":"doc","id":"api/beta/test-external-execute-workflow","label":"Test Workflow via External Trigger","className":"api-method post"}]},{"type":"category","label":"Work Reassignment","items":[{"type":"doc","id":"api/beta/get-reassignment-config-types","label":"List Reassignment Config Types","className":"api-method get"},{"type":"doc","id":"api/beta/list-reassignment-configurations","label":"List Reassignment Configurations","className":"api-method get"},{"type":"doc","id":"api/beta/create-reassignment-configuration","label":"Create a Reassignment Configuration","className":"api-method post"},{"type":"doc","id":"api/beta/get-reassignment-configuration","label":"Get Reassignment Configuration","className":"api-method get"},{"type":"doc","id":"api/beta/put-reassignment-config","label":"Update Reassignment Configuration","className":"api-method put"},{"type":"doc","id":"api/beta/delete-reassignment-configuration","label":"Delete Reassignment Configuration","className":"api-method delete"},{"type":"doc","id":"api/beta/get-evaluate-reassignment-configuration","label":"Evaluate Reassignment Configuration","className":"api-method get"},{"type":"doc","id":"api/beta/get-tenant-config-configuration","label":"Get Tenant-wide Reassignment Configuration settings","className":"api-method get"},{"type":"doc","id":"api/beta/put-tenant-configuration","label":"Update Tenant-wide Reassignment Configuration settings","className":"api-method put"}]}]; \ No newline at end of file diff --git a/products/idn/api/beta/sod-policy.tag.mdx b/products/idn/api/beta/sod-policy.tag.mdx new file mode 100644 index 000000000..4736e94d2 --- /dev/null +++ b/products/idn/api/beta/sod-policy.tag.mdx @@ -0,0 +1,20 @@ +--- +id: sod-policy +title: "SOD Policy" +description: "SOD Policy" +custom_edit_url: null +--- + + + +Operations for Creating & Executing SOD (Seperation of Duties) policies + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/sod-violations.tag.mdx b/products/idn/api/beta/sod-violations.tag.mdx new file mode 100644 index 000000000..ef462d139 --- /dev/null +++ b/products/idn/api/beta/sod-violations.tag.mdx @@ -0,0 +1,20 @@ +--- +id: sod-violations +title: "SOD Violations" +description: "SOD Violations" +custom_edit_url: null +--- + + + +Operations for Predicting SOD (Seperation of Duties) violations + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/sources.tag.mdx b/products/idn/api/beta/sources.tag.mdx new file mode 100644 index 000000000..e324d6216 --- /dev/null +++ b/products/idn/api/beta/sources.tag.mdx @@ -0,0 +1,77 @@ +--- +id: sources +title: "Sources" +description: "Sources" +custom_edit_url: null +--- + + + +Use this API to implement and customize source functionality. +With source functionality in place, organizations can use IdentityNow to connect their various sources and user data sets and manage access across all those different sources in a secure, scalable way. + +[Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) refer to the IdentityNow representations for external applications, databases, and directory management systems that maintain their own sets of users, like Dropbox, GitHub, and Workday, for example. +Organizations may use hundreds, if not thousands, of different source systems, and any one employee within an organization likely has a different user record on each source, often with different permissions on many of those records. +Connecting these sources to IdentityNow makes it possible to manage user access across them all. +Then, if a new hire starts at an organization, IdentityNow can grant the new hire access to all the sources they need. +If an employee moves to a new department and needs access to new sources but no longer needs access to others, IdentityNow can grant the necessary access and revoke the unnecessary access for all the employee's various sources. +If an employee leaves the company, IdentityNow can revoke access to all the employee's various source accounts immediately. +These are just a few examples of the many ways that source functionality makes identity governance easier, more efficient, and more secure. + +In IdentityNow, administrators can create configure, manage, and edit sources, and they can designate other users as source admins to be able to do so. +They can also designate users as source sub-admins, who can perform the same source actions but only on sources associated with their governance groups. +Admins go to Connections > Sources to see a list of the existing source representations in their organizations. +They can create new sources or select existing ones. + +To create a new source, the following must be specified: Source Name, Description, Source Owner, and Connection Type. +Refer to [Configuring a Source](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html#configuring-a-source) for more information about the source configuration process. + +IdentityNow connects with its sources either by a direct communication with the source server (connection information specific to the source must be provided) or a flat file feed, a CSV file containing all the relevant information about the accounts to be loaded in. +Different sources use different connectors to share data with IdentityNow, and each connector's setup process is specific to that connector. +SailPoint has built a number of connectors to come out of the box and connect to the most common sources, and SailPoint actively maintains these connectors. +Refer to [IdentityNow Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about these SailPoint supported connectors. +Refer to the following links for more information about two useful connectors: + +- [JDBC Connector](https://documentation.sailpoint.com/connectors/jdbc/help/integrating_jdbc/introduction.html): This customizable connector an directly connect to databases that support JDBC (Java Database Connectivity). + +- [Web Services Connector](https://documentation.sailpoint.com/connectors/webservices/help/integrating_webservices/introduction.html): This connector can directly connect to databases that support Web Services. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/idn/docs/saas-connectivity) for more information about SailPoint's new connectivity framework that makes it easy to build and manage custom connectors to SaaS sources. + +When admins select existing sources, they can view the following information about the source: + +- Associated connections (any associated identity profiles, apps, or references to the source in a transform). + +- Associated user accounts. These accounts are linked to their identities - this provides a more complete picture of each user's access across sources. + +- Associated entitlements (sets of access rights on sources). + +- Associated access profiles (groupings of entitlements). + +The user account data and the entitlements update with each data aggregation from the source. +Organizations generally run scheduled, automated data aggregations to ensure that their data is always in sync between their sources and their IdentityNow tenants so an access change on a source is detected quickly in IdentityNow. +Admins can view a history of these aggregations, and they can also run manual imports. +Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about manual and scheduled aggregations. + +Admins can also make changes to determine which user account data IdentityNow collects from the source and how it correlates that account data with identity data. +To define which account attributes the source shares with IdentityNow, admins can edit the account schema on the source. +Refer to [Managing Source Account Schemas](https://documentation.sailpoint.com/saas/help/accounts/schema.html) for more information about source account schemas and how to edit them. +To define the mapping between the source account attributes and their correlating identity attributes, admins can edit the correlation configuration on the source. +Refer to [Assigning Source Accounts to Identities](https://documentation.sailpoint.com/saas/help/accounts/correlation.html) for more information about this correlation process between source accounts and identities. + +Admins can also delete sources, but they must first ensure that the sources no longer have any active connections: the source must not be associated with any identity profile or any app, and it must not be referenced by any transform. +Refer to [Deleting Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html#deleting-sources) for more information about deleting sources. + +Well organized, mappped out connections between sources and IdentityNow are essential to achieving comprehensive identity access governance across all the source systems organizations need. +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about all the different things admins can do with sources once they are connected. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/sp-config.tag.mdx b/products/idn/api/beta/sp-config.tag.mdx new file mode 100644 index 000000000..122e290dc --- /dev/null +++ b/products/idn/api/beta/sp-config.tag.mdx @@ -0,0 +1,20 @@ +--- +id: sp-config +title: "SP-Config" +description: "SP-Config" +custom_edit_url: null +--- + + + +Import and export configuration for some objects between tenants. + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/start-campaign.api.mdx b/products/idn/api/beta/start-campaign.api.mdx new file mode 100644 index 000000000..7df04fc31 --- /dev/null +++ b/products/idn/api/beta/start-campaign.api.mdx @@ -0,0 +1,96 @@ +--- +id: start-campaign +sidebar_label: Activate a Campaign +hide_title: true +hide_table_of_contents: true +api: {"operationId":"startCampaign","tags":["Certification Campaigns"],"description":"Submits a job to activate the campaign with the given Id. The campaign must be staged.\nRequires roles of CERT_ADMIN and ORG_ADMIN","security":[{"oauth2":["idn:campaign:update"]}],"deprecated":true,"requestBody":{"description":"Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format.","required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"timeZone":{"type":"string","description":"The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as 'Z') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh.","default":"Z","example":"-05:00"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The campaign id","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/campaigns/{id}/activate","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"timeZone":"-05:00"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Activate a Campaign","description":{"content":"Submits a job to activate the campaign with the given Id. The campaign must be staged.\nRequires roles of CERT_ADMIN and ORG_ADMIN","type":"text/plain"},"url":{"path":["campaigns",":id","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The campaign id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Activate a Campaign' (start-campaign)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Activate a Campaign + +:::caution deprecated + +This endpoint has been deprecated and may be removed in future versions of the API. + +::: + +Submits a job to activate the campaign with the given Id. The campaign must be staged. +Requires roles of CERT_ADMIN and ORG_ADMIN + +
Path Parameters
Request Body
+ +Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. + +
+ +Accepted - Returned if the request was successfully accepted into the system. + +
Schema
  • object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/start-identity-processing.api.mdx b/products/idn/api/beta/start-identity-processing.api.mdx new file mode 100644 index 000000000..7bf41c83f --- /dev/null +++ b/products/idn/api/beta/start-identity-processing.api.mdx @@ -0,0 +1,95 @@ +--- +id: start-identity-processing +sidebar_label: Process a list of identityIds +hide_title: true +hide_table_of_contents: true +api: {"operationId":"startIdentityProcessing","tags":["Identities"],"description":"You could use this endpoint to:\n1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it's expected to change).\n2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles.\n3. Enforce provisioning for any assigned accesses that haven't been fulfilled (e.g. failure due to source health).\n4. Recalculate manager relationships.\n5. Potentially clean-up identity processing errors, assuming the error has been resolved.\n\nTo learn more, refer to the [identity processing documentation](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html).\n","security":[{"oauth2":["idn:identity:manage"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityIds":{"type":"array","minItems":1,"maxItems":250,"description":"List of up to 250 identity IDs to process.","items":{"type":"string","example":"ef38f94347e94562b5bb8424a56397d8"}}}}}}},"responses":{"202":{"description":"Object containing the DTO type TASK_RESULT and the job id for the task","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"the application ID","example":"ff8081814d977c21014da056804a0af3"},"name":{"type":"string","description":"the application name","example":"Github"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/identities/process","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"identityIds":["ef38f94347e94562b5bb8424a56397d8"]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Process a list of identityIds","description":{"content":"You could use this endpoint to:\n1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it's expected to change).\n2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles.\n3. Enforce provisioning for any assigned accesses that haven't been fulfilled (e.g. failure due to source health).\n4. Recalculate manager relationships.\n5. Potentially clean-up identity processing errors, assuming the error has been resolved.\n\nTo learn more, refer to the [identity processing documentation](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html).\n","type":"text/plain"},"url":{"path":["identities","process"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Process a list of identityIds' (start-identity-processing)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Process a list of identityIds + + + +You could use this endpoint to: +1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it's expected to change). +2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. +3. Enforce provisioning for any assigned accesses that haven't been fulfilled (e.g. failure due to source health). +4. Recalculate manager relationships. +5. Potentially clean-up identity processing errors, assuming the error has been resolved. + +To learn more, refer to the [identity processing documentation](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html). + + +
Request Body required
    = 1`, `<= 250`"} defaultValue={undefined}>
+ +Object containing the DTO type TASK_RESULT and the job id for the task + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 404 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/start-test-trigger-invocation.api.mdx b/products/idn/api/beta/start-test-trigger-invocation.api.mdx new file mode 100644 index 000000000..39b863e48 --- /dev/null +++ b/products/idn/api/beta/start-test-trigger-invocation.api.mdx @@ -0,0 +1,79 @@ +--- +id: start-test-trigger-invocation +sidebar_label: Start a Test Invocation +hide_title: true +hide_table_of_contents: true +api: {"operationId":"startTestTriggerInvocation","tags":["Triggers"],"description":"Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"triggerId":{"type":"string","example":"idn:access-request-post-approval","description":"Trigger ID"},"input":{"type":"object","example":{"identityId":"201327fda1c44704ac01181e963d463c"},"description":"Mock input to use for test invocation. This must adhere to the input schema defined in the trigger being invoked. If this property is omitted, then the default trigger sample payload will be sent."},"contentJson":{"type":"object","example":{"workflowId":1234},"description":"JSON map of invocation metadata."},"subscriptionIds":{"type":"array","items":{"type":"string"},"example":["0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"],"description":"Only send the test event to the subscription IDs listed. If omitted, the test event will be sent to all subscribers."}},"required":["triggerId","contentJson"]},"examples":{"Test Trigger with Mock Input":{"value":{"triggerId":"idn:access-requested","input":{"identityId":"201327fda1c44704ac01181e963d463c"},"contentJson":{"workflowId":1234}}},"Send Test to only One Subscriber":{"value":{"triggerId":"idn:access-requested","contentJson":{"workflowId":1234},"subscriptionIds":["0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"]}}}}}},"responses":{"200":{"description":"Test trigger invocations that have been started for specified subscription(s).","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Invocation ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"triggerId":{"type":"string","description":"Trigger ID","example":"idn:access-requested"},"secret":{"type":"string","description":"Unique invocation secret.","example":"0f979022-08be-44f2-b6f9-7393ec73ed9b"},"contentJson":{"type":"object","example":{"workflowId":1234},"description":"JSON map of invocation metadata."}}}}}}},"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["sp:trigger-service-invocation-status:manage"]}],"method":"post","path":"/trigger-invocations/test","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"triggerId":"idn:access-request-post-approval","input":{"identityId":"201327fda1c44704ac01181e963d463c"},"contentJson":{"workflowId":1234},"subscriptionIds":["0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Start a Test Invocation","description":{"content":"Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent.","type":"text/plain"},"url":{"path":["trigger-invocations","test"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Start a Test Invocation' (start-test-trigger-invocation)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Start a Test Invocation + + + +Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. + +
Request Body required
+ +Test trigger invocations that have been started for specified subscription(s). + +
Schema array
+ +No content - indicates the request was successful but there is no content to be returned in the response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 403 response object

+ +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. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
    causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

An example of a 500 response object

\ No newline at end of file diff --git a/products/idn/api/beta/submit-account-selection.api.mdx b/products/idn/api/beta/submit-account-selection.api.mdx new file mode 100644 index 000000000..83abdea5f --- /dev/null +++ b/products/idn/api/beta/submit-account-selection.api.mdx @@ -0,0 +1,71 @@ +--- +id: submit-account-selection +sidebar_label: Submit Account Selections +hide_title: true +hide_table_of_contents: true +api: {"operationId":"submitAccountSelection","tags":["Work Items"],"description":"This API submits account selections. Either an admin, or the owning/current user must make this request.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the work item","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"fieldName":"fieldValue"}}},"description":"Account Selection Data map, keyed on fieldName"},"responses":{"200":{"description":"A work items details object.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the work item","example":"2c9180835d2e5168015d32f890ca1581"},"requesterId":{"type":"string","description":"ID of the requester","example":"2c9180835d2e5168015d32f890ca1581"},"requesterDisplayName":{"type":"string","description":"The displayname of the requester","example":"John Smith"},"ownerId":{"type":"string","description":"The ID of the owner","example":"2c9180835d2e5168015d32f890ca1581"},"ownerName":{"type":"string","description":"The name of the owner","example":"Jason Smith"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z"},"description":{"type":"string","description":"The description of the work item","example":"Create account on source 'AD'"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"},"type":{"type":"string","enum":["UNKNOWN","GENERIC","CERTIFICATION","REMEDIATION","DELEGATION","APPROVAL","VIOLATIONREVIEW","FORM","POLICYVIOLATION","CHALLENGE","IMPACTANALYSIS","SIGNOFF","EVENT","MANUALACTION","TEST"],"example":"GENERIC","description":"The type of the work item"},"remediationItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the certification","example":"2c9180835d2e5168015d32f890ca1581"},"targetId":{"type":"string","description":"The ID of the certification target","example":"2c9180835d2e5168015d32f890ca1581"},"targetName":{"type":"string","description":"The name of the certification target","example":"john.smith"},"targetDisplayName":{"type":"string","description":"The display name of the certification target","example":"emailAddress"},"applicationName":{"type":"string","description":"The name of the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute being certified","example":"phoneNumber"},"attributeOperation":{"type":"string","description":"The operation of the certification on the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute being certified","example":"512-555-1212"},"nativeIdentity":{"type":"string","description":"The native identity of the target","example":"jason.smith2"}}},"approvalItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the approval item","example":"2c9180835d2e5168015d32f890ca1581"},"account":{"type":"string","description":"The account referenced by the approval item","example":"john.smith"},"application":{"type":"string","description":"The name the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute","example":"emailAddress"},"attributeOperation":{"type":"string","description":"The operation of the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute","example":"a@b.com"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"}}},"name":{"type":"string","description":"The work item name","example":"Account Create"},"completed":{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z"},"numItems":{"type":"integer","description":"The number of items in the work item","example":19},"errors":{"type":"array","items":{"type":"string"},"example":["The work item ID that was specified was not found."]}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}}},"method":"post","path":"/work-items/{id}/submit-account-selection","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Submit Account Selections","description":{"content":"This API submits account selections. Either an admin, or the owning/current user must make this request.","type":"text/plain"},"url":{"path":["work-items",":id","submit-account-selection"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the work item","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Submit Account Selections' (submit-account-selection)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Submit Account Selections + + + +This API submits account selections. Either an admin, or the owning/current user must make this request. + +
Path Parameters
Request Body required
+ +Account Selection Data map, keyed on fieldName + +
    + +A work items details object. + +
    Schema
      remediationItems object
      approvalItems object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/sync-attributes-for-source.api.mdx b/products/idn/api/beta/sync-attributes-for-source.api.mdx new file mode 100644 index 000000000..2d5835b80 --- /dev/null +++ b/products/idn/api/beta/sync-attributes-for-source.api.mdx @@ -0,0 +1,92 @@ +--- +id: sync-attributes-for-source +sidebar_label: Synchronize single source attributes. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"syncAttributesForSource","tags":["Sources"],"description":"This end-point performs attribute synchronization for a selected source.\nA token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Source id"}],"responses":{"202":{"description":"A Source Sync job","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Job ID.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"status":{"type":"string","description":"The job status.","enum":["QUEUED","IN_PROGRESS","SUCCESS","ERROR"],"example":"IN_PROGRESS"},"payload":{"description":"Job payload.","example":{"type":"SYNCHRONIZE_SOURCE_ATTRIBUTES","dataJson":"{\"sourceId\":\"2c918083746f642c01746f990884012a\"}"},"type":"object","properties":{"type":{"type":"string","description":"Payload type.","example":"SYNCHRONIZE_SOURCE_ATTRIBUTES"},"dataJson":{"type":"string","description":"Payload type.","example":"{\"sourceId\":\"2c918083746f642c01746f990884012a\"}"}},"required":["type","dataJson"]}},"required":["id","status","payload"]},"example":{"id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","status":"IN_PROGRESS","payload":{"type":"SYNCHRONIZE_SOURCE_ATTRIBUTES","dataJson":"{\"sourceId\":\"2c918083746f642c01746f990884012a\"}"}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sources/{id}/synchronize-attributes","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Synchronize single source attributes.","description":{"content":"This end-point performs attribute synchronization for a selected source.\nA token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":id","synchronize-attributes"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Synchronize single source attributes.' (sync-attributes-for-source)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Synchronize single source attributes. + + + +This end-point performs attribute synchronization for a selected source. +A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API. + +
    Path Parameters
    + +A Source Sync job + +
    Schema
      payload object
      + +Job payload. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/synchronize-attributes-for-identity.api.mdx b/products/idn/api/beta/synchronize-attributes-for-identity.api.mdx new file mode 100644 index 000000000..0b6065d77 --- /dev/null +++ b/products/idn/api/beta/synchronize-attributes-for-identity.api.mdx @@ -0,0 +1,91 @@ +--- +id: synchronize-attributes-for-identity +sidebar_label: Attribute synchronization for single identity. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"synchronizeAttributesForIdentity","tags":["Identities"],"description":"This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. A token with ORG_ADMIN or API authority is required to call this API.","parameters":[{"in":"path","name":"identityId","schema":{"type":"string"},"required":true,"description":"The Identity id"}],"responses":{"202":{"description":"An Identity Sync job","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Job ID.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"status":{"type":"string","description":"The job status.","enum":["QUEUED","IN_PROGRESS","SUCCESS","ERROR"],"example":"IN_PROGRESS"},"payload":{"description":"Job payload.","example":{"type":"SYNCHRONIZE_IDENTITY_ATTRIBUTES","dataJson":"{\"identityId\":\"2c918083746f642c01746f990884012a\"}"},"type":"object","properties":{"type":{"type":"string","description":"Payload type.","example":"SYNCHRONIZE_IDENTITY_ATTRIBUTES"},"dataJson":{"type":"string","description":"Payload type.","example":"{\"identityId\":\"2c918083746f642c01746f990884012a\"}"}},"required":["type","dataJson"]}},"required":["id","status","payload"]},"example":{"id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3dfc","status":"IN_PROGRESS","payload":{"type":"SYNCHRONIZE_IDENTITY_ATTRIBUTES","dataJson":"{\"identityId\":\"2c918083746f642c01746f990884012a\"}"}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/identities/{identityId}/synchronize-attributes","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Attribute synchronization for single identity.","description":{"content":"This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. A token with ORG_ADMIN or API authority is required to call this API.","type":"text/plain"},"url":{"path":["identities",":identityId","synchronize-attributes"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Identity id","type":"text/plain"},"type":"any","value":"","key":"identityId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Attribute synchronization for single identity.' (synchronize-attributes-for-identity)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Attribute synchronization for single identity. + + + +This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. A token with ORG_ADMIN or API authority is required to call this API. + +
    Path Parameters
    + +An Identity Sync job + +
    Schema
      payload object
      + +Job payload. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/tagged-objects.tag.mdx b/products/idn/api/beta/tagged-objects.tag.mdx new file mode 100644 index 000000000..f3476c34c --- /dev/null +++ b/products/idn/api/beta/tagged-objects.tag.mdx @@ -0,0 +1,16 @@ +--- +id: tagged-objects +title: "Tagged Objects" +description: "Tagged Objects" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/test-external-execute-workflow.api.mdx b/products/idn/api/beta/test-external-execute-workflow.api.mdx new file mode 100644 index 000000000..a97f2aef1 --- /dev/null +++ b/products/idn/api/beta/test-external-execute-workflow.api.mdx @@ -0,0 +1,75 @@ +--- +id: test-external-execute-workflow +sidebar_label: Test Workflow via External Trigger +hide_title: true +hide_table_of_contents: true +api: {"operationId":"testExternalExecuteWorkflow","tags":["Workflows"],"description":"Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow.","security":[{"oauth2":["sp:workflow-execute:external"]}],"parameters":[{"name":"id","in":"path","description":"Id of the workflow","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"input":{"type":"object","description":"The test input for the workflow","example":{"test":"hello world"}}}}}}},"responses":{"200":{"description":"Responds with the test input","content":{"application/json":{"schema":{"type":"object","properties":{"payload":{"type":"object","description":"The input that was received","example":{"test":"hello world"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/workflows/execute/external/{id}/test","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"input":{"test":"hello world"}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Test Workflow via External Trigger","description":{"content":"Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow.","type":"text/plain"},"url":{"path":["workflows","execute","external",":id","test"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the workflow","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Test Workflow via External Trigger' (test-external-execute-workflow)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Test Workflow via External Trigger + + + +Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. + +
    Path Parameters
    Request Body
    + +Responds with the test input + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/test-mfa-config.api.mdx b/products/idn/api/beta/test-mfa-config.api.mdx new file mode 100644 index 000000000..6aa1d4114 --- /dev/null +++ b/products/idn/api/beta/test-mfa-config.api.mdx @@ -0,0 +1,76 @@ +--- +id: test-mfa-config +sidebar_label: MFA method's test configuration +hide_title: true +hide_table_of_contents: true +api: {"operationId":"testMFAConfig","tags":["MFA Configuration"],"description":"This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter.\nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:mfa-configuration:read","idn:mfa-configuration:manage"]}],"parameters":[{"in":"path","name":"method","schema":{"type":"string","example":"okta-verify"},"required":true,"description":"The name of the MFA method. The currently supported method name is okta-verify."}],"responses":{"200":{"description":"The result of configuration test for the MFA provider.","content":{"application/json":{"schema":{"description":"Response model for configuration test of a given MFA method","type":"object","properties":{"state":{"type":"string","enum":["SUCCESS","FAILED"],"description":"The configuration test result.","example":"SUCCESS","readOnly":true},"error":{"type":"string","example":"MFA Method is disabled.","description":"The error message to indicate the failure of configuration test.","readOnly":true}}},"example":{"state":"SUCCESS","error":null}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/mfa/{method}/test","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"MFA method's test configuration","description":{"content":"This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["mfa",":method","test"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The name of the MFA method. The currently supported method name is okta-verify.","type":"text/plain"},"type":"any","value":"","key":"method"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'MFA method's test configuration' (test-mfa-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## MFA method's test configuration + + + +This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. +A token with ORG_ADMIN authority is required to call this API. + +
    Path Parameters
    + +The result of configuration test for the MFA provider. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/test-source-configuration.api.mdx b/products/idn/api/beta/test-source-configuration.api.mdx new file mode 100644 index 000000000..2bf920131 --- /dev/null +++ b/products/idn/api/beta/test-source-configuration.api.mdx @@ -0,0 +1,88 @@ +--- +id: test-source-configuration +sidebar_label: Test configuration for source connector +hide_title: true +hide_table_of_contents: true +api: {"operationId":"testSourceConfiguration","tags":["Sources"],"description":"This endpoint performs a more detailed validation of the source's configuration that can take longer than the lighter weight credential validation performed by the checkConnection API.\nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:source-connector:manage"]}],"parameters":[{"in":"path","name":"sourceId","schema":{"type":"string"},"required":true,"description":"The ID of the Source","example":"cef3ee201db947c5912551015ba0c679"}],"responses":{"200":{"description":"The result of testing source connector configuration with response from it.","content":{"application/json":{"schema":{"type":"object","title":"Status Response","description":"Response model for connection check, configuration test and ping of source connectors.","properties":{"id":{"type":"string","description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313","readOnly":true},"name":{"type":"string","description":"Name of the source","example":"ODS-AD-Test [source-999999]","readOnly":true},"status":{"type":"string","enum":["SUCCESS","FAILURE"],"description":"The status of the health check.","example":"SUCCESS","readOnly":true},"elapsedMillis":{"type":"integer","description":"The number of milliseconds spent on the entire request.","example":1000,"readOnly":true},"details":{"type":"object","description":"The document contains the results of the health check.\nThe schema of this document depends on the type of source used.\n","readOnly":true,"example":{"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"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sources/{sourceId}/connector/test-configuration","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Test configuration for source connector","description":{"content":"This endpoint performs a more detailed validation of the source's configuration that can take longer than the lighter weight credential validation performed by the checkConnection API.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":sourceId","connector","test-configuration"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the Source","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Test configuration for source connector' (test-source-configuration)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Test configuration for source connector + + + +This endpoint performs a more detailed validation of the source's configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. +A token with ORG_ADMIN authority is required to call this API. + +
    Path Parameters
    + +The result of testing source connector configuration with response from it. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/test-source-connection.api.mdx b/products/idn/api/beta/test-source-connection.api.mdx new file mode 100644 index 000000000..846ec147f --- /dev/null +++ b/products/idn/api/beta/test-source-connection.api.mdx @@ -0,0 +1,88 @@ +--- +id: test-source-connection +sidebar_label: Check connection for source connector. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"testSourceConnection","tags":["Sources"],"description":"This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter.\nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:source-connector:manage"]}],"parameters":[{"in":"path","name":"sourceId","schema":{"type":"string"},"required":true,"description":"The ID of the Source.","example":"cef3ee201db947c5912551015ba0c679"}],"responses":{"200":{"description":"The result of checking connection to the source connector with response from it.","content":{"application/json":{"schema":{"type":"object","title":"Status Response","description":"Response model for connection check, configuration test and ping of source connectors.","properties":{"id":{"type":"string","description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313","readOnly":true},"name":{"type":"string","description":"Name of the source","example":"ODS-AD-Test [source-999999]","readOnly":true},"status":{"type":"string","enum":["SUCCESS","FAILURE"],"description":"The status of the health check.","example":"SUCCESS","readOnly":true},"elapsedMillis":{"type":"integer","description":"The number of milliseconds spent on the entire request.","example":1000,"readOnly":true},"details":{"type":"object","description":"The document contains the results of the health check.\nThe schema of this document depends on the type of source used.\n","readOnly":true,"example":{"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"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sources/{sourceId}/connector/check-connection","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Check connection for source connector.","description":{"content":"This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":sourceId","connector","check-connection"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the Source.","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Check connection for source connector.' (test-source-connection)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Check connection for source connector. + + + +This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. +A token with ORG_ADMIN authority is required to call this API. + +
    Path Parameters
    + +The result of checking connection to the source connector with response from it. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/test-subscription-filter.api.mdx b/products/idn/api/beta/test-subscription-filter.api.mdx new file mode 100644 index 000000000..02f32f8b6 --- /dev/null +++ b/products/idn/api/beta/test-subscription-filter.api.mdx @@ -0,0 +1,76 @@ +--- +id: test-subscription-filter +sidebar_label: Validate a Subscription Filter +hide_title: true +hide_table_of_contents: true +api: {"operationId":"testSubscriptionFilter","tags":["Triggers"],"description":"Validates a JSONPath filter expression against a provided mock input.\nRequest requires a security scope of: ","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["input","filter"],"type":"object","properties":{"input":{"type":"object","description":"Mock input to evaluate filter expression against.","example":{"identityId":"201327fda1c44704ac01181e963d463c"}},"filter":{"type":"string","description":"JSONPath filter to conditionally invoke trigger when expression evaluates to true.","example":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]","externalDocs":{"description":"JSONPath filter documentation","url":"https://developer.sailpoint.com/idn/docs/event-triggers/filtering-events"}}}},"example":{"input":{"identityId":"201327fda1c44704ac01181e963d463c"},"filter":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]"}}}},"responses":{"200":{"description":"Boolean whether specified filter expression is valid against the input.","content":{"application/json":{"schema":{"type":"object","properties":{"isValid":{"type":"boolean","default":false,"description":"When this field is true, the filter expression is valid against the input.","example":true},"isValidJSONPath":{"type":"boolean","default":false,"description":"When this field is true, the filter expression is using a valid JSON path.","example":true},"isPathExist":{"type":"boolean","default":false,"description":"When this field is true, the filter expression is using an existing path.","example":true}}},"example":{"isValid":true,"isValidJSONPath":true,"isPathExist":true}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["sp:trigger-service-subscriptions:manage"]}],"method":"post","path":"/trigger-subscriptions/validate-filter","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"input":{"identityId":"201327fda1c44704ac01181e963d463c"},"filter":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Validate a Subscription Filter","description":{"content":"Validates a JSONPath filter expression against a provided mock input.\nRequest requires a security scope of: ","type":"text/plain"},"url":{"path":["trigger-subscriptions","validate-filter"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Validate a Subscription Filter' (test-subscription-filter)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Validate a Subscription Filter + + + +Validates a JSONPath filter expression against a provided mock input. +Request requires a security scope of: + +
    Request Body required
    + +Boolean whether specified filter expression is valid against the input. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/test-workflow.api.mdx b/products/idn/api/beta/test-workflow.api.mdx new file mode 100644 index 000000000..e7fd7fbc4 --- /dev/null +++ b/products/idn/api/beta/test-workflow.api.mdx @@ -0,0 +1,77 @@ +--- +id: test-workflow +sidebar_label: Test Workflow By Id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"testWorkflow","tags":["Workflows"],"description":"Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow.\nThis endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint.\n**This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.**","security":[{"oauth2":["sp:workflow-execute:external"]}],"parameters":[{"name":"id","in":"path","description":"Id of the workflow","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["input"],"properties":{"input":{"type":"object","description":"The test input for the workflow."}}},"examples":{"Identity Attributes Changed":{"description":"Identity Attributes Changed Trigger Input","value":{"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"}]}}}}}}},"responses":{"200":{"description":"The Workflow object","content":{"application/json":{"schema":{"type":"object","properties":{"workflowExecutionId":{"type":"string","description":"The workflow execution id","example":"0e11cefa-96e7-4b67-90d0-065bc1da5753"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/workflows/{id}/test","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"input":{}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Test Workflow By Id","description":{"content":"Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow.\nThis endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint.\n**This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.**","type":"text/plain"},"url":{"path":["workflows",":id","test"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the workflow","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Test Workflow By Id' (test-workflow)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Test Workflow By Id + + + +Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow. +This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. +**This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** + +
    Path Parameters
    Request Body required
    + +The Workflow object + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/transforms.tag.mdx b/products/idn/api/beta/transforms.tag.mdx new file mode 100644 index 000000000..ed1019308 --- /dev/null +++ b/products/idn/api/beta/transforms.tag.mdx @@ -0,0 +1,20 @@ +--- +id: transforms +title: "Transforms" +description: "Transforms" +custom_edit_url: null +--- + + + +Operations for creating, managing, and deleting transforms + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/triggers.tag.mdx b/products/idn/api/beta/triggers.tag.mdx new file mode 100644 index 000000000..c1ff723e2 --- /dev/null +++ b/products/idn/api/beta/triggers.tag.mdx @@ -0,0 +1,63 @@ +--- +id: triggers +title: "Triggers" +description: "Triggers" +custom_edit_url: null +--- + + + +Event Triggers provide real-time updates to changes in IdentityNow so you can take action as soon as an event occurs, rather than poll an API endpoint for updates. IdentityNow provides a user interface within the admin console to create and manage trigger subscriptions. These endpoints allow for programatically creating and managing trigger subscriptions. + +There are two types of event triggers: + * `FIRE_AND_FORGET`: This trigger type will send a payload to each subscriber without needing a response. Each trigger of this type has a limit of **50 subscriptions**. + * `REQUEST_RESPONSE`: This trigger type will send a payload to a subscriber and expect a response back. Each trigger of this type may only have **one subscription**. + +## Available Event Triggers +Production ready event triggers that are available in all tenants. + +| Name | ID | Type | Trigger condition | +|-|-|-|-| +| [Access Request Dynamic Approval](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/access-request-dynamic-approval) | idn:access-request-dynamic-approver | REQUEST_RESPONSE |After an access request is submitted. Expects the subscriber to respond with the ID of an identity or workgroup to add to the approval workflow. | +| [Access Request Postapproval](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/access-request-postapproval) | idn:access-request-post-approval | FIRE_AND_FORGET | After an access request is approved. | +| [Access Request Preapproval](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/access-request-preapproval) | idn:access-request-pre-approval | REQUEST_RESPONSE | After an access request is submitted. Expects the subscriber to respond with an approval decision. | +| [Account Aggregation Completed](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/account-aggregation-completed) | idn:account-aggregation-completed | FIRE_AND_FORGET | After an account aggregation completed, terminated, failed. | +| Account Attributes Changed | idn:account-attributes-changed | FIRE_AND_FORGET | After an account aggregation, and one or more account attributes have changed. | +| Account Correlated | idn:account-correlated | FIRE_AND_FORGET | After an account is added to an identity. | +| Accounts Collected for Aggregation | idn:aggregation-accounts-collected | FIRE_AND_FORGET | New, changed, and deleted accounts have been gathered during an aggregation and are being processed. | +| Account Uncorrelated | idn:account-uncorrelated | FIRE_AND_FORGET | After an account is removed from an identity. | +| Campaign Activated | idn:campaign-activated | FIRE_AND_FORGET | After a campaign is activated. | +| Campaign Ended | idn:campaign-ended | FIRE_AND_FORGET | After a campaign ends. | +| Campaign Generated | idn:campaign-generated | FIRE_AND_FORGET | After a campaign finishes generating. | +| Certification Signed Off | idn:certification-signed-off | FIRE_AND_FORGET | After a certification is signed off by its reviewer. | +| [Identity Attributes Changed](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/account-aggregation-completed) | idn:identity-attributes-changed | FIRE_AND_FORGET | After One or more identity attributes changed. | +| [Identity Created](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/identity-created) | idn:identity-created | FIRE_AND_FORGET | After an identity is created. | +| [Provisioning Action Completed](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/provisioning-action-completed) | idn:post-provisioning | FIRE_AND_FORGET | After a provisioning action completed on a source. | +| [Saved Search Complete](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/saved-search-completed) | idn:saved-search-complete | FIRE_AND_FORGET | After a scheduled search completed. | +| [Source Created](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/source-created) | idn:source-created | FIRE_AND_FORGET | After a source is created. | +| [Source Deleted](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/source-deleted) | idn:source-deleted | FIRE_AND_FORGET | After a source is deleted. | +| [Source Updated](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/source-updated) | idn:source-updated | FIRE_AND_FORGET | After configuration changes have been made to a source. | +| [VA Cluster Status Change](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/va-cluster-status-change) | idn:va-cluster-status-change | FIRE_AND_FORGET | After the status of a VA cluster has changed. | + +## Early Access Event Triggers +Triggers that are in-development and not ready for production use. Please contact support to enable these triggers in your tenant. + +| Name | ID | Type | Trigger condition | +|-|-|-|-| +| [Identity Deleted](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/identity-deleted) | idn:identity-deleted | FIRE_AND_FORGET | After an identity is deleted. | +| [Source Account Created](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/source-account-created) | idn:source-account-created | FIRE_AND_FORGET | After a source account is created. | +| [Source Account Deleted](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/source-account-deleted) | idn:source-account-deleted | FIRE_AND_FORGET | After a source account is deleted. | +| [Source Account Updated](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/source-account-updated) | idn:source-account-updated | FIRE_AND_FORGET | After a source account is changed. | + +Refer to [Event Triggers](https://developer.sailpoint.com/idn/docs/event-triggers/) for more information about event triggers. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/un-ignore-identity-outliers.api.mdx b/products/idn/api/beta/un-ignore-identity-outliers.api.mdx new file mode 100644 index 000000000..67a8390da --- /dev/null +++ b/products/idn/api/beta/un-ignore-identity-outliers.api.mdx @@ -0,0 +1,76 @@ +--- +id: un-ignore-identity-outliers +sidebar_label: IAI Identity Outliers Unignore +hide_title: true +hide_table_of_contents: true +api: {"operationId":"unIgnoreIdentityOutliers","tags":["IAI Outliers"],"description":"This API receives a list of IdentityIDs in the request, changes the outliers to be un-ignored--returning a 204 if successful.\nRequires authorization scope of 'iai:outliers-management:update'","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"description":"List of identity IDs to un-ignore from outlier listing","example":["abc123def456","ghi789jkl012"]}}}},"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/outliers/unignore","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":["abc123def456","ghi789jkl012"],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"IAI Identity Outliers Unignore","description":{"content":"This API receives a list of IdentityIDs in the request, changes the outliers to be un-ignored--returning a 204 if successful.\nRequires authorization scope of 'iai:outliers-management:update'","type":"text/plain"},"url":{"path":["outliers","unignore"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'IAI Identity Outliers Unignore' (un-ignore-identity-outliers)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## IAI Identity Outliers Unignore + + + +This API receives a list of IdentityIDs in the request, changes the outliers to be un-ignored--returning a 204 if successful. +Requires authorization scope of 'iai:outliers-management:update' + +
    Request Body array required
    • string
    + +No content - indicates the request was successful but there is no content to be returned in the response. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/unlock-account.api.mdx b/products/idn/api/beta/unlock-account.api.mdx new file mode 100644 index 000000000..b83152711 --- /dev/null +++ b/products/idn/api/beta/unlock-account.api.mdx @@ -0,0 +1,88 @@ +--- +id: unlock-account +sidebar_label: Unlock Account +hide_title: true +hide_table_of_contents: true +api: {"operationId":"unlockAccount","tags":["Accounts"],"description":"This API submits a task to unlock an account and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:accounts-state:manage"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The account id","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"Request used for account unlock","type":"object","properties":{"externalVerificationId":{"description":"If set, an external process validates that the user wants to proceed with this request.","type":"string","example":"3f9180835d2e5168015d32f890ca1581"},"unlockIDNAccount":{"description":"If set, the IDN account is unlocked after the workflow completes.","type":"boolean","example":false},"forceProvisioning":{"description":"If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated.","type":"boolean","example":false}}}}}},"responses":{"202":{"description":"Async task details","content":{"application/json":{"schema":{"description":"Accounts async response containing details on started async process","required":["id"],"type":"object","properties":{"id":{"description":"id of the task","type":"string","example":"2c91808474683da6017468693c260195"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/accounts/{id}/unlock","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"externalVerificationId":"3f9180835d2e5168015d32f890ca1581","unlockIDNAccount":false,"forceProvisioning":false},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Unlock Account","description":{"content":"This API submits a task to unlock an account and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts",":id","unlock"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The account id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Unlock Account' (unlock-account)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Unlock Account + + + +This API submits a task to unlock an account and returns the task ID. +A token with ORG_ADMIN authority is required to call this API. + +
    Path Parameters
    Request Body required
    + +Async task details + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-access-request-config.api.mdx b/products/idn/api/beta/update-access-request-config.api.mdx new file mode 100644 index 000000000..80d3208bd --- /dev/null +++ b/products/idn/api/beta/update-access-request-config.api.mdx @@ -0,0 +1,100 @@ +--- +id: update-access-request-config +sidebar_label: Update Access Request Configuration +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateAccessRequestConfig","tags":["Access Requests"],"description":"This endpoint replaces the current access-request configuration.\nA token with ORG_ADMIN authority is required to call this API.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"approvalsMustBeExternal":{"type":"boolean","description":"If true, then approvals must be processed by external system.","example":true},"autoApprovalEnabled":{"type":"boolean","description":"If true and requester and reviewer are the same, then automatically approve the approval.","example":true},"requestOnBehalfOfConfig":{"description":"Request On Behalf Of Configuration.","type":"object","properties":{"allowRequestOnBehalfOfAnyoneByAnyone":{"type":"boolean","description":"If anyone can request access for anyone.","example":true},"allowRequestOnBehalfOfEmployeeByManager":{"type":"boolean","description":"If a manager can request access for his/her direct reports.","example":true}}},"approvalReminderAndEscalationConfig":{"description":"Approval Reminder and Escalation Configuration.","type":"object","properties":{"daysUntilEscalation":{"type":"integer","description":"Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation.","format":"int32","example":0},"daysBetweenReminders":{"type":"integer","description":"Number of days to wait between reminder notifications.","format":"int32","example":0},"maxReminders":{"type":"integer","description":"Maximum number of reminder notification to send to the reviewer before approval escalation.","format":"int32","example":0},"fallbackApproverRef":{"type":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"},"id":{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"},"name":{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"},"email":{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}}}},"entitlementRequestConfig":{"description":"Entitlement Request Configuration.","type":"object","properties":{"allowEntitlementRequest":{"type":"boolean","description":"Flag for allowing entitlement request.","example":true},"requestCommentsRequired":{"type":"boolean","description":"Flag for requiring comments while submitting an entitlement request.","default":false,"example":false},"deniedCommentsRequired":{"type":"boolean","description":"Flag for requiring comments while rejecting an entitlement request.","default":false,"example":false},"grantRequestApprovalSchemes":{"type":"string","description":"Approval schemes for granting entitlement request. This can be empty if no approval is needed.\nMultiple schemes must be comma-separated. The valid schemes are \"entitlementOwner\", \"sourceOwner\", \"manager\" and \"workgroup:{id}\".\nMultiple workgroups (governance groups) can be used.\n","default":"sourceOwner","example":"entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584"}}}}}}}},"responses":{"200":{"description":"Access Request Configuration Details.","content":{"application/json":{"schema":{"type":"object","properties":{"approvalsMustBeExternal":{"type":"boolean","description":"If true, then approvals must be processed by external system.","example":true},"autoApprovalEnabled":{"type":"boolean","description":"If true and requester and reviewer are the same, then automatically approve the approval.","example":true},"requestOnBehalfOfConfig":{"description":"Request On Behalf Of Configuration.","type":"object","properties":{"allowRequestOnBehalfOfAnyoneByAnyone":{"type":"boolean","description":"If anyone can request access for anyone.","example":true},"allowRequestOnBehalfOfEmployeeByManager":{"type":"boolean","description":"If a manager can request access for his/her direct reports.","example":true}}},"approvalReminderAndEscalationConfig":{"description":"Approval Reminder and Escalation Configuration.","type":"object","properties":{"daysUntilEscalation":{"type":"integer","description":"Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation.","format":"int32","example":0},"daysBetweenReminders":{"type":"integer","description":"Number of days to wait between reminder notifications.","format":"int32","example":0},"maxReminders":{"type":"integer","description":"Maximum number of reminder notification to send to the reviewer before approval escalation.","format":"int32","example":0},"fallbackApproverRef":{"type":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"},"id":{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"},"name":{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"},"email":{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}}}},"entitlementRequestConfig":{"description":"Entitlement Request Configuration.","type":"object","properties":{"allowEntitlementRequest":{"type":"boolean","description":"Flag for allowing entitlement request.","example":true},"requestCommentsRequired":{"type":"boolean","description":"Flag for requiring comments while submitting an entitlement request.","default":false,"example":false},"deniedCommentsRequired":{"type":"boolean","description":"Flag for requiring comments while rejecting an entitlement request.","default":false,"example":false},"grantRequestApprovalSchemes":{"type":"string","description":"Approval schemes for granting entitlement request. This can be empty if no approval is needed.\nMultiple schemes must be comma-separated. The valid schemes are \"entitlementOwner\", \"sourceOwner\", \"manager\" and \"workgroup:{id}\".\nMultiple workgroups (governance groups) can be used.\n","default":"sourceOwner","example":"entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584"}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/access-request-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"approvalsMustBeExternal":true,"autoApprovalEnabled":true,"requestOnBehalfOfConfig":{"allowRequestOnBehalfOfAnyoneByAnyone":true,"allowRequestOnBehalfOfEmployeeByManager":true},"approvalReminderAndEscalationConfig":{"daysUntilEscalation":0,"daysBetweenReminders":0,"maxReminders":0,"fallbackApproverRef":{"type":"IDENTITY","id":"5168015d32f890ca15812c9180835d2e","name":"Alison Ferguso","email":"alison.ferguso@identitysoon.com"}},"entitlementRequestConfig":{"allowEntitlementRequest":true,"requestCommentsRequired":false,"deniedCommentsRequired":false,"grantRequestApprovalSchemes":"entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584"}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update Access Request Configuration","description":{"content":"This endpoint replaces the current access-request configuration.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["access-request-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Access Request Configuration' (update-access-request-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Access Request Configuration + + + +This endpoint replaces the current access-request configuration. +A token with ORG_ADMIN authority is required to call this API. + +
    Request Body required
      requestOnBehalfOfConfig object
      + +Request On Behalf Of Configuration. + +
      approvalReminderAndEscalationConfig object
      + +Approval Reminder and Escalation Configuration. + +
      fallbackApproverRef object
      entitlementRequestConfig object
      + +Entitlement Request Configuration. + +
    + +Access Request Configuration Details. + +
    Schema
      requestOnBehalfOfConfig object
      + +Request On Behalf Of Configuration. + +
      approvalReminderAndEscalationConfig object
      + +Approval Reminder and Escalation Configuration. + +
      fallbackApproverRef object
      entitlementRequestConfig object
      + +Entitlement Request Configuration. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-account.api.mdx b/products/idn/api/beta/update-account.api.mdx new file mode 100644 index 000000000..a844ecafd --- /dev/null +++ b/products/idn/api/beta/update-account.api.mdx @@ -0,0 +1,92 @@ +--- +id: update-account +sidebar_label: Update Account +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateAccount","tags":["Accounts"],"description":"This updates account details. \nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:accounts:manage"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The account ID","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"description":"A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object"}},"example":[{"op":"replace","path":"/identityId","value":"2c9180845d1edece015d27a975983e21"}]}}},"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/accounts/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update Account","description":{"content":"This updates account details. \nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The account ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Account' (update-account)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Account + + + +This updates account details. +A token with ORG_ADMIN authority is required to call this API. + +
    Path Parameters
    Request Body array required
    + +A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +
    + +Accepted - Returned if the request was successfully accepted into the system. + +
    Schema
    • object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-campaign.api.mdx b/products/idn/api/beta/update-campaign.api.mdx new file mode 100644 index 000000000..fed0a57f9 --- /dev/null +++ b/products/idn/api/beta/update-campaign.api.mdx @@ -0,0 +1,104 @@ +--- +id: update-campaign +sidebar_label: Update a Campaign +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateCampaign","tags":["Certification Campaigns"],"description":"Allows updating individual fields on a campaign using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.","security":[{"oauth2":["idn:campaign:update","idn:campaign:read"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the campaign template being modified.","example":"2c91808571bcfcf80171c23e4b4221fc"}],"requestBody":{"required":true,"description":"A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\nThe fields that can be patched differ based on the status of the campaign.\n\nIn the *STAGED* status, the following fields can be patched:\n* name\n* description\n* recommendationsEnabled\n* deadline\n* emailNotificationEnabled\n* autoRevokeAllowed\n\nIn the *ACTIVE* status, the following fields can be patched:\n* deadline\n","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object"}},"example":[{"op":"replace","path":"/name","value":"This field has been updated!"},{"op":"copy","from":"/name","path":"/description"}]}}},"responses":{"200":{"description":"Indicates the PATCH operation succeeded, and returns the campaign's new representation.","content":{"application/json":{"schema":{"type":"object","title":"Slim Campaign","required":["name","description","type"],"properties":{"id":{"type":"string","readOnly":true,"description":"Id of the campaign","example":"2c9079b270a266a60170a2779fcb0007"},"name":{"description":"The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","type":"string","example":"Manager Campaign"},"description":{"type":"string","description":"The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","example":"Everyone needs to be reviewed by their manager"},"deadline":{"type":"string","format":"date-time","description":"The campaign's completion deadline.","example":"2020-03-15T10:00:01.456Z"},"type":{"type":"string","description":"The type of campaign. Could be extended in the future.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"},"emailNotificationEnabled":{"type":"boolean","description":"Enables email notification for this campaign","default":false,"example":false},"autoRevokeAllowed":{"type":"boolean","description":"Allows auto revoke for this campaign","default":false,"example":false},"recommendationsEnabled":{"type":"boolean","description":"Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.","default":false,"example":true},"status":{"type":"string","description":"The campaign's current status.","readOnly":true,"enum":["PENDING","STAGED","CANCELING","ACTIVATING","ACTIVE","COMPLETING","COMPLETED","ERROR","ARCHIVED"],"example":"ACTIVE"},"correlatedStatus":{"type":"string","description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"}}},"examples":{"Manager":{"value":{"id":"2c918086719eec070171a7e3355a360a","name":"Manager Review","description":"A review of everyone's access by their manager.","deadline":"2020-12-25T06:00:00.123Z","type":"MANAGER","status":"ACTIVE","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false}},"Search":{"value":{"id":"7e1a731e3fb845cfbe58112ba4673ee4","name":"Search Campaign","description":"Search Campaign Info","deadline":"2022-07-26T15:42:44Z","type":"SEARCH","status":"ACTIVE","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false}},"Source Owner":{"value":{"id":"2c918086719eec070171a7e3355a412b","name":"AD Source Review","description":"A review of our AD source.","deadline":"2020-12-25T06:00:00.123Z","type":"SOURCE_OWNER","status":"STAGED","emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"correlatedStatus":"CORRELATED"}},"RoleComposition":{"value":{"id":"3b2e2e5821e84127b6d693d41c40623b","name":"Role Composition Campaign","description":"A review done by a role owner.","deadline":"2020-12-25T06:00:00.468Z","type":"ROLE_COMPOSITION","status":"ACTIVE","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/campaigns/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update a Campaign","description":{"content":"Allows updating individual fields on a campaign using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.","type":"text/plain"},"url":{"path":["campaigns",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the campaign template being modified.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a Campaign' (update-campaign)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a Campaign + + + +Allows updating individual fields on a campaign using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +
    Path Parameters
    Request Body array required
    + +A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +The fields that can be patched differ based on the status of the campaign. + +In the *STAGED* status, the following fields can be patched: +* name +* description +* recommendationsEnabled +* deadline +* emailNotificationEnabled +* autoRevokeAllowed + +In the *ACTIVE* status, the following fields can be patched: +* deadline + + +
    + +Indicates the PATCH operation succeeded, and returns the campaign's new representation. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-common-access-status-in-bulk.api.mdx b/products/idn/api/beta/update-common-access-status-in-bulk.api.mdx new file mode 100644 index 000000000..ebf7b157a --- /dev/null +++ b/products/idn/api/beta/update-common-access-status-in-bulk.api.mdx @@ -0,0 +1,79 @@ +--- +id: update-common-access-status-in-bulk +sidebar_label: Bulk update common access status +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateCommonAccessStatusInBulk","tags":["IAI Common Access"],"description":"This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update","requestBody":{"description":"Confirm or deny in bulk the common access ids that are (or aren't) common access","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"confirmedIds":{"description":"List of confirmed common access ids.","type":"array","items":{"type":"string","format":"uuid"}},"deniedIds":{"description":"List of denied common access ids.","type":"array","items":{"type":"string","format":"uuid"}}}}}}}},"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/common-access/update-status","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"confirmedIds":["3fa85f64-5717-4562-b3fc-2c963f66afa6"],"deniedIds":["3fa85f64-5717-4562-b3fc-2c963f66afa6"]}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Bulk update common access status","description":{"content":"This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update","type":"text/plain"},"url":{"path":["common-access","update-status"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Bulk update common access status' (update-common-access-status-in-bulk)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Bulk update common access status + + + +This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update + +
    Request Body array required
    + +Confirm or deny in bulk the common access ids that are (or aren't) common access + +
    + +Accepted - Returned if the request was successfully accepted into the system. + +
    Schema
    • object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-connector-rule.api.mdx b/products/idn/api/beta/update-connector-rule.api.mdx new file mode 100644 index 000000000..0c7f206ce --- /dev/null +++ b/products/idn/api/beta/update-connector-rule.api.mdx @@ -0,0 +1,108 @@ +--- +id: update-connector-rule +sidebar_label: Update a Connector Rule +hide_title: true +hide_table_of_contents: true +api: {"tags":["Connector Rule Management"],"description":"Updates an existing connector rule with the one provided in the request body. Note that the fields 'id', 'name', and 'type' are immutable.\nA token with ORG_ADMIN authority is required to call this API.","operationId":"updateConnectorRule","parameters":[{"name":"id","in":"path","description":"ID of the connector rule to update","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"8c190e6787aa4ed9a90bd9d5344523fb"}],"requestBody":{"description":"The connector rule with updated data","content":{"application/json":{"schema":{"description":"ConnectorRuleUpdateRequest","allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"the ID of the rule to update","example":"8113d48c0b914f17b4c6072d4dcb9dfe"}}},{"description":"ConnectorRuleCreateRequest","type":"object","required":["name","type","sourceCode"],"properties":{"name":{"type":"string","description":"the name of the rule","example":"WebServiceBeforeOperationRule","minLength":1,"maxLength":128},"description":{"type":"string","description":"a description of the rule's purpose","example":"This rule does that"},"type":{"type":"string","enum":["BuildMap","ConnectorAfterCreate","ConnectorAfterDelete","ConnectorAfterModify","ConnectorBeforeCreate","ConnectorBeforeDelete","ConnectorBeforeModify","JDBCBuildMap","JDBCOperationProvisioning","JDBCProvision","PeopleSoftHRMSBuildMap","PeopleSoftHRMSOperationProvisioning","PeopleSoftHRMSProvision","RACFPermissionCustomization","SAPBuildMap","SapHrManagerRule","SapHrOperationProvisioning","SapHrProvision","SuccessFactorsOperationProvisioning","WebServiceAfterOperationRule","WebServiceBeforeOperationRule"],"description":"the type of rule","example":"BuildMap"},"signature":{"description":"The rule's function signature. Describes the rule's input arguments and output (if any)","type":"object","required":["input"],"properties":{"input":{"type":"array","items":{"type":"object","nullable":true,"properties":{"name":{"type":"string","description":"the name of the argument","example":"firstName"},"description":{"type":"string","description":"the description of the argument","example":"the first name of the identity"},"type":{"type":"string","nullable":true,"description":"the programmatic type of the argument","example":"String"}},"required":["name"]}},"output":{"type":"object","nullable":true,"properties":{"name":{"type":"string","description":"the name of the argument","example":"firstName"},"description":{"type":"string","description":"the description of the argument","example":"the first name of the identity"},"type":{"type":"string","nullable":true,"description":"the programmatic type of the argument","example":"String"}},"required":["name"]}}},"sourceCode":{"description":"SourceCode","type":"object","required":["version","script"],"properties":{"version":{"type":"string","description":"the version of the code","example":"1.0"},"script":{"type":"string","description":"The code","example":"return \"Mr. \" + firstName;"}}},"attributes":{"type":"object","nullable":true,"description":"a map of string to objects","example":{}}}}]}}}},"responses":{"200":{"description":"The updated connector rule","content":{"application/json":{"schema":{"description":"ConnectorRuleResponse","allOf":[{"description":"ConnectorRuleCreateRequest","type":"object","required":["name","type","sourceCode"],"properties":{"name":{"type":"string","description":"the name of the rule","example":"WebServiceBeforeOperationRule","minLength":1,"maxLength":128},"description":{"type":"string","description":"a description of the rule's purpose","example":"This rule does that"},"type":{"type":"string","enum":["BuildMap","ConnectorAfterCreate","ConnectorAfterDelete","ConnectorAfterModify","ConnectorBeforeCreate","ConnectorBeforeDelete","ConnectorBeforeModify","JDBCBuildMap","JDBCOperationProvisioning","JDBCProvision","PeopleSoftHRMSBuildMap","PeopleSoftHRMSOperationProvisioning","PeopleSoftHRMSProvision","RACFPermissionCustomization","SAPBuildMap","SapHrManagerRule","SapHrOperationProvisioning","SapHrProvision","SuccessFactorsOperationProvisioning","WebServiceAfterOperationRule","WebServiceBeforeOperationRule"],"description":"the type of rule","example":"BuildMap"},"signature":{"description":"The rule's function signature. Describes the rule's input arguments and output (if any)","type":"object","required":["input"],"properties":{"input":{"type":"array","items":{"type":"object","nullable":true,"properties":{"name":{"type":"string","description":"the name of the argument","example":"firstName"},"description":{"type":"string","description":"the description of the argument","example":"the first name of the identity"},"type":{"type":"string","nullable":true,"description":"the programmatic type of the argument","example":"String"}},"required":["name"]}},"output":{"type":"object","nullable":true,"properties":{"name":{"type":"string","description":"the name of the argument","example":"firstName"},"description":{"type":"string","description":"the description of the argument","example":"the first name of the identity"},"type":{"type":"string","nullable":true,"description":"the programmatic type of the argument","example":"String"}},"required":["name"]}}},"sourceCode":{"description":"SourceCode","type":"object","required":["version","script"],"properties":{"version":{"type":"string","description":"the version of the code","example":"1.0"},"script":{"type":"string","description":"The code","example":"return \"Mr. \" + firstName;"}}},"attributes":{"type":"object","nullable":true,"description":"a map of string to objects","example":{}}}},{"type":"object","nullable":true,"required":["id","created"],"properties":{"id":{"type":"string","description":"the ID of the rule","example":"8113d48c0b914f17b4c6072d4dcb9dfe"},"created":{"type":"string","description":"an ISO 8601 UTC timestamp when this rule was created","example":"021-07-22T15:59:23Z"},"modified":{"type":"string","nullable":true,"description":"an ISO 8601 UTC timestamp when this rule was last modified","example":"021-07-22T15:59:23Z"}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:rule-management-connector:manage"]}],"method":"put","path":"/connector-rules/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"id":"8113d48c0b914f17b4c6072d4dcb9dfe","name":"WebServiceBeforeOperationRule","description":"This rule does that","type":"BuildMap","signature":{"input":[{"name":"firstName","description":"the first name of the identity","type":"String"}],"output":{"name":"firstName","description":"the first name of the identity","type":"String"}},"sourceCode":{"version":"1.0","script":"return \"Mr. \" + firstName;"},"attributes":{}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update a Connector Rule","description":{"content":"Updates an existing connector rule with the one provided in the request body. Note that the fields 'id', 'name', and 'type' are immutable.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["connector-rules",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the connector rule to update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a Connector Rule' (update-connector-rule)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a Connector Rule + + + +Updates an existing connector rule with the one provided in the request body. Note that the fields 'id', 'name', and 'type' are immutable. +A token with ORG_ADMIN authority is required to call this API. + +
    Path Parameters
    Request Body
    + +The connector rule with updated data + +
      signature object
      + +The rule's function signature. Describes the rule's input arguments and output (if any) + +
      input object[] required
      output object
      sourceCode object required
      + +SourceCode + +
    + +The updated connector rule + +
    Schema
      signature object
      + +The rule's function signature. Describes the rule's input arguments and output (if any) + +
      input object[]
      output object
      sourceCode object
      + +SourceCode + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-entitlements-in-bulk.api.mdx b/products/idn/api/beta/update-entitlements-in-bulk.api.mdx new file mode 100644 index 000000000..14ebc79f4 --- /dev/null +++ b/products/idn/api/beta/update-entitlements-in-bulk.api.mdx @@ -0,0 +1,85 @@ +--- +id: update-entitlements-in-bulk +sidebar_label: Bulk update an entitlement list +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateEntitlementsInBulk","tags":["Entitlements"],"description":"This API applies an update to every entitlement of the list.\n\nThe number of entitlements to update is limited to 50 items maximum.\n\nThe JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. allowed operations : **{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }** **{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }** \n\nA token with ORG_ADMIN or API authority is required to call this API.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"entitlementIds":{"type":"array","description":"List of entitlement ids to update","maxItems":50,"items":{"type":"string"},"example":["2c91808a7624751a01762f19d665220d","2c91808a7624751a01762f19d67c220e","2c91808a7624751a01762f19d692220f"]},"jsonPatch":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}},"example":[{"op":"replace","path":"/privileged","value":false},{"op":"replace","path":"/requestable","value":false}]}},"example":{"entitlementIds":["2c91808a7624751a01762f19d665220d","2c91808a7624751a01762f19d67c220e","2c91808a7624751a01762f19d692220f"],"jsonPatch":[{"op":"replace","path":"/privileged","value":false},{"op":"replace","path":"/requestable","value":false}]},"required":["entitlementIds","jsonPatch"]}}}},"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/entitlements/bulk-update","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"entitlementIds":["2c91808a7624751a01762f19d665220d","2c91808a7624751a01762f19d67c220e","2c91808a7624751a01762f19d692220f"],"jsonPatch":[{"op":"replace","path":"/privileged","value":false},{"op":"replace","path":"/requestable","value":false}]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Bulk update an entitlement list","description":{"content":"This API applies an update to every entitlement of the list.\n\nThe number of entitlements to update is limited to 50 items maximum.\n\nThe JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. allowed operations : **{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }** **{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }** \n\nA token with ORG_ADMIN or API authority is required to call this API.","type":"text/plain"},"url":{"path":["entitlements","bulk-update"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Bulk update an entitlement list' (update-entitlements-in-bulk)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Bulk update an entitlement list + + + +This API applies an update to every entitlement of the list. + +The number of entitlements to update is limited to 50 items maximum. + +The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. allowed operations : **{ "op": "replace", "path": "/privileged", "value": boolean }** **{ "op": "replace", "path": "/requestable","value": boolean }** + +A token with ORG_ADMIN or API authority is required to call this API. + +
    Request Body required
      jsonPatch object[] required
      value object
      + +The value to be used for the operation, required for "add" and "replace" operations + +
      anyOf
    • string
    • integer
      • anyOf
    • string
    • integer
    + +No content - indicates the request was successful but there is no content to be returned in the response. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-entitlements-potential-role.api.mdx b/products/idn/api/beta/update-entitlements-potential-role.api.mdx new file mode 100644 index 000000000..d94d1da7d --- /dev/null +++ b/products/idn/api/beta/update-entitlements-potential-role.api.mdx @@ -0,0 +1,91 @@ +--- +id: update-entitlements-potential-role +sidebar_label: Edit entitlements for a potential role to exclude some entitlements +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateEntitlementsPotentialRole","tags":["IAI Role Mining"],"description":"This endpoint adds or removes entitlements from an exclusion list for a potential role.","parameters":[{"in":"path","name":"sessionId","schema":{"type":"string"},"required":true,"description":"The role mining session id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"},{"in":"path","name":"potentialRoleId","schema":{"type":"string"},"required":true,"description":"A potential role id in a role mining session","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"}],"requestBody":{"description":"Role mining session parameters","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"The list of entitlement ids to be edited","type":"array","items":{"type":"string"}},"exclude":{"type":"boolean","description":"If true, add ids to be exclusion list. If false, remove ids from the exclusion list."}},"example":{"ids":["entId1","entId2"],"exclude":true}}}}},"responses":{"201":{"description":"Adds or removes entitlements from a potential role's entitlement exclusion list.","content":{"application/json":{"schema":{"type":"object","properties":{"createdBy":{"description":"The session created by details.","type":"object","properties":{"id":{"type":"string","description":"ID of the creator","example":"2c918090761a5aac0176215c46a62d58"},"displayName":{"type":"string","description":"The display name of the creator","example":"Ashley.Pierce"}}},"density":{"type":"integer","description":"The density of a potential role.","example":75,"format":"int32"},"description":{"type":"string","description":"The description of a potential role.","example":"Potential Role for Accounting dept"},"entitlementCount":{"type":"integer","description":"The number of entitlements in a potential role.","example":25,"format":"int32"},"excludedEntitlements":{"description":"The list of entitlement ids to be excluded.","type":"array","items":{"type":"string"},"example":["07a0b4e2","13b4e2a0"]},"freshness":{"type":"integer","description":"The freshness of a potential role.","example":75,"format":"int32"},"identityCount":{"type":"integer","description":"The number of identities in a potential role.","example":25,"format":"int32"},"identityDistribution":{"description":"Identity attribute distribution.","type":"array","items":{"type":"object","properties":{"attributeName":{"type":"string","description":"Id of the potential role","example":"department"},"distribution":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}},"example":[{"attributeValue":"NM Tier 3","count":6}]}}}},"identityIds":{"description":"The list of ids in a potential role.","type":"array","items":{"type":"string"},"example":["07a0b4e2","13b4e2a0"]},"name":{"type":"string","description":"Name of the potential role.","example":"Saved Potential Role - 07/10"},"provisionState":{"description":"The provisioning state of a potential role.","type":"string","enum":["POTENTIAL","PENDING","COMPLETE","FAILED"],"example":"POTENTIAL"},"quality":{"type":"integer","description":"The quality of a potential role.","example":100,"format":"int32"},"roleId":{"type":"string","description":"The roleId of a potential role.","example":"07a0b4e2-7a76-44fa-bd0b-c64654b66519"},"saved":{"type":"boolean","description":"The potential role's saved status.","example":true},"session":{"description":"The session parameters of the potential role.","type":"object","properties":{"minNumIdentitiesInPotentialRole":{"type":"integer","description":"Minimum number of identities in a potential role","example":20,"format":"int32"},"name":{"type":"string","description":"The session's saved name","example":"Saved RM Session - 07/10"},"pruneThreshold":{"type":"integer","description":"The prune threshold to be used or null to calculate prescribedPruneThreshold","example":5,"format":"int32"},"saved":{"type":"boolean","description":"The session's saved status","example":true},"scope":{"description":"The scope of identities for this role mining session","example":{"identityIds":[],"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"]}}},"type":"object","properties":{"identityIds":{"type":"array","items":{"type":"string"},"description":"The list of identities for this role mining session.","example":["2c918090761a5aac0176215c46a62d58","2c918090761a5aac01722015c46a62d42"]},"criteria":{"type":"string","description":"The \"search\" criteria that produces the list of identities for this role mining session.","example":"source.name:DataScienceDataset"},"attributeFilterCriteria":{"type":"array","items":{"type":"object"},"description":"The filter criteria for this role mining session.","example":{"displayName":{"untranslated":"Location: Miami"},"ariaLabel":{"untranslated":"Location: Miami"},"data":{"displayName":{"translateKey":"IDN.IDENTITY_ATTRIBUTES.LOCATION"},"name":"location","operator":"EQUALS","values":["Miami"]}}}}},"type":{"description":"Role mining potential type","type":"string","enum":["SPECIALIZED","COMMON"],"example":"SPECIALIZED"}}},"type":{"description":"Role mining potential type.","type":"string","enum":["SPECIALIZED","COMMON"],"example":"SPECIALIZED"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"ids":["entId1","entId2"],"exclude":true},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Edit entitlements for a potential role to exclude some entitlements","description":{"content":"This endpoint adds or removes entitlements from an exclusion list for a potential role.","type":"text/plain"},"url":{"path":["role-mining-sessions",":sessionId","potential-roles",":potentialRoleId","edit-entitlements"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The role mining session id","type":"text/plain"},"type":"any","value":"","key":"sessionId"},{"disabled":false,"description":{"content":"(Required) A potential role id in a role mining session","type":"text/plain"},"type":"any","value":"","key":"potentialRoleId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Edit entitlements for a potential role to exclude some entitlements' (update-entitlements-potential-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Edit entitlements for a potential role to exclude some entitlements + + + +This endpoint adds or removes entitlements from an exclusion list for a potential role. + +
    Path Parameters
    Request Body required
    + +Role mining session parameters + +
    + +Adds or removes entitlements from a potential role's entitlement exclusion list. + +
    Schema
      createdBy object
      + +The session created by details. + +
      identityDistribution object[]
      + +Identity attribute distribution. + +
      session object
      + +The session parameters of the potential role. + +
      scope object
      + +The scope of identities for this role mining session + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-identity-profile.api.mdx b/products/idn/api/beta/update-identity-profile.api.mdx new file mode 100644 index 000000000..de2fb08c5 --- /dev/null +++ b/products/idn/api/beta/update-identity-profile.api.mdx @@ -0,0 +1,116 @@ +--- +id: update-identity-profile +sidebar_label: Update the Identity Profile +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateIdentityProfile","tags":["Identity Profiles"],"description":"This updates the specified Identity Profile.\nA token with ORG_ADMIN authority is required to call this API to update the Identity Profile. Some fields of the Schema cannot be updated. These fields are listed below.\n* id\n* name\n* created\n* modified","parameters":[{"in":"path","name":"identity-profile-id","schema":{"type":"string","format":"uuid"},"required":true,"description":"The Identity Profile ID","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"description":"A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"examples":{"add-attribute-transform":{"summary":"Add an attribute transform","value":[{"op":"add","path":"/identityAttributeConfig/attributeTransforms/0","value":{"identityAttributeName":"location","transformDefinition":{"type":"accountAttribute","attributes":{"sourceName":"Employees","attributeName":"location","sourceId":"2c91808878b7d63b0178c66ffcdc4ce4"}}}}]}}}}},"responses":{"200":{"description":"The updated Identity Profile.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"},"modified":{"description":"Last modification date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}},{"type":"object","required":["authoritativeSource"],"properties":{"description":{"type":"string","nullable":true,"description":"The description of the Identity Profile.","example":"My custom flat file profile"},"owner":{"type":"object","description":"The owner of the Identity Profile.","nullable":true,"properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Type of the object to which this reference applies","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"priority":{"type":"integer","format":"int64","description":"The priority for an Identity Profile.","example":10},"authoritativeSource":{"type":"object","properties":{"type":{"type":"string","enum":["SOURCE"],"description":"Type of the object to which this reference applies","example":"SOURCE"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"HR Active Directory"}},"description":"The authoritative source for this Identity Profile."},"identityRefreshRequired":{"type":"boolean","default":false,"description":"True if a identity refresh is needed. Typically triggered when a change on the source has been made","example":true},"identityCount":{"type":"integer","description":"The number of identities that belong to the Identity Profile.","format":"int32","example":8},"identityAttributeConfig":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If the profile or mapping is enabled","example":true,"default":true},"attributeTransforms":{"type":"array","items":{"type":"object","properties":{"identityAttributeName":{"type":"string","description":"Name of the identity attribute","example":"email"},"transformDefinition":{"description":"The seaspray transformation definition","type":"object","properties":{"type":{"type":"string","description":"The type of the transform definition.","example":"accountAttribute"},"attributes":{"type":"object","nullable":true,"additionalProperties":true,"description":"Arbitrary key-value pairs to store any metadata for the object","example":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}}}}}}}}},"identityExceptionReportReference":{"type":"object","nullable":true,"properties":{"taskResultId":{"type":"string","format":"uuid","description":"The id of the task result","example":"2c918086795cd09201795d5f7d7533df"},"reportName":{"type":"string","example":"My annual report","description":"The name of the report"}}},"hasTimeBasedAttr":{"description":"Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile.","type":"boolean","default":true,"example":true}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:identity-profile:manage"]}],"method":"patch","path":"/identity-profiles/{identity-profile-id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update the Identity Profile","description":{"content":"This updates the specified Identity Profile.\nA token with ORG_ADMIN authority is required to call this API to update the Identity Profile. Some fields of the Schema cannot be updated. These fields are listed below.\n* id\n* name\n* created\n* modified","type":"text/plain"},"url":{"path":["identity-profiles",":identity-profile-id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Identity Profile ID","type":"text/plain"},"type":"any","value":"","key":"identity-profile-id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update the Identity Profile' (update-identity-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update the Identity Profile + + + +This updates the specified Identity Profile. +A token with ORG_ADMIN authority is required to call this API to update the Identity Profile. Some fields of the Schema cannot be updated. These fields are listed below. +* id +* name +* created +* modified + +
    Path Parameters
    Request Body array required
    + +A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +
      value object
      + +The value to be used for the operation, required for "add" and "replace" operations + +
      anyOf
    • string
    • integer
      • anyOf
    • string
    • integer
    + +The updated Identity Profile. + +
    Schema
      owner object
      + +The owner of the Identity Profile. + +
      authoritativeSource object
      + +The authoritative source for this Identity Profile. + +
      identityAttributeConfig object
      attributeTransforms object[]
      transformDefinition object
      + +The seaspray transformation definition + +
      attributes object
      + +Arbitrary key-value pairs to store any metadata for the object + +
      identityExceptionReportReference object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-lifecycle-states.api.mdx b/products/idn/api/beta/update-lifecycle-states.api.mdx new file mode 100644 index 000000000..97c61375e --- /dev/null +++ b/products/idn/api/beta/update-lifecycle-states.api.mdx @@ -0,0 +1,94 @@ +--- +id: update-lifecycle-states +sidebar_label: Update Lifecycle State +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateLifecycleStates","tags":["Lifecycle States"],"description":"This API updates individual lifecycle state fields using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nA token with ORG_ADMIN or API authority is required to call this API.\n","parameters":[{"in":"path","name":"identity-profile-id","description":"Identity Profile ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"lifecycle-state-id","description":"Lifecycle State ID","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nThe following fields can be updated:\n* enabled\n* description\n* accountActions\n* accessProfileIds\n* emailNotificationOption\n","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"example":[{"op":"replace","path":"/description","value":"Updated description!"},{"op":"replace","path":"/accessProfileIds","value":["2c918087742bab150174407a80f3125e","2c918087742bab150174407a80f3124f"]},{"op":"replace","path":"/accountActions","value":[{"action":"ENABLE","sourceIds":["2c9180846a2f82fb016a481c1b1560c5","2c9180846a2f82fb016a481c1b1560cc"]},{"action":"DISABLE","sourceIds":["2c91808869a0c9980169a207258513fb"]}]},{"op":"replace","path":"/emailNotificationOption","value":{"notifyManagers":true,"notifyAllAdmins":false,"notifySpecificUsers":false,"emailAddressList":[]}}]}}},"responses":{"200":{"description":"Updated lifecycle-state.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"example":"2c9180835d2e5168015d32f890ca1581","description":"lifecycle stat id."},"name":{"type":"string","readOnly":true,"example":"Lifecycle Name","description":"Lifecycle-state name."},"technicalName":{"type":"string","readOnly":true,"example":"lifecycleTechnicalName","description":"The technical name for lifecycle state. This is for internal use."},"description":{"type":"string","example":"LifecycleDescription","description":"Lifecycle state description."},"created":{"type":"string","readOnly":true,"format":"date-time","example":"2015-05-28T14:07:17Z","description":"Lifecycle state created date."},"modified":{"type":"string","readOnly":true,"format":"date-time","example":"2015-05-28T14:07:17Z","description":"Lifecycle state modified date."},"enabled":{"type":"boolean","example":true,"description":"Whether the lifecycle state is enabled or disabled."},"identityCount":{"type":"integer","format":"int32","readOnly":true,"example":12,"description":"Number of identities that have the lifecycle state."},"emailNotificationOption":{"type":"object","properties":{"notifyManagers":{"type":"boolean","example":true,"description":"If true, then the manager is notified of the lifecycle state change."},"notifyAllAdmins":{"type":"boolean","example":true,"description":"If true, then all the admins are notified of the lifecycle state change."},"notifySpecificUsers":{"type":"boolean","example":true,"description":"If true, then the users specified in \"emailAddressList\" below are notified of lifecycle state change."},"emailAddressList":{"type":"array","example":["test@test.com","test2@test.com"],"items":{"type":"string"},"description":"List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change."}}},"accountActions":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"ENABLE","description":"Describes if action will be enabled or disabled","enum":["ENABLE","DISABLE"]},"sourceIds":{"type":"array","items":{"example":"2c918084660f45d6016617daa9210584","description":"Source Id","type":"string"},"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"],"description":"List of source IDs. The sources must have the ENABLE feature or flat file source. See \"/sources\" endpoint for source features."}}}},"accessProfileIds":{"type":"array","items":{"type":"string"},"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"],"description":"List of access-profile IDs that are associated with the lifecycle state."}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update Lifecycle State","description":{"content":"This API updates individual lifecycle state fields using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nA token with ORG_ADMIN or API authority is required to call this API.\n","type":"text/plain"},"url":{"path":["identity-profiles",":identity-profile-id","lifecycle-states",":lifecycle-state-id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Identity Profile ID","type":"text/plain"},"type":"any","value":"","key":"identity-profile-id"},{"disabled":false,"description":{"content":"(Required) Lifecycle State ID","type":"text/plain"},"type":"any","value":"","key":"lifecycle-state-id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Lifecycle State' (update-lifecycle-states)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Lifecycle State + + + +This API updates individual lifecycle state fields using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +A token with ORG_ADMIN or API authority is required to call this API. + + +
    Path Parameters
    Request Body array required
    + +A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +The following fields can be updated: +* enabled +* description +* accountActions +* accessProfileIds +* emailNotificationOption + + +
      value object
      + +The value to be used for the operation, required for "add" and "replace" operations + +
      anyOf
    • string
    • integer
      • anyOf
    • string
    • integer
    + +Updated lifecycle-state. + +
    Schema
      emailNotificationOption object
      accountActions object[]
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-managed-client-status.api.mdx b/products/idn/api/beta/update-managed-client-status.api.mdx new file mode 100644 index 000000000..792a4f92c --- /dev/null +++ b/products/idn/api/beta/update-managed-client-status.api.mdx @@ -0,0 +1,87 @@ +--- +id: update-managed-client-status +sidebar_label: Handle status request from client +hide_title: true +hide_table_of_contents: true +api: {"tags":["Managed Clients"],"description":"Update a status detail passed in from the client","operationId":"updateManagedClientStatus","parameters":[{"name":"id","in":"path","description":"ID of the Managed Client Status to update","required":true,"schema":{"type":"string","example":"aClientId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"Managed Client Status","type":"object","required":["body","status","type","timestamp"],"properties":{"body":{"description":"ManagedClientStatus body information","type":"object","example":{"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":{"type":"string","enum":["NORMAL","UNDEFINED","NOT_CONFIGURED","CONFIGURING","WARNING","ERROR","FAILED"],"description":"status of the Managed Client"},"type":{"description":"type of the Managed Client","type":"string","example":"CCG","nullable":true,"enum":["CCG","VA","INTERNAL","IIQ_HARVESTER",null]},"timestamp":{"description":"timestamp on the Client Status update","type":"string","format":"date-time","example":"2020-01-01T00:00:00.000000Z"}}}}}},"responses":{"200":{"description":"Responds with the updated Managed Client Status.","content":{"application/json":{"schema":{"description":"Managed Client Status","type":"object","required":["body","status","type","timestamp"],"properties":{"body":{"description":"ManagedClientStatus body information","type":"object","example":{"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":{"type":"string","enum":["NORMAL","UNDEFINED","NOT_CONFIGURED","CONFIGURING","WARNING","ERROR","FAILED"],"description":"status of the Managed Client"},"type":{"description":"type of the Managed Client","type":"string","example":"CCG","nullable":true,"enum":["CCG","VA","INTERNAL","IIQ_HARVESTER",null]},"timestamp":{"description":"timestamp on the Client Status update","type":"string","format":"date-time","example":"2020-01-01T00:00:00.000000Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:managed-client-status:manage"]}],"method":"post","path":"/managed-clients/{id}/status","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"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":"NORMAL","type":"CCG","timestamp":"2020-01-01T00:00:00.000000Z"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Handle status request from client","description":{"content":"Update a status detail passed in from the client","type":"text/plain"},"url":{"path":["managed-clients",":id","status"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Managed Client Status to update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Handle status request from client' (update-managed-client-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Handle status request from client + + + +Update a status detail passed in from the client + +
    Path Parameters
    Request Body required
    + +Responds with the updated Managed Client Status. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-non-employee-record.api.mdx b/products/idn/api/beta/update-non-employee-record.api.mdx new file mode 100644 index 000000000..69250fff6 --- /dev/null +++ b/products/idn/api/beta/update-non-employee-record.api.mdx @@ -0,0 +1,99 @@ +--- +id: update-non-employee-record +sidebar_label: Update Non-Employee Record +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateNonEmployeeRecord","security":[{"oauth2":["idn:nelm:manage"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This request will update a non-employee record.","parameters":[{"in":"path","name":"id","description":"Non-employee record id (UUID)","required":true,"example":"2c91808b6ef1d43e016efba0ce470904","schema":{"type":"string"}}],"requestBody":{"description":"Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accountName":{"type":"string","description":"Requested identity account name.","example":"william.smith"},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"sourceId":{"type":"string","description":"Non-Employee's source id.","example":"2c91808568c529c60168cca6f90c1313"},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported."},"startDate":{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2020-03-24T00:00:00-05:00"},"endDate":{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2021-03-25T00:00:00-05:00"}},"required":["accountName","firstName","lastName","email","phone","manager","sourceId","startDate","endDate"]}}}},"responses":{"200":{"description":"An updated non-employee record.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee record id."},"accountName":{"type":"string","description":"Requested identity account name."},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"sourceId":{"type":"string","description":"Non-Employee's source id.","example":"2c91808568c529c60168cca6f90c1313"},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee."},"startDate":{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2019-08-23T18:52:59.162Z"},"endDate":{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2020-08-23T18:52:59.162Z"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/non-employee-records/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"accountName":"william.smith","firstName":"William","lastName":"Smith","email":"william.smith@example.com","phone":"5555555555","manager":"jane.doe","sourceId":"2c91808568c529c60168cca6f90c1313","data":{},"startDate":"2020-03-24T00:00:00-05:00","endDate":"2021-03-25T00:00:00-05:00"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update Non-Employee Record","description":{"content":"This request will update a non-employee record.","type":"text/plain"},"url":{"path":["non-employee-records",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Non-employee record id (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Non-Employee Record' (update-non-employee-record)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Non-Employee Record + + + +This request will update a non-employee record. + +
    Path Parameters
    Request Body required
    + +Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + +
      data object
      + +Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported. + +
    • property name* string
    + +An updated non-employee record. + +
    Schema
      data object
      + +Attribute blob/bag for a non-employee. + +
    • property name* string
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-password-dictionary.api.mdx b/products/idn/api/beta/update-password-dictionary.api.mdx new file mode 100644 index 000000000..f8da7eef0 --- /dev/null +++ b/products/idn/api/beta/update-password-dictionary.api.mdx @@ -0,0 +1,124 @@ +--- +id: update-password-dictionary +sidebar_label: Update Password Dictionary +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updatePasswordDictionary","tags":["Password Dictionary"],"description":"This updates password dictionary for the organization.\nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:password-dictionary:manage"]}],"requestBody":{"required":true,"description":"\nThe password dictionary file can contain lines that are:\n1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing\n2. empty lines\n3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines\n4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed;\n maximum length of the line is 128 Unicode codepoints\n\n\nPassword dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line).\n Password dict file must contain UTF-8 characters only.\n\n# Sample password text file\n\n```\n\n# Password dictionary small test file\n\nlocale=en_US\n\n# Password dictionary prohibited words\n\nqwerty\nabcd\naaaaa\npassword\nqazxsws\n\n```","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Successfully updated."},"201":{"description":"Created."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/password-dictionary","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update Password Dictionary","description":{"content":"This updates password dictionary for the organization.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["password-dictionary"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"formdata","formdata":[]},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Password Dictionary' (update-password-dictionary)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Password Dictionary + + + +This updates password dictionary for the organization. +A token with ORG_ADMIN authority is required to call this API. + +
    Request Body required
    + + +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +
    + +Successfully updated. + +
    + +Created. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-password-org-config.api.mdx b/products/idn/api/beta/update-password-org-config.api.mdx new file mode 100644 index 000000000..a5c002cdb --- /dev/null +++ b/products/idn/api/beta/update-password-org-config.api.mdx @@ -0,0 +1,75 @@ +--- +id: update-password-org-config +sidebar_label: Update Password Org Config +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updatePasswordOrgConfig","tags":["Password Configuration"],"description":"This API updates the password org config for specified fields. Other fields will keep original value. Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'","security":[{"oauth2":["idn:password-org-config:write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customInstructionsEnabled":{"type":"boolean","description":"Indicator whether custom password instructions feature is enabled. The default value is false.","default":false,"example":true},"digitTokenEnabled":{"type":"boolean","description":"Indicator whether \"digit token\" feature is enabled. The default value is false.","default":false,"example":true},"digitTokenDurationMinutes":{"type":"integer","format":"int32","description":"The duration of \"digit token\" in minutes. The default value is 5.","minimum":1,"maximum":60,"default":5,"example":10},"digitTokenLength":{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}},"example":{"digitTokenEnabled":true,"digitTokenDurationMinutes":12}}}},"responses":{"200":{"description":"Reference to the password org config.","content":{"application/json":{"schema":{"type":"object","properties":{"customInstructionsEnabled":{"type":"boolean","description":"Indicator whether custom password instructions feature is enabled. The default value is false.","default":false,"example":true},"digitTokenEnabled":{"type":"boolean","description":"Indicator whether \"digit token\" feature is enabled. The default value is false.","default":false,"example":true},"digitTokenDurationMinutes":{"type":"integer","format":"int32","description":"The duration of \"digit token\" in minutes. The default value is 5.","minimum":1,"maximum":60,"default":5,"example":10},"digitTokenLength":{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}},"example":{"customInstructionsEnabled":true,"digitTokenDurationMinutes":12,"digitTokenEnabled":true,"digitTokenLength":6}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/password-org-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"customInstructionsEnabled":true,"digitTokenEnabled":true,"digitTokenDurationMinutes":10,"digitTokenLength":9},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update Password Org Config","description":{"content":"This API updates the password org config for specified fields. Other fields will keep original value. Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'","type":"text/plain"},"url":{"path":["password-org-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Password Org Config' (update-password-org-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Password Org Config + + + +This API updates the password org config for specified fields. Other fields will keep original value. Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +
    Request Body required
      = 1` and `<= 60`"} defaultValue={5}>= 6` and `<= 18`"} defaultValue={6}>
    + +Reference to the password org config. + +
    Schema
      = 1` and `<= 60`"} defaultValue={5}>= 6` and `<= 18`"} defaultValue={6}>
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-password-sync-group.api.mdx b/products/idn/api/beta/update-password-sync-group.api.mdx new file mode 100644 index 000000000..e745c92ef --- /dev/null +++ b/products/idn/api/beta/update-password-sync-group.api.mdx @@ -0,0 +1,87 @@ +--- +id: update-password-sync-group +sidebar_label: Update Password Sync Group by ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updatePasswordSyncGroup","tags":["Password Sync Groups"],"description":"This API updates the specified password sync group. A token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:password-sync-group-management:write"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of password sync group to update.","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the sync group","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"},"name":{"description":"Name of the sync group","type":"string","example":"Password Sync Group 1"},"passwordPolicyId":{"type":"string","description":"ID of the password policy","example":"2c91808d744ba0ce01746f93b6204501"},"sourceIds":{"type":"array","description":"List of password managed sources IDs","items":{"type":"string"},"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}},"example":{"id":"6881f631-3bd5-4213-9c75-8e05cc3e35dd","name":"Password Sync Group 2","passwordPolicyId":"2c91808d744ba0ce01746f93b6204501","sourceIds":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}}},"responses":{"200":{"description":"Reference to the password sync group.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the sync group","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"},"name":{"description":"Name of the sync group","type":"string","example":"Password Sync Group 1"},"passwordPolicyId":{"type":"string","description":"ID of the password policy","example":"2c91808d744ba0ce01746f93b6204501"},"sourceIds":{"type":"array","description":"List of password managed sources IDs","items":{"type":"string"},"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}},"example":{"id":"6881f631-3bd5-4213-9c75-8e05cc3e35dd","name":"Password Sync Group 2","passwordPolicyId":"2c91808d744ba0ce01746f93b6204501","sourceIds":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/password-sync-groups/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"id":"6881f631-3bd5-4213-9c75-8e05cc3e35dd","name":"Password Sync Group 1","passwordPolicyId":"2c91808d744ba0ce01746f93b6204501","sourceIds":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update Password Sync Group by ID","description":{"content":"This API updates the specified password sync group. A token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["password-sync-groups",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of password sync group to update.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Password Sync Group by ID' (update-password-sync-group)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Password Sync Group by ID + + + +This API updates the specified password sync group. A token with ORG_ADMIN authority is required to call this API. + +
    Path Parameters
    Request Body required
    + +Reference to the password sync group. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-policy-schedule.api.mdx b/products/idn/api/beta/update-policy-schedule.api.mdx new file mode 100644 index 000000000..a01397d44 --- /dev/null +++ b/products/idn/api/beta/update-policy-schedule.api.mdx @@ -0,0 +1,110 @@ +--- +id: update-policy-schedule +sidebar_label: Update SOD Policy schedule +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updatePolicySchedule","tags":["SOD Policy"],"description":"This updates schedule for a specified SOD policy.\nRequires role of ORG_ADMIN.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the SOD policy to update its schedule.","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"SOD Policy schedule name","example":"SCH-1584312283015"},"created":{"type":"string","format":"date-time","description":"The time when this SOD policy schedule is created.","example":"2020-01-01T00:00:00.000000Z"},"modified":{"type":"string","format":"date-time","description":"The time when this SOD policy schedule is modified.","example":"2020-01-01T00:00:00.000000Z"},"description":{"type":"string","description":"SOD Policy schedule description","example":"Schedule for policy xyz"},"schedule":{"type":"object","description":"The schedule information.","properties":{"type":{"description":"Enum representing the currently supported schedule types.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["DAILY","WEEKLY","MONTHLY","CALENDAR"],"example":"WEEKLY"},"days":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The days to execute the search.\n\nIf `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`.\n\nIf `type` is `MONTHLY`, the values will be a number in double quotes, like `\"1\"`, `\"10\"`, or `\"28\"`. Optionally, the value `\"L\"` can be used to refer to the last day of the month.\n","example":{"type":"LIST","values":["MON","WED","FRI"]},"nullable":true}]},"hours":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The hours selected.","example":{"type":"RANGE","values":["9","18"],"interval":3}}]},"expiration":{"description":"The schedule expiration date. Latest possible expiration date is '2038-01-19T03:14:07+0000'","type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"},"timeZoneId":{"description":"The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org's default timezone is used.","nullable":true,"type":"string","example":"GMT-06:00"}},"required":["type","hours"]},"recipients":{"type":"array","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}},"emailEmptyResults":{"type":"boolean","description":"Indicates if empty results need to be emailed","example":false},"creatorId":{"type":"string","description":"Policy's creator ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"modifierId":{"type":"string","description":"Policy's modifier ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"}}}}}},"responses":{"200":{"description":"SOD policy by ID.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"SOD Policy schedule name","example":"SCH-1584312283015"},"created":{"type":"string","format":"date-time","description":"The time when this SOD policy schedule is created.","example":"2020-01-01T00:00:00.000000Z"},"modified":{"type":"string","format":"date-time","description":"The time when this SOD policy schedule is modified.","example":"2020-01-01T00:00:00.000000Z"},"description":{"type":"string","description":"SOD Policy schedule description","example":"Schedule for policy xyz"},"schedule":{"type":"object","description":"The schedule information.","properties":{"type":{"description":"Enum representing the currently supported schedule types.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["DAILY","WEEKLY","MONTHLY","CALENDAR"],"example":"WEEKLY"},"days":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The days to execute the search.\n\nIf `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`.\n\nIf `type` is `MONTHLY`, the values will be a number in double quotes, like `\"1\"`, `\"10\"`, or `\"28\"`. Optionally, the value `\"L\"` can be used to refer to the last day of the month.\n","example":{"type":"LIST","values":["MON","WED","FRI"]},"nullable":true}]},"hours":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The hours selected.","example":{"type":"RANGE","values":["9","18"],"interval":3}}]},"expiration":{"description":"The schedule expiration date. Latest possible expiration date is '2038-01-19T03:14:07+0000'","type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"},"timeZoneId":{"description":"The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org's default timezone is used.","nullable":true,"type":"string","example":"GMT-06:00"}},"required":["type","hours"]},"recipients":{"type":"array","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}},"emailEmptyResults":{"type":"boolean","description":"Indicates if empty results need to be emailed","example":false},"creatorId":{"type":"string","description":"Policy's creator ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"modifierId":{"type":"string","description":"Policy's modifier ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/sod-policies/{id}/schedule","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"SCH-1584312283015","created":"2020-01-01T00:00:00.000000Z","modified":"2020-01-01T00:00:00.000000Z","description":"Schedule for policy xyz","schedule":{"type":"WEEKLY","days":{"type":"LIST","values":["MON","WED","FRI"]},"hours":{"type":"RANGE","values":["9","18"],"interval":3},"expiration":"2018-06-25T20:22:28.104Z","timeZoneId":"GMT-06:00"},"recipients":[{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"}],"emailEmptyResults":false,"creatorId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","modifierId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update SOD Policy schedule","description":{"content":"This updates schedule for a specified SOD policy.\nRequires role of ORG_ADMIN.","type":"text/plain"},"url":{"path":["sod-policies",":id","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the SOD policy to update its schedule.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update SOD Policy schedule' (update-policy-schedule)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update SOD Policy schedule + + + +This updates schedule for a specified SOD policy. +Requires role of ORG_ADMIN. + +
    Path Parameters
    Request Body required
      schedule object
      + +The schedule information. + +
      days object
      + +The days to execute the search. + +If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. + +If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. + + +
      hours object
      + +The hours selected. + +
      recipients object[]
    + +SOD policy by ID. + +
    Schema
      schedule object
      + +The schedule information. + +
      days object
      + +The days to execute the search. + +If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. + +If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. + + +
      hours object
      + +The hours selected. + +
      recipients object[]
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-provisioning-policies-in-bulk.api.mdx b/products/idn/api/beta/update-provisioning-policies-in-bulk.api.mdx new file mode 100644 index 000000000..dca7c1acd --- /dev/null +++ b/products/idn/api/beta/update-provisioning-policies-in-bulk.api.mdx @@ -0,0 +1,88 @@ +--- +id: update-provisioning-policies-in-bulk +sidebar_label: Bulk Update Provisioning Policies +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateProvisioningPoliciesInBulk","tags":["Sources"],"description":"This end-point updates a list of provisioning policies on the specified source in IdentityNow.\nA token with API, or ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:provisioning-policy:manage"]}],"parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source id.","example":"2c9180835d191a86015d28455b4a2329"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"the provisioning policy name","example":"example provisioning policy for inactive identities"},"description":{"type":"string","description":"the description of the provisioning policy","example":"this provisioning policy creates access based on an identity going inactive"},"usageType":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"userName"},"transform":{"type":"object","description":"The transform to apply to the field","example":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"default":{}},"attributes":{"type":"object","description":"Attributes required for the transform","example":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"}},"type":{"type":"string","description":"The type of the attribute.","example":"string"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","default":false,"example":false}}}}}}}}}},"responses":{"200":{"description":"A list of the ProvisioningPolicyDto was successfully replaced.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"the provisioning policy name","example":"example provisioning policy for inactive identities"},"description":{"type":"string","description":"the description of the provisioning policy","example":"this provisioning policy creates access based on an identity going inactive"},"usageType":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"userName"},"transform":{"type":"object","description":"The transform to apply to the field","example":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"default":{}},"attributes":{"type":"object","description":"Attributes required for the transform","example":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"}},"isRequired":{"type":"boolean","readOnly":true,"description":"Flag indicating whether or not the attribute is required.","default":false,"example":false},"type":{"type":"string","description":"The type of the attribute.","example":"string"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","default":false,"example":false}}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sources/{sourceId}/provisioning-policies/bulk-update","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"name":"example provisioning policy for inactive identities","description":"this provisioning policy creates access based on an identity going inactive","usageType":"CREATE","fields":[{"name":"userName","transform":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"attributes":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"},"type":"string","isMultiValued":false}]}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Bulk Update Provisioning Policies","description":{"content":"This end-point updates a list of provisioning policies on the specified source in IdentityNow.\nA token with API, or ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":sourceId","provisioning-policies","bulk-update"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id.","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Bulk Update Provisioning Policies' (update-provisioning-policies-in-bulk)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Bulk Update Provisioning Policies + + + +This end-point updates a list of provisioning policies on the specified source in IdentityNow. +A token with API, or ORG_ADMIN authority is required to call this API. + +
    Path Parameters
    Request Body array required
      fields object[]
    + +A list of the ProvisioningPolicyDto was successfully replaced. + +
    Schema array
      fields object[]
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-provisioning-policy.api.mdx b/products/idn/api/beta/update-provisioning-policy.api.mdx new file mode 100644 index 000000000..73e2839f8 --- /dev/null +++ b/products/idn/api/beta/update-provisioning-policy.api.mdx @@ -0,0 +1,98 @@ +--- +id: update-provisioning-policy +sidebar_label: Partial update of Provisioning Policy +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateProvisioningPolicy","tags":["Sources"],"description":"This API selectively updates an existing Provisioning Policy using a JSONPatch payload.\nTransforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.\nRefer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","security":[{"oauth2":["idn:provisioning-policy:update"]}],"parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source id.","example":"2c9180835d191a86015d28455b4a2329"},{"in":"path","name":"usageType","required":true,"schema":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"description":"The type of ProvisioningPolicy usage."}],"requestBody":{"required":true,"description":"The JSONPatch payload used to update the schema.","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"examples":{"add-field":{"summary":"Add a field to the beginning of the list","value":[{"op":"add","path":"/fields/0","value":{"name":"email","transform":{"type":"identityAttribute","attributes":{"name":"email"}},"attributes":{},"isRequired":false,"type":"string","isMultiValued":false}}]}}}}},"responses":{"200":{"description":"The ProvisioningPolicyDto was successfully updated.","content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"the provisioning policy name","example":"example provisioning policy for inactive identities"},"description":{"type":"string","description":"the description of the provisioning policy","example":"this provisioning policy creates access based on an identity going inactive"},"usageType":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"userName"},"transform":{"type":"object","description":"The transform to apply to the field","example":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"default":{}},"attributes":{"type":"object","description":"Attributes required for the transform","example":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"}},"isRequired":{"type":"boolean","readOnly":true,"description":"Flag indicating whether or not the attribute is required.","default":false,"example":false},"type":{"type":"string","description":"The type of the attribute.","example":"string"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","default":false,"example":false}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/sources/{sourceId}/provisioning-policies/{usageType}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Partial update of Provisioning Policy","description":{"content":"This API selectively updates an existing Provisioning Policy using a JSONPatch payload.\nTransforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.\nRefer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":sourceId","provisioning-policies",":usageType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id.","type":"text/plain"},"type":"any","value":"","key":"sourceId"},{"disabled":false,"description":{"content":"(Required) The type of ProvisioningPolicy usage.","type":"text/plain"},"type":"any","value":"","key":"usageType"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Partial update of Provisioning Policy' (update-provisioning-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Partial update of Provisioning Policy + + + +This API selectively updates an existing Provisioning Policy using a JSONPatch payload. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. +A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +
    Path Parameters
    Request Body array required
    + +The JSONPatch payload used to update the schema. + +
      value object
      + +The value to be used for the operation, required for "add" and "replace" operations + +
      anyOf
    • string
    • integer
      • anyOf
    • string
    • integer
    + +The ProvisioningPolicyDto was successfully updated. + +
    Schema
      fields object[]
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-public-identity-config.api.mdx b/products/idn/api/beta/update-public-identity-config.api.mdx new file mode 100644 index 000000000..7b634c644 --- /dev/null +++ b/products/idn/api/beta/update-public-identity-config.api.mdx @@ -0,0 +1,83 @@ +--- +id: update-public-identity-config +sidebar_label: Update Public Identity Config +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updatePublicIdentityConfig","tags":["Public Identities Config"],"description":"This updates the details of public identity config.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org","properties":{"attributes":{"type":"array","items":{"type":"object","description":"Used to map an attribute key for an Identity to its display name.","properties":{"key":{"type":"string","description":"the key of the attribute","example":"country"},"name":{"type":"string","description":"the display name of the attribute","example":"Country"}}}},"modifiedBy":{"type":"object","nullable":true,"description":"The manager for the identity.","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of identity.","example":"Thomas Edison"}}},"modified":{"type":"string","description":"the date/time of the modification","format":"date-time","example":"2018-06-25T20:22:28.104Z"}}}}}},"responses":{"200":{"description":"Request succeeded.","content":{"application/json":{"schema":{"type":"object","description":"Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org","properties":{"attributes":{"type":"array","items":{"type":"object","description":"Used to map an attribute key for an Identity to its display name.","properties":{"key":{"type":"string","description":"the key of the attribute","example":"country"},"name":{"type":"string","description":"the display name of the attribute","example":"Country"}}}},"modifiedBy":{"type":"object","nullable":true,"description":"The manager for the identity.","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of identity.","example":"Thomas Edison"}}},"modified":{"type":"string","description":"the date/time of the modification","format":"date-time","example":"2018-06-25T20:22:28.104Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/public-identities-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"attributes":[{"key":"country","name":"Country"}],"modifiedBy":{"type":"IDENTITY","id":"2c9180a46faadee4016fb4e018c20639","name":"Thomas Edison"},"modified":"2018-06-25T20:22:28.104Z"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update Public Identity Config","description":{"content":"This updates the details of public identity config.","type":"text/plain"},"url":{"path":["public-identities-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Public Identity Config' (update-public-identity-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Public Identity Config + + + +This updates the details of public identity config. + +
    Request Body required
      attributes object[]
      modifiedBy object
      + +The manager for the identity. + +
    + +Request succeeded. + +
    Schema
      attributes object[]
      modifiedBy object
      + +The manager for the identity. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-recommendations-config.api.mdx b/products/idn/api/beta/update-recommendations-config.api.mdx new file mode 100644 index 000000000..138d2d411 --- /dev/null +++ b/products/idn/api/beta/update-recommendations-config.api.mdx @@ -0,0 +1,71 @@ +--- +id: update-recommendations-config +sidebar_label: Update certification recommendation config values +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateRecommendationsConfig","tags":["IAI Recommendations"],"description":"Updates configuration attributes used by certification recommendations.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"recommenderFeatures":{"type":"array","items":{"type":"string"},"description":"List of identity attributes to use for calculating certification recommendations","example":["jobTitle","location","peer_group","department","active"]},"peerGroupPercentageThreshold":{"type":"number","description":"The percent value that the recommendation calculation must surpass to produce a YES recommendation","minimum":0,"maximum":1,"example":0.5},"forceRefresh":{"type":"boolean","description":"If true, rulesRecommenderConfig will be refreshed with new programatically selected attribute and threshold values on the next pipeline run","example":false}}}}}},"responses":{"200":{"description":"Cert recommendation configuration attributes after update","content":{"application/json":{"schema":{"type":"object","properties":{"recommenderFeatures":{"type":"array","items":{"type":"string"},"description":"List of identity attributes to use for calculating certification recommendations","example":["jobTitle","location","peer_group","department","active"]},"peerGroupPercentageThreshold":{"type":"number","description":"The percent value that the recommendation calculation must surpass to produce a YES recommendation","minimum":0,"maximum":1,"example":0.5},"forceRefresh":{"type":"boolean","description":"If true, rulesRecommenderConfig will be refreshed with new programatically selected attribute and threshold values on the next pipeline run","example":false}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":[]}],"method":"put","path":"/recommendations/config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"recommenderFeatures":["jobTitle","location","peer_group","department","active"],"peerGroupPercentageThreshold":0.5,"forceRefresh":false},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update certification recommendation config values","description":{"content":"Updates configuration attributes used by certification recommendations.","type":"text/plain"},"url":{"path":["recommendations","config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update certification recommendation config values' (update-recommendations-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update certification recommendation config values + + + +Updates configuration attributes used by certification recommendations. + +
    Request Body required
    + +Cert recommendation configuration attributes after update + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-sod-policy.api.mdx b/products/idn/api/beta/update-sod-policy.api.mdx new file mode 100644 index 000000000..c40387720 --- /dev/null +++ b/products/idn/api/beta/update-sod-policy.api.mdx @@ -0,0 +1,104 @@ +--- +id: update-sod-policy +sidebar_label: Update SOD policy by ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateSodPolicy","tags":["SOD Policy"],"description":"This updates a specified SOD policy.\nRequires role of ORG_ADMIN.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the SOD policy to update.","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Policy id","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"name":{"type":"string","description":"Policy Business Name","example":"policy-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this SOD policy is created.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"modified":{"type":"string","format":"date-time","description":"The time when this SOD policy is modified.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"description":{"type":"string","description":"Optional description of the SOD policy","example":"This policy ensures compliance of xyz","nullable":true},"ownerRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"externalPolicyReference":{"type":"string","description":"Optional External Policy Reference","example":"XYZ policy","nullable":true},"policyQuery":{"type":"string","description":"Search query of the SOD policy","example":"@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)"},"compensatingControls":{"type":"string","description":"Optional compensating controls(Mitigating Controls)","example":"Have a manager review the transaction decisions for their \"out of compliance\" employee","nullable":true},"correctionAdvice":{"type":"string","description":"Optional correction advice","example":"Based on the role of the employee, managers should remove access that is not required for their job function.","nullable":true},"state":{"type":"string","description":"whether the policy is enforced or not","enum":["ENFORCED","NOT_ENFORCED"],"example":"ENFORCED"},"tags":{"type":"array","description":"tags for this policy object","example":["TAG1","TAG2"],"items":{"type":"string"}},"creatorId":{"type":"string","description":"Policy's creator ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"modifierId":{"type":"string","description":"Policy's modifier ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","nullable":true,"readOnly":true},"violationOwnerAssignmentConfig":{"nullable":true,"type":"object","properties":{"assignmentRule":{"type":"string","enum":["MANAGER","STATIC",null],"description":"Details about the violations owner.\nMANAGER - identity's manager\nSTATIC - Governance Group or Identity","example":"MANAGER","nullable":true},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"nullable":true}]}}},"scheduled":{"type":"boolean","description":"defines whether a policy has been scheduled or not","example":true,"default":false},"type":{"type":"string","description":"whether a policy is query based or conflicting access based","default":"GENERAL","enum":["GENERAL","CONFLICTING_ACCESS_BASED"],"example":"GENERAL"},"conflictingAccessCriteria":{"allOf":[{"type":"object","properties":{"leftCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"DTO type","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}},"rightCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"DTO type","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}}}},{"nullable":true}]}}},"examples":{"Conflicting Access Based Policy":{"value":{"id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"Conflicting-Policy-Name","created":"2020-01-01T00:00:00.000000Z","modified":"2020-01-01T00:00:00.000000Z","description":"Modified Description","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Owner Name"},"externalPolicyReference":"XYZ policy","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":["string"],"creatorId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","modifierId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","violationOwnerAssignmentConfig":{"assignmentRule":"MANAGER","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Violation Owner Name"}},"scheduled":true,"type":"CONFLICTING_ACCESS_BASED","conflictingAccessCriteria":{"leftCriteria":{"name":"money-in","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67"}]},"rightCriteria":{"name":"money-out","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a68"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a69"}]}}}},"General Policy":{"value":{"description":"Modified Description","ownerRef":{"type":"IDENTITY","id":"2c918087682f9a86016839c05e8f1aff","name":"Owner Name"},"externalPolicyReference":"New policy","policyQuery":"policy query implementation","compensatingControls":"Compensating controls","correctionAdvice":"Correction advice","tags":[],"state":"ENFORCED","scheduled":false,"creatorId":"2c918087682f9a86016839c05e8f1aff","modifierId":null,"violationOwnerAssignmentConfig":null,"type":"GENERAL","conflictingAccessCriteria":null,"id":"52c11db4-733e-4c31-949a-766c95ec95f1","name":"General-Policy-Name","created":"2020-05-12T19:47:38Z","modified":"2020-05-12T19:47:38Z"}}}}}},"responses":{"200":{"description":"SOD Policy by ID","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Policy id","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"name":{"type":"string","description":"Policy Business Name","example":"policy-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this SOD policy is created.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"modified":{"type":"string","format":"date-time","description":"The time when this SOD policy is modified.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"description":{"type":"string","description":"Optional description of the SOD policy","example":"This policy ensures compliance of xyz","nullable":true},"ownerRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"externalPolicyReference":{"type":"string","description":"Optional External Policy Reference","example":"XYZ policy","nullable":true},"policyQuery":{"type":"string","description":"Search query of the SOD policy","example":"@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)"},"compensatingControls":{"type":"string","description":"Optional compensating controls(Mitigating Controls)","example":"Have a manager review the transaction decisions for their \"out of compliance\" employee","nullable":true},"correctionAdvice":{"type":"string","description":"Optional correction advice","example":"Based on the role of the employee, managers should remove access that is not required for their job function.","nullable":true},"state":{"type":"string","description":"whether the policy is enforced or not","enum":["ENFORCED","NOT_ENFORCED"],"example":"ENFORCED"},"tags":{"type":"array","description":"tags for this policy object","example":["TAG1","TAG2"],"items":{"type":"string"}},"creatorId":{"type":"string","description":"Policy's creator ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"modifierId":{"type":"string","description":"Policy's modifier ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","nullable":true,"readOnly":true},"violationOwnerAssignmentConfig":{"nullable":true,"type":"object","properties":{"assignmentRule":{"type":"string","enum":["MANAGER","STATIC",null],"description":"Details about the violations owner.\nMANAGER - identity's manager\nSTATIC - Governance Group or Identity","example":"MANAGER","nullable":true},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"nullable":true}]}}},"scheduled":{"type":"boolean","description":"defines whether a policy has been scheduled or not","example":true,"default":false},"type":{"type":"string","description":"whether a policy is query based or conflicting access based","default":"GENERAL","enum":["GENERAL","CONFLICTING_ACCESS_BASED"],"example":"GENERAL"},"conflictingAccessCriteria":{"allOf":[{"type":"object","properties":{"leftCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"DTO type","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}},"rightCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"DTO type","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}}}},{"nullable":true}]}}},"examples":{"Conflicting Access Based Policy":{"value":{"id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"Conflicting-Policy-Name","created":"2020-01-01T00:00:00.000000Z","modified":"2020-01-01T00:00:00.000000Z","description":"Modified description","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Owner Name"},"externalPolicyReference":"XYZ policy","policyQuery":"@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)","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":["string"],"creatorId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","modifierId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","violationOwnerAssignmentConfig":{"assignmentRule":"MANAGER","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Violation Owner Name"}},"scheduled":true,"type":"CONFLICTING_ACCESS_BASED","conflictingAccessCriteria":{"leftCriteria":{"name":"money-in","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67"}]},"rightCriteria":{"name":"money-out","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a68"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a69"}]}}}},"General Policy":{"value":{"description":"Modified Description","ownerRef":{"type":"IDENTITY","id":"2c918087682f9a86016839c05e8f1aff","name":"Owner Name"},"externalPolicyReference":"New policy","policyQuery":"policy query implementation","compensatingControls":"Compensating controls","correctionAdvice":"Correction advice","tags":[],"state":"ENFORCED","scheduled":false,"creatorId":"2c918087682f9a86016839c05e8f1aff","modifierId":null,"violationOwnerAssignmentConfig":null,"type":"GENERAL","conflictingAccessCriteria":null,"id":"52c11db4-733e-4c31-949a-766c95ec95f1","name":"General-Policy-Name","created":"2020-05-12T19:47:38Z","modified":"2020-05-12T19:47:38Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/sod-policies/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"policy-xyz","description":"This policy ensures compliance of xyz","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"},"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","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"],"violationOwnerAssignmentConfig":{"assignmentRule":"MANAGER","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"}},"scheduled":true,"type":"GENERAL","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"}]}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update SOD policy by ID","description":{"content":"This updates a specified SOD policy.\nRequires role of ORG_ADMIN.","type":"text/plain"},"url":{"path":["sod-policies",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the SOD policy to update.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update SOD policy by ID' (update-sod-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update SOD policy by ID + + + +This updates a specified SOD policy. +Requires role of ORG_ADMIN. + +
    Path Parameters
    Request Body required
      ownerRef object
      violationOwnerAssignmentConfig object
      ownerRef object
      conflictingAccessCriteria object
      leftCriteria object
      criteriaList object[]
      + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
      rightCriteria object
      criteriaList object[]
      + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
    + +SOD Policy by ID + +
    Schema
      ownerRef object
      violationOwnerAssignmentConfig object
      ownerRef object
      conflictingAccessCriteria object
      leftCriteria object
      criteriaList object[]
      + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
      rightCriteria object
      criteriaList object[]
      + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-source-entitlement-request-config.api.mdx b/products/idn/api/beta/update-source-entitlement-request-config.api.mdx new file mode 100644 index 000000000..523e656a4 --- /dev/null +++ b/products/idn/api/beta/update-source-entitlement-request-config.api.mdx @@ -0,0 +1,97 @@ +--- +id: update-source-entitlement-request-config +sidebar_label: Update Source Entitlement Request Configuration +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:sources:manage"]}],"operationId":"updateSourceEntitlementRequestConfig","tags":["Sources"],"description":"This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source.\n\nAccess request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined.\n- During access request, this source-level entitlement request configuration overrides the global organization-level configuration.\n- However, the entitlement-level configuration (if defined) overrides this source-level configuration.\n\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Entitlement Request Configuration","properties":{"accessRequestConfig":{"type":"object","properties":{"approvalSchemes":{"type":"array","description":"Ordered list of approval steps for the access request. Empty when no approval is required.","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["ENTITLEMENT_OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n\n**ENTITLEMENT_OWNER**: Owner of the associated Entitlement\n\n**SOURCE_OWNER**: Owner of the associated Source\n\n**MANAGER**: Manager of the Identity for whom the request is being made\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"e3eab852-8315-467f-9de7-70eda97f63c8"}}}},"requestCommentRequired":{"type":"boolean","description":"If the requester must provide a comment during access request.","default":false,"example":true},"denialCommentRequired":{"type":"boolean","description":"If the reviewer must provide a comment when denying the access request.","default":false,"example":false}},"description":"Configuration for requesting access to entitlements"}}},"examples":{"Set config with no approvals":{"description":"If no approvals are required, the following config can be set.","value":{"accessRequestConfig":{"approvalSchemes":[]}}},"Set config with one approval":{"description":"In case of single approval the following config can be set.","value":{"accessRequestConfig":{"approvalSchemes":[{"approverType":"SOURCE_OWNER"}],"requestCommentRequired":true,"denialCommentRequired":false}}},"Set config with multiple approvals":{"description":"In case of multiple levels of approvals the following config can be set. In this scenario, access request review process should go through all the approvers sequentially.","value":{"accessRequestConfig":{"approvalSchemes":[{"approverType":"ENTITLEMENT_OWNER"},{"approverType":"SOURCE_OWNER"},{"approverType":"GOVERNANCE_GROUP","approverId":"95e538a3-30c1-433a-af05-4bed973bbc22"}],"requestCommentRequired":true,"denialCommentRequired":false}}}}}}},"responses":{"200":{"description":"Source Entitlement Request Configuration Details.","content":{"application/json":{"schema":{"type":"object","description":"Entitlement Request Configuration","properties":{"accessRequestConfig":{"type":"object","properties":{"approvalSchemes":{"type":"array","description":"Ordered list of approval steps for the access request. Empty when no approval is required.","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["ENTITLEMENT_OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n\n**ENTITLEMENT_OWNER**: Owner of the associated Entitlement\n\n**SOURCE_OWNER**: Owner of the associated Source\n\n**MANAGER**: Manager of the Identity for whom the request is being made\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"e3eab852-8315-467f-9de7-70eda97f63c8"}}}},"requestCommentRequired":{"type":"boolean","description":"If the requester must provide a comment during access request.","default":false,"example":true},"denialCommentRequired":{"type":"boolean","description":"If the reviewer must provide a comment when denying the access request.","default":false,"example":false}},"description":"Configuration for requesting access to entitlements"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/sources/{id}/entitlement-request-config","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"accessRequestConfig":{"approvalSchemes":[{"approverType":"GOVERNANCE_GROUP","approverId":"e3eab852-8315-467f-9de7-70eda97f63c8"}],"requestCommentRequired":true,"denialCommentRequired":false}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update Source Entitlement Request Configuration","description":{"content":"This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source.\n\nAccess request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined.\n- During access request, this source-level entitlement request configuration overrides the global organization-level configuration.\n- However, the entitlement-level configuration (if defined) overrides this source-level configuration.\n\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":id","entitlement-request-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Source Entitlement Request Configuration' (update-source-entitlement-request-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Source Entitlement Request Configuration + + + +This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. + +Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. +- During access request, this source-level entitlement request configuration overrides the global organization-level configuration. +- However, the entitlement-level configuration (if defined) overrides this source-level configuration. + +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +
    Request Body required
      accessRequestConfig object
      + +Configuration for requesting access to entitlements + +
      approvalSchemes object[]
      + +Ordered list of approval steps for the access request. Empty when no approval is required. + +
    + +Source Entitlement Request Configuration Details. + +
    Schema
      accessRequestConfig object
      + +Configuration for requesting access to entitlements + +
      approvalSchemes object[]
      + +Ordered list of approval steps for the access request. Empty when no approval is required. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-source-schema.api.mdx b/products/idn/api/beta/update-source-schema.api.mdx new file mode 100644 index 000000000..46b368597 --- /dev/null +++ b/products/idn/api/beta/update-source-schema.api.mdx @@ -0,0 +1,132 @@ +--- +id: update-source-schema +sidebar_label: Update Source Schema (Partial) +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateSourceSchema","tags":["Sources"],"description":"Use this API to selectively update an existing Schema using a JSONPatch payload. \n\nThe following schema fields are immutable and cannot be updated:\n\n- id\n- name\n- created\n- modified\n\n\nTo switch an account attribute to a group entitlement, you need to have the following in place:\n\n- `isEntitlement: true`\n- Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/beta/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group:\n```json\n{\n \"name\": \"groups\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"2c9180887671ff8c01767b4671fc7d60\",\n \"name\": \"group\"\n },\n \"description\": \"The groups, roles etc. that reference account group objects\",\n \"isMulti\": true,\n \"isEntitlement\": true,\n \"isGroup\": true\n}\n```\n","parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source id.","example":"2c9180835d191a86015d28455b4a2329"},{"in":"path","name":"schemaId","schema":{"type":"string"},"required":true,"description":"The Schema id.","example":"2c9180835d191a86015d28455b4a2329"}],"requestBody":{"required":true,"description":"The JSONPatch payload used to update the schema.","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"example":[{"op":"replace","path":"/displayAttribute","value":{"new-display-attribute":null}}]}}},"responses":{"200":{"description":"The Schema was successfully updated.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Schema.","example":"2c9180835d191a86015d28455b4a2329"},"name":{"type":"string","description":"The name of the Schema.","example":"account"},"nativeObjectType":{"type":"string","description":"The name of the object type on the native system that the schema represents.","example":"User"},"identityAttribute":{"type":"string","description":"The name of the attribute used to calculate the unique identifier for an object in the schema.","example":"sAMAccountName"},"displayAttribute":{"type":"string","description":"The name of the attribute used to calculate the display value for an object in the schema.","example":"distinguishedName"},"hierarchyAttribute":{"type":"string","description":"The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.","example":"memberOf"},"includePermissions":{"type":"boolean","description":"Flag indicating whether or not the include permissions with the object data when aggregating the schema.","example":false},"features":{"type":"array","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING."},"description":"The features that the schema supports.","example":["PROVISIONING","NO_PERMISSIONS_PROVISIONING","GROUPS_HAVE_MEMBERS"]},"configuration":{"type":"object","description":"Holds any extra configuration data that the schema may require.","example":{"groupMemberAttribute":"member"}},"attributes":{"type":"array","description":"The attribute definitions which form the schema.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"sAMAccountName"},"type":{"type":"string","enum":["STRING","LONG","INT","BOOLEAN"],"description":"The underlying type of the value which an AttributeDefinition represents.","example":"STRING"},"schema":{"description":"A reference to the schema on the source to the attribute values map to.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"The object ID this reference applies to.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The human-readable display name of the object.","example":"group"}}},"description":{"type":"string","description":"A human-readable description of the attribute.","example":"The sAMAccountName attribute"},"isMulti":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","example":false},"isEntitlement":{"type":"boolean","description":"Flag indicating whether or not the attribute is an entitlement.","example":false},"isGroup":{"type":"boolean","description":"Flag indicating whether or not the attribute represents a group.\nThis can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute..\n","example":false}}},"example":[{"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":{"type":"string","description":"The date the Schema was created.","format":"date-time","example":"2019-12-24T22:32:58.104Z"},"modified":{"type":"string","description":"The date the Schema was last modified.","format":"date-time","example":"2019-12-31T20:22:28.104Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/sources/{sourceId}/schemas/{schemaId}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update Source Schema (Partial)","description":{"content":"Use this API to selectively update an existing Schema using a JSONPatch payload. \n\nThe following schema fields are immutable and cannot be updated:\n\n- id\n- name\n- created\n- modified\n\n\nTo switch an account attribute to a group entitlement, you need to have the following in place:\n\n- `isEntitlement: true`\n- Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/beta/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group:\n```json\n{\n \"name\": \"groups\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"2c9180887671ff8c01767b4671fc7d60\",\n \"name\": \"group\"\n },\n \"description\": \"The groups, roles etc. that reference account group objects\",\n \"isMulti\": true,\n \"isEntitlement\": true,\n \"isGroup\": true\n}\n```\n","type":"text/plain"},"url":{"path":["sources",":sourceId","schemas",":schemaId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id.","type":"text/plain"},"type":"any","value":"","key":"sourceId"},{"disabled":false,"description":{"content":"(Required) The Schema id.","type":"text/plain"},"type":"any","value":"","key":"schemaId"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Source Schema (Partial)' (update-source-schema)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Source Schema (Partial) + + + +Use this API to selectively update an existing Schema using a JSONPatch payload. + +The following schema fields are immutable and cannot be updated: + +- id +- name +- created +- modified + + +To switch an account attribute to a group entitlement, you need to have the following in place: + +- `isEntitlement: true` +- Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/beta/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: +```json +{ + "name": "groups", + "type": "STRING", + "schema": { + "type": "CONNECTOR_SCHEMA", + "id": "2c9180887671ff8c01767b4671fc7d60", + "name": "group" + }, + "description": "The groups, roles etc. that reference account group objects", + "isMulti": true, + "isEntitlement": true, + "isGroup": true +} +``` + + +
    Path Parameters
    Request Body array required
    + +The JSONPatch payload used to update the schema. + +
      value object
      + +The value to be used for the operation, required for "add" and "replace" operations + +
      anyOf
    • string
    • integer
      • anyOf
    • string
    • integer
    + +The Schema was successfully updated. + +
    Schema
      attributes object[]
      + +The attribute definitions which form the schema. + +
      schema object
      + +A reference to the schema on the source to the attribute values map to. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-source.api.mdx b/products/idn/api/beta/update-source.api.mdx new file mode 100644 index 000000000..890866e3d --- /dev/null +++ b/products/idn/api/beta/update-source.api.mdx @@ -0,0 +1,151 @@ +--- +id: update-source +sidebar_label: Update Source (Partial) +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateSource","security":[{"oauth2":["idn:sources:manage"]}],"tags":["Sources"],"description":"This API partially updates a source in IdentityNow, using a list of patch operations according to the\n[JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nSome fields are immutable and cannot be changed, such as:\n* id\n* type\n* authoritative\n* created\n* modified\n* connector\n* connectorClass\n* passwordPolicies\n\nAttempts to modify these fields will result in a 400 error.\n\nA token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or API authority is required to call this API.\n","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Source id","example":"2c9180835d191a86015d28455b4a2329"}],"requestBody":{"required":true,"description":"A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in IdentityNow.","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"examples":{"Edit the source description":{"description":"This example shows how to edit a source description.","value":[{"op":"replace","path":"/description","value":"new description"}]},"Edit the source cluster":{"description":"This example shows how to edit a source cluster by id.","value":[{"op":"replace","path":"/cluster/id","value":"2c918087813a902001813f3f85736b45"}]},"Edit source features":{"description":"This example illustrates how you can update source supported features","value":[{"op":"replace","path":"/features","value":["PASSWORD","PROVISIONING","ENABLE","AUTHENTICATE"]}]},"Change a source description and cluster in One Call":{"description":"This example shows how multiple fields may be updated with a single patch call.","value":[{"op":"replace","path":"/description","value":"new description"},{"op":"replace","path":"/cluster/id","value":"2c918087813a902001813f3f85736b45"}]},"Add a filter string to the connector":{"description":"This example shows how you can add a filter to incoming accounts during the account aggregation process. In the example below, any account that does not have an \"m\" or \"d\" in the id will be aggregated.","value":[{"op":"add","path":"/connectorAttributes/filterString","value":"!( id.contains( \"m\" ) ) || !( id.contains( \"d\" ) )"}]},"Update connector attribute for specific operation type":{"description":"This example shows how you can update the 3rd object in the connection parameters operationType. This will change it from a standard group aggregation to a group aggregation on the \"test\" entitlement type","value":[{"op":"replace","path":"/connectorAttributes/connectionParameters/2/operationType","value":"Group Aggregation-test"}]}}}}},"responses":{"200":{"description":"Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"the id of the Source","example":"2c91808568c529c60168cca6f90c1324"},"name":{"type":"string","description":"Human-readable name of the source","example":"My Source"},"description":{"type":"string","description":"Human-readable description of the source","example":"This is the corporate directory."},"owner":{"description":"Reference to an owning Identity Object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity","example":"MyName"}}},"cluster":{"description":"Reference to the associated Cluster","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"type":"string","description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"accountCorrelationConfig":{"description":"Reference to an Account Correlation Config object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG"],"example":"ACCOUNT_CORRELATION_CONFIG"},"id":{"type":"string","description":"ID of the account correlation config","example":"2c9180855d191c59015d28583727245a"},"name":{"type":"string","description":"Human-readable display name of the account correlation config","example":"Directory [source-62867] Account Correlation"}}},"accountCorrelationRule":{"description":"Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"managerCorrelationMapping":{"description":"Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity","type":"object","properties":{"accountAttribute":{"type":"string","description":"Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.","example":"manager"},"identityAttribute":{"type":"string","description":"Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.","example":"manager"}}},"managerCorrelationRule":{"description":"Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"beforeProvisioningRule":{"description":"Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"schemas":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"ID of the schema","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the schema","example":"MySchema"}}},"description":"List of references to Schema objects","example":[{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232a","name":"account"},{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232b","name":"group"}]},"passwordPolicies":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["PASSWORD_POLICY"],"example":"PASSWORD_POLICY"},"id":{"type":"string","description":"ID of the policy","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the policy","example":"My Password Policy"}}},"description":"List of references to the associated PasswordPolicy objects.","example":[{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb053980","name":"Corporate Password Policy"},{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb057777","name":"Vendor Password Policy"}]},"features":{"type":"array","description":"Optional features that can be supported by a source.","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING."},"example":["SYNC_PROVISIONING","MANAGER_LOOKUP","SEARCH","PROVISIONING","AUTHENTICATE","GROUP_PROVISIONING","PASSWORD"]},"type":{"type":"string","description":"Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ","example":"OpenLDAP - Direct"},"connector":{"type":"string","description":"Connector script name.","example":"active-directory"},"connectorClass":{"type":"string","description":"The fully qualified name of the Java class that implements the connector interface.","example":"sailpoint.connector.LDAPConnector"},"connectorAttributes":{"type":"object","description":"Connector specific configuration; will differ from type to type.","example":{"healthCheckTimeout":30,"authSearchAttributes":["cn","uid","mail"]}},"deleteThreshold":{"type":"integer","format":"int32","description":"Number from 0 to 100 that specifies when to skip the delete phase.","example":10},"authoritative":{"type":"boolean","description":"When true indicates the source is referenced by an IdentityProfile.","example":false},"managementWorkgroup":{"description":"Reference to Management Workgroup for this Source","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["GOVERNANCE_GROUP"],"example":"GOVERNANCE_GROUP"},"id":{"type":"string","description":"ID of the management workgroup","example":"2c91808568c529c60168cca6f90c2222"},"name":{"type":"string","description":"Human-readable display name of the management workgroup","example":"My Management Workgroup"}}},"healthy":{"type":"boolean","description":"When true indicates a healthy source","example":true},"status":{"type":"string","description":"A status identifier, giving specific information on why a source is healthy or not","example":"SOURCE_STATE_HEALTHY"},"since":{"type":"string","description":"Timestamp showing when a source health check was last performed","example":"2021-09-28T15:48:29.3801666300Z"},"connectorId":{"type":"string","description":"The id of connector","example":"active-directory"},"connectorName":{"type":"string","description":"The name of the connector that was chosen on source creation","example":"Active Directory"},"connectionType":{"type":"string","description":"The type of connection (direct or file)","example":"file"},"connectorImplementstionId":{"type":"string","description":"The connector implementstion id","example":"delimited-file"}},"required":["name","owner","connector"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/sources/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update Source (Partial)","description":{"content":"This API partially updates a source in IdentityNow, using a list of patch operations according to the\n[JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nSome fields are immutable and cannot be changed, such as:\n* id\n* type\n* authoritative\n* created\n* modified\n* connector\n* connectorClass\n* passwordPolicies\n\nAttempts to modify these fields will result in a 400 error.\n\nA token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or API authority is required to call this API.\n","type":"text/plain"},"url":{"path":["sources",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Source (Partial)' (update-source)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Source (Partial) + + + +This API partially updates a source in IdentityNow, using a list of patch operations according to the +[JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +Some fields are immutable and cannot be changed, such as: +* id +* type +* authoritative +* created +* modified +* connector +* connectorClass +* passwordPolicies + +Attempts to modify these fields will result in a 400 error. + +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or API authority is required to call this API. + + +
    Path Parameters
    Request Body array required
    + +A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in IdentityNow. + +
      value object
      + +The value to be used for the operation, required for "add" and "replace" operations + +
      anyOf
    • string
    • integer
      • anyOf
    • string
    • integer
    + +Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design. + +
    Schema
      owner object
      + +Reference to an owning Identity Object + +
      cluster object
      + +Reference to the associated Cluster + +
      accountCorrelationConfig object
      + +Reference to an Account Correlation Config object + +
      accountCorrelationRule object
      + +Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used. + +
      managerCorrelationMapping object
      + +Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + +
      managerCorrelationRule object
      + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
      beforeProvisioningRule object
      + +Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + +
      schemas object[]
      + +List of references to Schema objects + +
      passwordPolicies object[]
      + +List of references to the associated PasswordPolicy objects. + +
      managementWorkgroup object
      + +Reference to Management Workgroup for this Source + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-status-check-details.api.mdx b/products/idn/api/beta/update-status-check-details.api.mdx new file mode 100644 index 000000000..cf333bd17 --- /dev/null +++ b/products/idn/api/beta/update-status-check-details.api.mdx @@ -0,0 +1,91 @@ +--- +id: update-status-check-details +sidebar_label: Update the time check configuration +hide_title: true +hide_table_of_contents: true +api: {"tags":["Service Desk Integration"],"description":"Update the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","operationId":"updateStatusCheckDetails","requestBody":{"description":"the modified time check configuration","content":{"application/json":{"schema":{"description":"Configuration of maximum number days and interval for checking Service Desk integration queue status","required":["provisioningStatusCheckIntervalMinutes","provisioningMaxStatusCheckDays"],"type":"object","properties":{"provisioningStatusCheckIntervalMinutes":{"description":"interval in minutes between status checks","type":"string","example":30},"provisioningMaxStatusCheckDays":{"description":"maximum number of days to check","type":"string","example":2}}}}},"required":true},"responses":{"200":{"description":"QueuedCheckConfigDetails as updated","content":{"application/json":{"schema":{"description":"Configuration of maximum number days and interval for checking Service Desk integration queue status","required":["provisioningStatusCheckIntervalMinutes","provisioningMaxStatusCheckDays"],"type":"object","properties":{"provisioningStatusCheckIntervalMinutes":{"description":"interval in minutes between status checks","type":"string","example":30},"provisioningMaxStatusCheckDays":{"description":"maximum number of days to check","type":"string","example":2}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:service-desk-admin:manage","idn:service-desk-integration:manage"]}],"method":"put","path":"/service-desk-integrations/status-check-configuration","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"provisioningStatusCheckIntervalMinutes":30,"provisioningMaxStatusCheckDays":2},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update the time check configuration","description":{"content":"Update the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","type":"text/plain"},"url":{"path":["service-desk-integrations","status-check-configuration"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update the time check configuration' (update-status-check-details)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update the time check configuration + + + +Update the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +
    Request Body required
    + +the modified time check configuration + +
    + +QueuedCheckConfigDetails as updated + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-subscription.api.mdx b/products/idn/api/beta/update-subscription.api.mdx new file mode 100644 index 000000000..62693cf6e --- /dev/null +++ b/products/idn/api/beta/update-subscription.api.mdx @@ -0,0 +1,128 @@ +--- +id: update-subscription +sidebar_label: Update a Subscription +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateSubscription","tags":["Triggers"],"description":"This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing\n Subscription is completely replaced. The following fields are immutable:\n\n\n * id\n\n * triggerId\n\n\n Attempts to modify these fields result in 400.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Subscription ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Subscription name.","example":"Access request subscription"},"description":{"type":"string","description":"Subscription description.","example":"Access requested to site xyz"},"type":{"type":"string","enum":["HTTP","EVENTBRIDGE","INLINE","SCRIPT","WORKFLOW"],"description":"Subscription type. **NOTE** If type is EVENTBRIDGE, then eventBridgeConfig is required. If type is HTTP, then httpConfig is required.","example":"HTTP"},"responseDeadline":{"type":"string","description":"Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format.","example":"PT1H","default":"PT1H"},"httpConfig":{"description":"Config required if HTTP subscription type is used.","type":"object","properties":{"url":{"type":"string","description":"URL of the external/custom integration.","example":"https://www.example.com"},"httpDispatchMode":{"type":"string","description":"HTTP response modes, i.e. SYNC, ASYNC, or DYNAMIC.","enum":["SYNC","ASYNC","DYNAMIC"],"example":"SYNC"},"httpAuthenticationType":{"type":"string","description":"Defines the HTTP Authentication type. Additional values may be added in the future.\n\nIf *NO_AUTH* is selected, no extra information will be in HttpConfig.\n\nIf *BASIC_AUTH* is selected, HttpConfig will include BasicAuthConfig with Username and Password as strings.\n\nIf *BEARER_TOKEN* is selected, HttpConfig will include BearerTokenAuthConfig with Token as string.","enum":["NO_AUTH","BASIC_AUTH","BEARER_TOKEN"],"default":"NO_AUTH","example":"BASIC_AUTH"},"basicAuthConfig":{"type":"object","properties":{"userName":{"type":"string","description":"The username to authenticate.","example":"user@example.com"},"password":{"type":"string","nullable":true,"description":"The password to authenticate. On response, this field is set to null as to not return secrets.","example":null}},"nullable":true,"description":"Config required if BASIC_AUTH is used."},"bearerTokenAuthConfig":{"type":"object","properties":{"bearerToken":{"type":"string","nullable":true,"description":"Bearer token","example":null}},"nullable":true,"description":"Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets."}},"required":["url","httpDispatchMode"]},"eventBridgeConfig":{"description":"Config required if EVENTBRIDGE subscription type is used.","type":"object","properties":{"awsAccount":{"type":"string","description":"AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource.","example":"123456789012"},"awsRegion":{"type":"string","description":"AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values.","example":"us-west-1"}},"required":["awsAccount","awsRegion"]},"enabled":{"type":"boolean","description":"Whether subscription should receive real-time trigger invocations or not.\n\nTest trigger invocations are always enabled regardless of this option.","default":true,"example":true},"filter":{"type":"string","description":"JSONPath filter to conditionally invoke trigger when expression evaluates to true.","example":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]","externalDocs":{"description":"JSONPath filter documentation","url":"https://developer.sailpoint.com/idn/docs/event-triggers/filtering-events"}}}},"examples":{"HTTP Subscription":{"value":{"name":"Access request subscription","description":"Access requested to site xyz","type":"HTTP","httpConfig":{"url":"https://www.example.com","httpDispatchMode":"SYNC","httpAuthenticationType":"BASIC_AUTH","basicAuthConfig":{"userName":"user@example.com","password":"eRtg4%6yuI!"}},"enabled":true,"filter":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]"}},"HTTP Async Subscription":{"value":{"name":"Access request subscription","description":"Access requested to site xyz","type":"HTTP","responseDeadline":"PT1H","httpConfig":{"url":"https://www.example.com","httpDispatchMode":"ASYNC","httpAuthenticationType":"BASIC_AUTH","basicAuthConfig":{"userName":"user@example.com","password":"eRtg4%6yuI!"}},"enabled":true,"filter":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]"}},"EventBridge Subscription":{"value":{"name":"Access request subscription","description":"Access requested to site xyz","type":"EVENTBRIDGE","eventBridgeConfig":{"awsAccount":"123456789012","awsRegion":"us-west-1"},"enabled":true,"filter":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]"}}}}}},"responses":{"200":{"description":"Updated subscription.","content":{"application/json":{"schema":{"type":"object","required":["id","triggerId","type","name","triggerName","enabled","responseDeadline"],"properties":{"id":{"type":"string","description":"Subscription ID.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"name":{"type":"string","description":"Subscription name.","example":"Access request subscription"},"description":{"type":"string","description":"Subscription description.","example":"Access requested to site xyz"},"triggerId":{"type":"string","description":"ID of trigger subscribed to.","example":"idn:access-requested"},"triggerName":{"type":"string","description":"Trigger name of trigger subscribed to.","example":"Access Requested"},"type":{"type":"string","enum":["HTTP","EVENTBRIDGE","INLINE","SCRIPT","WORKFLOW"],"description":"Subscription type. **NOTE** If type is EVENTBRIDGE, then eventBridgeConfig is required. If type is HTTP, then httpConfig is required.","example":"HTTP"},"responseDeadline":{"type":"string","description":"Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format.","example":"PT1H","default":"PT1H"},"httpConfig":{"description":"Config required if HTTP subscription type is used.","type":"object","properties":{"url":{"type":"string","description":"URL of the external/custom integration.","example":"https://www.example.com"},"httpDispatchMode":{"type":"string","description":"HTTP response modes, i.e. SYNC, ASYNC, or DYNAMIC.","enum":["SYNC","ASYNC","DYNAMIC"],"example":"SYNC"},"httpAuthenticationType":{"type":"string","description":"Defines the HTTP Authentication type. Additional values may be added in the future.\n\nIf *NO_AUTH* is selected, no extra information will be in HttpConfig.\n\nIf *BASIC_AUTH* is selected, HttpConfig will include BasicAuthConfig with Username and Password as strings.\n\nIf *BEARER_TOKEN* is selected, HttpConfig will include BearerTokenAuthConfig with Token as string.","enum":["NO_AUTH","BASIC_AUTH","BEARER_TOKEN"],"default":"NO_AUTH","example":"BASIC_AUTH"},"basicAuthConfig":{"type":"object","properties":{"userName":{"type":"string","description":"The username to authenticate.","example":"user@example.com"},"password":{"type":"string","nullable":true,"description":"The password to authenticate. On response, this field is set to null as to not return secrets.","example":null}},"nullable":true,"description":"Config required if BASIC_AUTH is used."},"bearerTokenAuthConfig":{"type":"object","properties":{"bearerToken":{"type":"string","nullable":true,"description":"Bearer token","example":null}},"nullable":true,"description":"Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets."}},"required":["url","httpDispatchMode"]},"eventBridgeConfig":{"description":"Config required if EVENTBRIDGE subscription type is used.","type":"object","properties":{"awsAccount":{"type":"string","description":"AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource.","example":"123456789012"},"awsRegion":{"type":"string","description":"AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values.","example":"us-west-1"}},"required":["awsAccount","awsRegion"]},"enabled":{"type":"boolean","description":"Whether subscription should receive real-time trigger invocations or not.\nTest trigger invocations are always enabled regardless of this option.","default":true,"example":true},"filter":{"type":"string","description":"JSONPath filter to conditionally invoke trigger when expression evaluates to true.","example":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]","externalDocs":{"description":"JSONPath filter documentation","url":"https://developer.sailpoint.com/idn/docs/event-triggers/filtering-events"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["sp:trigger-service-subscriptions:manage"]}],"method":"put","path":"/trigger-subscriptions/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"Access request subscription","description":"Access requested to site xyz","type":"HTTP","responseDeadline":"PT1H","httpConfig":{"url":"https://www.example.com","httpDispatchMode":"SYNC","httpAuthenticationType":"BASIC_AUTH","basicAuthConfig":{"userName":"user@example.com","password":null},"bearerTokenAuthConfig":{"bearerToken":null}},"eventBridgeConfig":{"awsAccount":"123456789012","awsRegion":"us-west-1"},"enabled":true,"filter":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update a Subscription","description":{"content":"This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing\n Subscription is completely replaced. The following fields are immutable:\n\n\n * id\n\n * triggerId\n\n\n Attempts to modify these fields result in 400.","type":"text/plain"},"url":{"path":["trigger-subscriptions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Subscription ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a Subscription' (update-subscription)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a Subscription + + + +This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing + Subscription is completely replaced. The following fields are immutable: + + + * id + + * triggerId + + + Attempts to modify these fields result in 400. + +
    Path Parameters
    Request Body required
      httpConfig object
      + +Config required if HTTP subscription type is used. + +
      basicAuthConfig object
      + +Config required if BASIC_AUTH is used. + +
      bearerTokenAuthConfig object
      + +Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets. + +
      eventBridgeConfig object
      + +Config required if EVENTBRIDGE subscription type is used. + +
    + +Updated subscription. + +
    Schema
      httpConfig object
      + +Config required if HTTP subscription type is used. + +
      basicAuthConfig object
      + +Config required if BASIC_AUTH is used. + +
      bearerTokenAuthConfig object
      + +Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets. + +
      eventBridgeConfig object
      + +Config required if EVENTBRIDGE subscription type is used. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-tagged-object.api.mdx b/products/idn/api/beta/update-tagged-object.api.mdx new file mode 100644 index 000000000..3000a8bf5 --- /dev/null +++ b/products/idn/api/beta/update-tagged-object.api.mdx @@ -0,0 +1,75 @@ +--- +id: update-tagged-object +sidebar_label: Update Tagged Object +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateTaggedObject","security":[{"oauth2":["idn:tag:manage"]}],"tags":["Tagged Objects"],"description":"This updates a tagged object for the specified type.","parameters":[{"in":"path","name":"type","schema":{"type":"string","enum":["ROLE","IDENTITY","SOD_POLICY"]},"required":true,"description":"The type of tagged object to update.","example":"ROLE"},{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the object reference to update.","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"objectRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"tags":{"type":"array","items":{"type":"string"},"description":"Labels to be applied to an Object","example":["BU_FINANCE","PCI"]}}}}}},"responses":{"200":{"description":"Tagged object by type and ID.","content":{"application/json":{"schema":{"type":"object","properties":{"objectRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"tags":{"type":"array","items":{"type":"string"},"description":"Labels to be applied to an Object","example":["BU_FINANCE","PCI"]}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/tagged-objects/{type}/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"objectRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"},"tags":["BU_FINANCE","PCI"]},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update Tagged Object","description":{"content":"This updates a tagged object for the specified type.","type":"text/plain"},"url":{"path":["tagged-objects",":type",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The type of tagged object to update.","type":"text/plain"},"type":"any","value":"","key":"type"},{"disabled":false,"description":{"content":"(Required) The ID of the object reference to update.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Tagged Object' (update-tagged-object)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Tagged Object + + + +This updates a tagged object for the specified type. + +
    Path Parameters
    Request Body required
      objectRef object
    + +Tagged object by type and ID. + +
    Schema
      objectRef object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-transform.api.mdx b/products/idn/api/beta/update-transform.api.mdx new file mode 100644 index 000000000..ecb78100f --- /dev/null +++ b/products/idn/api/beta/update-transform.api.mdx @@ -0,0 +1,92 @@ +--- +id: update-transform +sidebar_label: Update a transform +hide_title: true +hide_table_of_contents: true +api: {"tags":["Transforms"],"description":"Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other attributes will result in an error.\nA token with transform write authority is required to call this API.","operationId":"updateTransform","parameters":[{"name":"id","in":"path","description":"ID of the transform to update","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"2c9180835d2e5168015d32f890ca1581"}],"requestBody":{"description":"The updated transform object (must include \"name\", \"type\", and \"attributes\" fields).","content":{"application/json":{"schema":{"type":"object","description":"DTO for representing an internally- or customer-defined transform.","required":["name","type","attributes"],"properties":{"id":{"type":"string","description":"Unique ID of this transform","example":"2cd78adghjkja34jh2b1hkjhasuecd"},"name":{"type":"string","description":"Unique name of this transform","example":"Timestamp To Date"},"type":{"type":"string","description":"The transform type (see [Transformations in IdentityNow Using Seaspray](https://community.sailpoint.com/docs/DOC-4629)).","example":"concat"},"attributes":{"type":"object","nullable":true,"description":"Meta-data about the transform. Values in this list are specific to the type of transform to be executed.","example":{"inputFormat":"MMM dd yyyy, HH:mm:ss.SSS","outputFormat":"yyyy/dd/MM"}},"internal":{"type":"boolean","default":false,"readOnly":true,"description":"Indicates whether this is an internal SailPoint-created transform or a customer-created transform","example":false}}},"example":{"name":"Timestamp To Date","type":"dateFormat","attributes":{"inputFormat":"MMM-dd-yyyy, HH:mm:ss.SSS","outputFormat":"yyyy/dd/MM"}}}}},"responses":{"200":{"description":"Indicates the transform was successfully updated and returns its new representation.","content":{"application/json":{"schema":{"type":"object","description":"DTO for representing an internally- or customer-defined transform.","required":["name","type","attributes"],"properties":{"id":{"type":"string","description":"Unique ID of this transform","example":"2cd78adghjkja34jh2b1hkjhasuecd"},"name":{"type":"string","description":"Unique name of this transform","example":"Timestamp To Date"},"type":{"type":"string","description":"The transform type (see [Transformations in IdentityNow Using Seaspray](https://community.sailpoint.com/docs/DOC-4629)).","example":"concat"},"attributes":{"type":"object","nullable":true,"description":"Meta-data about the transform. Values in this list are specific to the type of transform to be executed.","example":{"inputFormat":"MMM dd yyyy, HH:mm:ss.SSS","outputFormat":"yyyy/dd/MM"}},"internal":{"type":"boolean","default":false,"readOnly":true,"description":"Indicates whether this is an internal SailPoint-created transform or a customer-created transform","example":false}}},"example":{"id":"2cd78adghjkja34jh2b1hkjhasuecd","name":"Timestamp To Date","type":"dateFormat","attributes":{"inputFormat":"MMM-dd-yyyy, HH:mm:ss.SSS","outputFormat":"yyyy/dd/MM"},"internal":false}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:transform:manage"]}],"method":"put","path":"/transforms/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"id":"2cd78adghjkja34jh2b1hkjhasuecd","name":"Timestamp To Date","type":"concat","attributes":{"inputFormat":"MMM dd yyyy, HH:mm:ss.SSS","outputFormat":"yyyy/dd/MM"}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update a transform","description":{"content":"Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other attributes will result in an error.\nA token with transform write authority is required to call this API.","type":"text/plain"},"url":{"path":["transforms",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the transform to update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a transform' (update-transform)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a transform + + + +Replaces the transform specified by the given ID with the transform provided in the request body. Only the "attributes" field is mutable. Attempting to change other attributes will result in an error. +A token with transform write authority is required to call this API. + +
    Path Parameters
    Request Body
    + +The updated transform object (must include "name", "type", and "attributes" fields). + +
    + +Indicates the transform was successfully updated and returns its new representation. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/update-workflow.api.mdx b/products/idn/api/beta/update-workflow.api.mdx new file mode 100644 index 000000000..70e664ade --- /dev/null +++ b/products/idn/api/beta/update-workflow.api.mdx @@ -0,0 +1,119 @@ +--- +id: update-workflow +sidebar_label: Update Workflow +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateWorkflow","tags":["Workflows"],"description":"Perform a full update of a workflow. The updated workflow object is returned in the response.","security":[{"oauth2":["sp:workflow:manage"]}],"parameters":[{"name":"id","in":"path","description":"Id of the Workflow","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the workflow","example":"Send Email"},"owner":{"description":"The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request.","properties":{"type":{"type":"string","enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"},"id":{"type":"string","description":"The unique ID of the object","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The name of the object","example":"William Wilson"}}},"description":{"type":"string","description":"Description of what the workflow accomplishes","example":"Send an email to the identity who's attributes changed."},"definition":{"type":"object","description":"The map of steps that the workflow will execute.","properties":{"start":{"type":"string","description":"The name of the starting step.","example":"Send Email Test"},"steps":{"type":"object","description":"One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type.","additionalProperties":true,"example":{"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":{"type":"boolean","description":"Enable or disable the workflow. Workflows cannot be created in an enabled state.","default":false,"example":false},"trigger":{"type":"object","description":"The trigger that starts the workflow","required":["type","attributes"],"properties":{"type":{"type":"string","enum":["EVENT","EXTERNAL","SCHEDULED"],"example":"EVENT","description":"The trigger type"},"attributes":{"anyOf":[{"title":"Event Trigger Attributes","type":"object","description":"Attributes related to an IdentityNow ETS event","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the trigger","example":"idn:identity-attributes-changed"},"filter.$":{"type":"string","description":"JSON path expression that will limit which events the trigger will fire on","example":"$.changes[?(@.attribute == 'manager')]"}}},{"title":"External Trigger Attributes","type":"object","description":"Attributes related to an external trigger","required":["name"],"properties":{"name":{"type":"string","description":"A unique name for the external trigger","example":"search-and-notify"},"description":{"type":"string","description":"Additonal context about the external trigger","example":"Run a search and notify the results"}}},{"title":"Scheduled Trigger Attributes","type":"object","description":"Attributes related to a scheduled trigger","required":["cronString"],"properties":{"cronString":{"type":"string","description":"A valid CRON expression","externalDocs":{"description":"CRON expression editor","url":"https://crontab.guru/"},"example":"0 * */3 */5 *"}}}],"description":"Workflow Trigger Attributes."}}}}}}}},"responses":{"200":{"description":"The Workflow object","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","description":"Workflow ID. This is a UUID generated upon creation.","example":"d201c5e9-d37b-4aff-af14-66414f39d569"},"executionCount":{"type":"integer","format":"int32","description":"The number of times this workflow has been executed","example":2},"failureCount":{"type":"integer","format":"int32","description":"The number of times this workflow has failed during execution","example":0},"created":{"type":"string","format":"date-time","description":"The date and time the workflow was created","example":"2022-01-10T16:06:16.636381447Z"},"creator":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The identity that created the workflow.","properties":{"type":{"enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}},"example":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"}}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the workflow","example":"Send Email"},"owner":{"description":"The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request.","properties":{"type":{"type":"string","enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"},"id":{"type":"string","description":"The unique ID of the object","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The name of the object","example":"William Wilson"}}},"description":{"type":"string","description":"Description of what the workflow accomplishes","example":"Send an email to the identity who's attributes changed."},"definition":{"type":"object","description":"The map of steps that the workflow will execute.","properties":{"start":{"type":"string","description":"The name of the starting step.","example":"Send Email Test"},"steps":{"type":"object","description":"One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type.","additionalProperties":true,"example":{"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":{"type":"boolean","description":"Enable or disable the workflow. Workflows cannot be created in an enabled state.","default":false,"example":false},"trigger":{"type":"object","description":"The trigger that starts the workflow","required":["type","attributes"],"properties":{"type":{"type":"string","enum":["EVENT","EXTERNAL","SCHEDULED"],"example":"EVENT","description":"The trigger type"},"attributes":{"anyOf":[{"title":"Event Trigger Attributes","type":"object","description":"Attributes related to an IdentityNow ETS event","required":["id"],"properties":{"id":{"type":"string","description":"The unique ID of the trigger","example":"idn:identity-attributes-changed"},"filter.$":{"type":"string","description":"JSON path expression that will limit which events the trigger will fire on","example":"$.changes[?(@.attribute == 'manager')]"}}},{"title":"External Trigger Attributes","type":"object","description":"Attributes related to an external trigger","required":["name"],"properties":{"name":{"type":"string","description":"A unique name for the external trigger","example":"search-and-notify"},"description":{"type":"string","description":"Additonal context about the external trigger","example":"Run a search and notify the results"}}},{"title":"Scheduled Trigger Attributes","type":"object","description":"Attributes related to a scheduled trigger","required":["cronString"],"properties":{"cronString":{"type":"string","description":"A valid CRON expression","externalDocs":{"description":"CRON expression editor","url":"https://crontab.guru/"},"example":"0 * */3 */5 *"}}}],"description":"Workflow Trigger Attributes."}}}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/workflows/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"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')]"}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Update Workflow","description":{"content":"Perform a full update of a workflow. The updated workflow object is returned in the response.","type":"text/plain"},"url":{"path":["workflows",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the Workflow","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Workflow' (update-workflow)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Workflow + + + +Perform a full update of a workflow. The updated workflow object is returned in the response. + +
    Path Parameters
    Request Body required
      owner
      + +The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request. + +
      definition object
      + +The map of steps that the workflow will execute. + +
      steps object
      + +One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. + +
      trigger object
      + +The trigger that starts the workflow + +
      attributes object required
      + +Workflow Trigger Attributes. + +
      anyOf
    + +The Workflow object + +
    Schema
      creator object
      + +The identity that created the workflow. + +
      owner
      + +The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request. + +
      definition object
      + +The map of steps that the workflow will execute. + +
      steps object
      + +One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. + +
      trigger object
      + +The trigger that starts the workflow + +
      attributes object
      + +Workflow Trigger Attributes. + +
      anyOf
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/validate-connector-rule.api.mdx b/products/idn/api/beta/validate-connector-rule.api.mdx new file mode 100644 index 000000000..5c48d2fbf --- /dev/null +++ b/products/idn/api/beta/validate-connector-rule.api.mdx @@ -0,0 +1,80 @@ +--- +id: validate-connector-rule +sidebar_label: Validate Connector Rule +hide_title: true +hide_table_of_contents: true +api: {"tags":["Connector Rule Management"],"operationId":"validateConnectorRule","description":"Returns a list of issues within the code to fix, if any.\nA token with ORG_ADMIN authority is required to call this API.","requestBody":{"required":true,"description":"The code to validate","content":{"application/json":{"schema":{"description":"SourceCode","type":"object","required":["version","script"],"properties":{"version":{"type":"string","description":"the version of the code","example":"1.0"},"script":{"type":"string","description":"The code","example":"return \"Mr. \" + firstName;"}}}}}},"responses":{"200":{"description":"The status of the code's eligibility as a connector rule","content":{"application/json":{"schema":{"description":"ConnectorRuleValidationResponse","type":"object","required":["state","details"],"properties":{"state":{"type":"string","enum":["OK","ERROR"],"example":"ERROR"},"details":{"type":"array","items":{"description":"CodeErrorDetail","type":"object","required":["line","column","message"],"properties":{"line":{"type":"integer","description":"The line number where the issue occurred","example":2},"column":{"type":"integer","description":"the column number where the issue occurred","example":5},"messsage":{"type":"string","description":"a description of the issue in the code","example":"Remove reference to .decrypt("}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:rule-management-connector:read","idn:rule-management-connector:manage"]}],"method":"post","path":"/connector-rules/validate","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"version":"1.0","script":"return \"Mr. \" + firstName;"},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Validate Connector Rule","description":{"content":"Returns a list of issues within the code to fix, if any.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["connector-rules","validate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Validate Connector Rule' (validate-connector-rule)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Validate Connector Rule + + + +Returns a list of issues within the code to fix, if any. +A token with ORG_ADMIN authority is required to call this API. + +
    Request Body required
    + +The code to validate + +
    + +The status of the code's eligibility as a connector rule + +
    Schema
      details object[]
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/beta/work-items.tag.mdx b/products/idn/api/beta/work-items.tag.mdx new file mode 100644 index 000000000..7c1958248 --- /dev/null +++ b/products/idn/api/beta/work-items.tag.mdx @@ -0,0 +1,34 @@ +--- +id: work-items +title: "Work Items" +description: "Work Items" +custom_edit_url: null +--- + + + +Use this API to implement work item functionality. +With this functionality in place, users can manage their work items (tasks). + +Work items refer to the tasks users see in IdentityNow's Task Manager. +They can see the pending work items they need to complete, as well as the work items they have already completed. +Task Manager lists the work items along with the involved sources, identities, accounts, and the timestamp when the work item was created. +For example, a user may see a pending 'Create an Account' work item for the identity Fred.Astaire in GitHub for Fred's GitHub account, fred-astaire-sp. +Once the user completes the work item, the work item will be listed with his or her other completed work items. + +To complete work items, users can use their dashboards and select the 'My Tasks' widget. +The widget will list any work items they need to complete, and they can select the work item from the list to review its details. +When they complete the work item, they can select 'Mark Complete' to add it to their list of completed work items. + +Refer to [Task Manager](https://documentation.sailpoint.com/saas/user-help/task_manager.html) for more information about work items, including the different types of work items users may need to complete. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/beta/workflows.tag.mdx b/products/idn/api/beta/workflows.tag.mdx new file mode 100644 index 000000000..8cfe099a3 --- /dev/null +++ b/products/idn/api/beta/workflows.tag.mdx @@ -0,0 +1,21 @@ +--- +id: workflows +title: "Workflows" +description: "Workflows" +custom_edit_url: null +--- + + + +Workflows allow administrators to create custom automation scripts directly within IdentityNow. These automation scripts respond to [event triggers](https://developer.sailpoint.com/idn/docs/event-triggers#how-to-get-started-with-event-triggers) and perform a series of actions to perform tasks that are either too cumbersome or not available in the IdentityNow UI. Workflows can be configured via a graphical user interface within IdentityNow, or by creating and uploading a JSON formatted script to the Workflow service. The Workflows API collection provides the necessary functionality to create, manage, and test your workflows via REST. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/access-profiles.tag.mdx b/products/idn/api/v3/access-profiles.tag.mdx new file mode 100644 index 000000000..fd98d925c --- /dev/null +++ b/products/idn/api/v3/access-profiles.tag.mdx @@ -0,0 +1,54 @@ +--- +id: access-profiles +title: "Access Profiles" +description: "Access Profiles" +custom_edit_url: null +--- + + + +Use this API to implement and customize access profile functionality. +With this functionality in place, administrators can create access profiles and configure them for use throughout IdentityNow, enabling users to get the access they need quickly and securely. + +Access profiles group entitlements, which represent access rights on sources. + +For example, an Active Directory source in IdentityNow can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +Access profiles are the most important units of access in IdentityNow. IdentityNow uses access profiles in many features, including the following: + +- Provisioning: When you use the Provisioning Service, lifecycle states and roles both grant access to users in the form of access profiles. + +- Certifications: You can approve or revoke access profiles in certification campaigns, just like entitlements. + +- Access Requests: You can assign access profiles to applications, and when a user requests access to the app associated with an access profile and someone approves the request, access is granted to both the application and its associated access profile. + +- Roles: You can group one or more access profiles into a role to quickly assign access items based on an identity's role. + +In IdentityNow, administrators can use the Access drop-down menu and select Access Profiles to view, configure, and delete existing access profiles, as well as create new ones. +Administrators can enable and disable an access profile, and they can also make the following configurations: + +- Manage Entitlements: Manage the profile's access by adding and removing entitlements. + +- Access Requests: Configure access profiles to be requestable and establish an approval process for any requests that the access profile be granted or revoked. +Do not configure an access profile to be requestable without first establishing a secure access request approval process for the access profile. + +- Multiple Account Options: Define the logic IdentityNow uses to provision access to an identity with multiple accounts on the source. + +Refer to [Managing Access Profiles](https://documentation.sailpoint.com/saas/help/access/access-profiles.html) for more information about access profiles. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/access-request-approvals.tag.mdx b/products/idn/api/v3/access-request-approvals.tag.mdx new file mode 100644 index 000000000..45cc17c2f --- /dev/null +++ b/products/idn/api/v3/access-request-approvals.tag.mdx @@ -0,0 +1,37 @@ +--- +id: access-request-approvals +title: "Access Request Approvals" +description: "Access Request Approvals" +custom_edit_url: null +--- + + + +Use this API to implement and customize access request approval functionality. +With this functionality in place, administrators can delegate qualified users to review users' requests for access or managers' requests to revoke team members' access to applications, entitlements, or roles. +This enables more qualified users to review access requests and the others to spend their time on other tasks. + +In IdentityNow, users can request access to applications, entitlements, and roles, and managers can request that team members' access be revoked. +For applications and entitlements, administrators can set access profiles to require approval from the access profile owner, the application owner, the source owner, the requesting user's manager, or a governance group for access to be granted or revoked. +For roles, administrators can also set roles to allow access requests and require approval from the role owner, the requesting user's manager, or a governance group for access to be granted or revoked. +If the administrator designates a governance group as the required approver, any governance group member can approve the requests. + +When a user submits an access request, IdentityNow sends the first required approver in the queue an email notification, based on the access request configuration's approval and reminder escalation configuration. + +In Approvals in IdentityNow, required approvers can view pending access requests under the Requested tab and approve or deny them, or the approvers can reassign the requests to different reviewers for approval. +If the required approver approves the request and is the only reviewer required, IdentityNow grants or revokes access, based on the request. +If multiple reviewers are required, IdentityNow sends the request to the next reviewer in the queue, based on the access request configuration's approval reminder and escalation configuration. +The required approver can then view any completed access requests under the Reviewed tab. + +Refer to [Access Requests](https://documentation.sailpoint.com/saas/help/requests/index.html) for more information about access request approvals. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/access-requests.tag.mdx b/products/idn/api/v3/access-requests.tag.mdx new file mode 100644 index 000000000..b4a0b996a --- /dev/null +++ b/products/idn/api/v3/access-requests.tag.mdx @@ -0,0 +1,35 @@ +--- +id: access-requests +title: "Access Requests" +description: "Access Requests" +custom_edit_url: null +--- + + + +Use this API to implement and customize access request functionality. +With this functionality in place, users can request access to applications, entitlements, or roles, and managers can request that team members' access be revoked. +This allows users to get access to the tools they need quickly and securely, and it allows managers to take away access to those tools. + +IdentityNow's Access Request service allows end users to request access that requires approval before it can be granted to users and enables qualified users to review those requests and approve or deny them. + +In the Request Center in IdentityNow, users can view available applications, roles, and entitlements and request access to them. +If the requested tools requires approval, the requests appear as 'Pending' under the My Requests tab until the required approver approves, rejects, or cancels them. + +Users can use My Requests to track and/or cancel the requests. + +In My Team on the IdentityNow Home, managers can submit requests to revoke their team members' access. +They can use the My Requests tab under Request Center to track and/or cancel the requests. + +Refer to [Requesting Access](https://documentation.sailpoint.com/saas/user-help/requests/requesting_access.html) for more information about access requests. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/account-activities.tag.mdx b/products/idn/api/v3/account-activities.tag.mdx new file mode 100644 index 000000000..8d356bab2 --- /dev/null +++ b/products/idn/api/v3/account-activities.tag.mdx @@ -0,0 +1,53 @@ +--- +id: account-activities +title: "Account Activities" +description: "Account Activities" +custom_edit_url: null +--- + + + +Use this API to implement account activity tracking functionality. +With this functionality in place, users can track source account activity in IdentityNow, which greatly improves traceability in the system. + +An account activity refers to a log of each action performed on a source account. This is useful for auditing the changes performed on an account throughout its life. +In IdentityNow's Search, users can search for account activities and select the activity's row to get an overview of the activity's account action and view its progress, its involved sources, and its most basic metadata, such as the identity requesting the option and the recipient. + +Account activity includes most actions IdentityNow completes on source accounts. Users can search in IdentityNow for the following account action types: + +- Access Request: These include any access requests the source account is involved in. + +- Account Attribute Updates: These include updates to a single attribute on an account on a source. + +- Account State Update: These include locking or unlocking actions on an account on a source. + +- Certification: These include actions removing an entitlement from an account on a source as a result of the entitlement's revocation during a certification. + +- Cloud Automated `Lifecyclestate`: These include automated lifecycle state changes that result in a source account's correlated identity being assigned to a different lifecycle state. +IdentityNow replaces the `Lifecyclestate` variable with the name of the lifecycle state it has moved the account's identity to. + +- Identity Attribute Update: These include updates to a source account's correlated identity attributes as the result of a provisioning action. +When you update an identity attribute that also updates an identity's lifecycle state, the cloud automated `Lifecyclestate` event also displays. +Account Activity does not include attribute updates that occur as a result of aggregation. + +- Identity Refresh: These include correlated identity refreshes that occur for an account on a source whenever the account's correlated identity profile gets a new role or updates. +These also include refreshes that occur whenever IdentityNow assigns an application to the account's correlated identity based on the application's being assigned to All Users From Source or Specific Users From Source. + +- Lifecycle State Refresh: These include the actions that took place when a lifecycle state changed. This event only occurs after a cloud automated `Lifecyclestate` change or a lifecycle state change. + +- Lifecycle State Change: These include the account activities that result from an identity's manual assignment to a null lifecycle state. + +- Password Change: These include password changes on sources. + +Refer to [Account Activity](https://documentation.sailpoint.com/saas/help/search/index.html#account-activity) for more information about account activities. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/accounts.tag.mdx b/products/idn/api/v3/accounts.tag.mdx new file mode 100644 index 000000000..3f54a4d82 --- /dev/null +++ b/products/idn/api/v3/accounts.tag.mdx @@ -0,0 +1,47 @@ +--- +id: accounts +title: "Accounts" +description: "Accounts" +custom_edit_url: null +--- + + + +Use this API to implement and customize account functionality. +With this functionality in place, administrators can manage users' access across sources in IdentityNow. + +In IdentityNow, an account refers to a user's account on a supported source. +This typically includes a unique identifier for the user, a unique password, a set of permissions associated with the source and a set of attributes. IdentityNow loads accounts through the creation of sources in IdentityNow. + +Administrators can correlate users' identities with the users' accounts on the different sources they use. +This allows IdentityNow to govern the access of identities and all their correlated accounts securely and cohesively. + +To view the accounts on a source and their correlated identities, administrators can use the Connections drop-down menu, select Sources, select the relevant source, and select its Account tab. + +To view and edit source account statuses for an identity in IdentityNow, administrators can use the Identities drop-down menu, select Identity List, select the relevant identity, and select its Accounts tab. +Administrators can toggle an account's Actions to aggregate the account, enable/disable it, unlock it, or remove it from the identity. + +Accounts can have the following statuses: + +- Enabled: The account is enabled. The user can access it. + +- Disabled: The account is disabled, and the user cannot access it, but the identity is not disabled in IdentityNow. This can occur when an administrator disables the account or when the user's lifecycle state changes. + +- Locked: The account is locked. This may occur when someone has entered an incorrect password for the account too many times. + +- Pending: The account is currently updating. This status typically lasts seconds. + +Administrators can select the source account to view its attributes, entitlements, and the last time the account's password was changed. + +Refer to [Managing User Accounts](https://documentation.sailpoint.com/saas/help/common/users/user_access.html#managing-user-accounts) for more information about accounts. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/approve-access-request.api.mdx b/products/idn/api/v3/approve-access-request.api.mdx new file mode 100644 index 000000000..e3fac20dc --- /dev/null +++ b/products/idn/api/v3/approve-access-request.api.mdx @@ -0,0 +1,91 @@ +--- +id: approve-access-request +sidebar_label: Approves an access request approval. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"approveAccessRequest","tags":["Access Request Approvals"],"description":"This endpoint approves an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.","parameters":[{"in":"path","name":"approvalId","schema":{"type":"string"},"required":true,"description":"The id of the approval.","example":"2c91808b7294bea301729568c68c002e"}],"requestBody":{"description":"Reviewer's comment.","required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"comment":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat"},"author":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the author","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"}}},"created":{"type":"string","format":"date-time","description":"Date and time comment was created","example":"2017-07-11T18:45:37.098Z"}}}}}},"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/access-request-approvals/{approvalId}/approve","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"comment":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat","author":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Adam Kennedy"},"created":"2017-07-11T18:45:37.098Z"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Approves an access request approval.","description":{"content":"This endpoint approves an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.","type":"text/plain"},"url":{"path":["access-request-approvals",":approvalId","approve"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The id of the approval.","type":"text/plain"},"type":"any","value":"","key":"approvalId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Approves an access request approval.' (approve-access-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Approves an access request approval. + + + +This endpoint approves an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +
    Path Parameters
    Request Body
    + +Reviewer's comment. + +
      author object
    + +Accepted - Returned if the request was successfully accepted into the system. + +
    Schema
    • object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/approve-approval-item.api.mdx b/products/idn/api/v3/approve-approval-item.api.mdx new file mode 100644 index 000000000..b8dc61285 --- /dev/null +++ b/products/idn/api/v3/approve-approval-item.api.mdx @@ -0,0 +1,87 @@ +--- +id: approve-approval-item +sidebar_label: Approve an Approval Item +hide_title: true +hide_table_of_contents: true +api: {"operationId":"approveApprovalItem","tags":["Work Items"],"description":"This API approves an Approval Item. Either an admin, or the owning/current user must make this request.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the work item","example":"ef38f94347e94562b5bb8424a56397d8"},{"in":"path","name":"approvalItemId","schema":{"type":"string"},"required":true,"description":"The ID of the approval item.","example":"1211bcaa32112bcef6122adb21cef1ac"}],"responses":{"200":{"description":"A work items details object.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the work item","example":"2c9180835d2e5168015d32f890ca1581"},"requesterId":{"type":"string","description":"ID of the requester","example":"2c9180835d2e5168015d32f890ca1581"},"requesterDisplayName":{"type":"string","description":"The displayname of the requester","example":"John Smith"},"ownerId":{"type":"string","description":"The ID of the owner","example":"2c9180835d2e5168015d32f890ca1581"},"ownerName":{"type":"string","description":"The name of the owner","example":"Jason Smith"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z","description":"Time when the work item was created"},"modified":{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"Time when the work item was last updated"},"description":{"type":"string","description":"The description of the work item","example":"Create account on source 'AD'"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"},"type":{"type":"string","enum":["UNKNOWN","GENERIC","CERTIFICATION","REMEDIATION","DELEGATION","APPROVAL","VIOLATIONREVIEW","FORM","POLICYVIOLATION","CHALLENGE","IMPACTANALYSIS","SIGNOFF","EVENT","MANUALACTION","TEST"],"example":"GENERIC","description":"The type of the work item"},"remediationItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the certification","example":"2c9180835d2e5168015d32f890ca1581"},"targetId":{"type":"string","description":"The ID of the certification target","example":"2c9180835d2e5168015d32f890ca1581"},"targetName":{"type":"string","description":"The name of the certification target","example":"john.smith"},"targetDisplayName":{"type":"string","description":"The display name of the certification target","example":"emailAddress"},"applicationName":{"type":"string","description":"The name of the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute being certified","example":"phoneNumber"},"attributeOperation":{"type":"string","description":"The operation of the certification on the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute being certified","example":"512-555-1212"},"nativeIdentity":{"type":"string","description":"The native identity of the target","example":"jason.smith2"}}},"approvalItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the approval item","example":"2c9180835d2e5168015d32f890ca1581"},"account":{"type":"string","description":"The account referenced by the approval item","example":"john.smith"},"application":{"type":"string","description":"The name the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute","example":"emailAddress"},"attributeOperation":{"type":"string","description":"The operation of the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute","example":"a@b.com"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"}}},"name":{"type":"string","description":"The work item name","example":"Account Create"},"completed":{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z","description":"The time at which the work item completed"},"numItems":{"type":"integer","format":"int32","description":"The number of items in the work item","example":19},"form":{"type":"object","properties":{"id":{"type":"string","description":"ID of the form","example":"2c9180835d2e5168015d32f890ca1581"},"name":{"type":"string","description":"Name of the form","example":"AccountSelection Form"},"title":{"type":"string","description":"The form title","example":"Account Selection for John.Doe"},"subtitle":{"type":"string","description":"The form subtitle.","example":"Please select from the following"},"targetUser":{"type":"string","description":"The name of the user that should be shown this form","example":"Jane.Doe"},"sections":{"type":"object","allOf":[{"type":"object","properties":{"name":{"type":"string","description":"Name of the FormItem","example":"Field1"}}},{"type":"object","properties":{"label":{"type":"string","description":"Label of the section","example":"Section 1"},"formItems":{"type":"array","items":{"type":"object"},"description":"List of FormItems. FormItems can be SectionDetails and/or FieldDetails","example":[]}}}]}}},"errors":{"type":"array","items":{"type":"string"},"example":["The work item ID that was specified was not found."],"description":"An array of errors that ocurred during the work item"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/work-items/{id}/approve/{approvalItemId}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Approve an Approval Item","description":{"content":"This API approves an Approval Item. Either an admin, or the owning/current user must make this request.","type":"text/plain"},"url":{"path":["work-items",":id","approve",":approvalItemId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the work item","type":"text/plain"},"type":"any","value":"","key":"id"},{"disabled":false,"description":{"content":"(Required) The ID of the approval item.","type":"text/plain"},"type":"any","value":"","key":"approvalItemId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Approve an Approval Item' (approve-approval-item)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Approve an Approval Item + + + +This API approves an Approval Item. Either an admin, or the owning/current user must make this request. + +
    Path Parameters
    + +A work items details object. + +
    Schema
      remediationItems object
      approvalItems object
      form object
      sections object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/approve-approval-items-in-bulk.api.mdx b/products/idn/api/v3/approve-approval-items-in-bulk.api.mdx new file mode 100644 index 000000000..f18c9fe5d --- /dev/null +++ b/products/idn/api/v3/approve-approval-items-in-bulk.api.mdx @@ -0,0 +1,87 @@ +--- +id: approve-approval-items-in-bulk +sidebar_label: Bulk approve Approval Items +hide_title: true +hide_table_of_contents: true +api: {"operationId":"approveApprovalItemsInBulk","tags":["Work Items"],"description":"This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the work item","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"A work items details object.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the work item","example":"2c9180835d2e5168015d32f890ca1581"},"requesterId":{"type":"string","description":"ID of the requester","example":"2c9180835d2e5168015d32f890ca1581"},"requesterDisplayName":{"type":"string","description":"The displayname of the requester","example":"John Smith"},"ownerId":{"type":"string","description":"The ID of the owner","example":"2c9180835d2e5168015d32f890ca1581"},"ownerName":{"type":"string","description":"The name of the owner","example":"Jason Smith"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z","description":"Time when the work item was created"},"modified":{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"Time when the work item was last updated"},"description":{"type":"string","description":"The description of the work item","example":"Create account on source 'AD'"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"},"type":{"type":"string","enum":["UNKNOWN","GENERIC","CERTIFICATION","REMEDIATION","DELEGATION","APPROVAL","VIOLATIONREVIEW","FORM","POLICYVIOLATION","CHALLENGE","IMPACTANALYSIS","SIGNOFF","EVENT","MANUALACTION","TEST"],"example":"GENERIC","description":"The type of the work item"},"remediationItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the certification","example":"2c9180835d2e5168015d32f890ca1581"},"targetId":{"type":"string","description":"The ID of the certification target","example":"2c9180835d2e5168015d32f890ca1581"},"targetName":{"type":"string","description":"The name of the certification target","example":"john.smith"},"targetDisplayName":{"type":"string","description":"The display name of the certification target","example":"emailAddress"},"applicationName":{"type":"string","description":"The name of the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute being certified","example":"phoneNumber"},"attributeOperation":{"type":"string","description":"The operation of the certification on the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute being certified","example":"512-555-1212"},"nativeIdentity":{"type":"string","description":"The native identity of the target","example":"jason.smith2"}}},"approvalItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the approval item","example":"2c9180835d2e5168015d32f890ca1581"},"account":{"type":"string","description":"The account referenced by the approval item","example":"john.smith"},"application":{"type":"string","description":"The name the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute","example":"emailAddress"},"attributeOperation":{"type":"string","description":"The operation of the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute","example":"a@b.com"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"}}},"name":{"type":"string","description":"The work item name","example":"Account Create"},"completed":{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z","description":"The time at which the work item completed"},"numItems":{"type":"integer","format":"int32","description":"The number of items in the work item","example":19},"form":{"type":"object","properties":{"id":{"type":"string","description":"ID of the form","example":"2c9180835d2e5168015d32f890ca1581"},"name":{"type":"string","description":"Name of the form","example":"AccountSelection Form"},"title":{"type":"string","description":"The form title","example":"Account Selection for John.Doe"},"subtitle":{"type":"string","description":"The form subtitle.","example":"Please select from the following"},"targetUser":{"type":"string","description":"The name of the user that should be shown this form","example":"Jane.Doe"},"sections":{"type":"object","allOf":[{"type":"object","properties":{"name":{"type":"string","description":"Name of the FormItem","example":"Field1"}}},{"type":"object","properties":{"label":{"type":"string","description":"Label of the section","example":"Section 1"},"formItems":{"type":"array","items":{"type":"object"},"description":"List of FormItems. FormItems can be SectionDetails and/or FieldDetails","example":[]}}}]}}},"errors":{"type":"array","items":{"type":"string"},"example":["The work item ID that was specified was not found."],"description":"An array of errors that ocurred during the work item"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/work-items/bulk-approve/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Bulk approve Approval Items","description":{"content":"This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request.","type":"text/plain"},"url":{"path":["work-items","bulk-approve",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the work item","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Bulk approve Approval Items' (approve-approval-items-in-bulk)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Bulk approve Approval Items + + + +This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. + +
    Path Parameters
    + +A work items details object. + +
    Schema
      remediationItems object
      approvalItems object
      form object
      sections object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/approve-non-employee-request.api.mdx b/products/idn/api/v3/approve-non-employee-request.api.mdx new file mode 100644 index 000000000..16bb40104 --- /dev/null +++ b/products/idn/api/v3/approve-non-employee-request.api.mdx @@ -0,0 +1,79 @@ +--- +id: approve-non-employee-request +sidebar_label: Approve a Non-Employee Request +hide_title: true +hide_table_of_contents: true +api: {"operationId":"approveNonEmployeeRequest","security":[{"oauth2":[]}],"tags":["Non-Employee Lifecycle Management"],"description":"Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver.","parameters":[{"in":"path","name":"id","description":"Non-Employee approval item id (UUID)","required":true,"schema":{"type":"string"},"example":"e136567de87e4d029e60b3c3c55db56d"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"comment":{"type":"string","description":"Comment on the approval item.","maxLength":4000,"example":"Approved by manager"}}}}}},"responses":{"200":{"description":"Non-Employee approval item object.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee approval item id","example":"2c1e388b-1e55-4b0a-ab5c-897f1204159c"},"approver":{"description":"Reference to the associated Identity","type":"object","properties":{"type":{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}},"accountName":{"type":"string","description":"Requested identity account name","example":"test.account"},"approvalStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status","example":"APPROVED"},"approvalOrder":{"type":"number","description":"Approval order","example":1,"format":"float"},"comment":{"type":"string","description":"comment of approver","example":"I approve"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}},{"type":"object","properties":{"nonEmployeeRequest":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee request id.","example":"ac110005-7156-1150-8171-5b292e3e0084"},"requester":{"type":"object","properties":{"type":{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}},"example":{"type":"IDENTITY","id":"2c9180866166b5b0016167c32ef31a66","name":"William Smith"}}}}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/non-employee-approvals/{id}/approve","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"comment":"Approved by manager"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Approve a Non-Employee Request","description":{"content":"Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver.","type":"text/plain"},"url":{"path":["non-employee-approvals",":id","approve"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Non-Employee approval item id (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Approve a Non-Employee Request' (approve-non-employee-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Approve a Non-Employee Request + + + +Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. + +
    Path Parameters
    Request Body required
    + +Non-Employee approval item object. + +
    Schema
      approver object
      + +Reference to the associated Identity + +
      nonEmployeeRequest object
      requester object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/cancel-access-request.api.mdx b/products/idn/api/v3/cancel-access-request.api.mdx new file mode 100644 index 000000000..faab96021 --- /dev/null +++ b/products/idn/api/v3/cancel-access-request.api.mdx @@ -0,0 +1,88 @@ +--- +id: cancel-access-request +sidebar_label: Cancel Access Request +hide_title: true +hide_table_of_contents: true +api: {"operationId":"cancelAccessRequest","tags":["Access Requests"],"description":"This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step.\nAny token with ORG_ADMIN authority or token of the user who originally requested the access request is required to cancel it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request body payload for cancel access request endpoint.","required":["accountActivityId","comment"],"properties":{"accountActivityId":{"type":"string","description":"ID of the account activity object corresponding to the access request.","example":"2c9180835d2e5168015d32f890ca1581"},"comment":{"type":"string","description":"Reason for cancelling the pending access request.","example":"I requested this role by mistake."}}},"example":{"accountActivityId":"2c91808568c529c60168cca6f90c1313","comment":"I requested this role by mistake."}}}},"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/access-requests/cancel","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"accountActivityId":"2c9180835d2e5168015d32f890ca1581","comment":"I requested this role by mistake."},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Cancel Access Request","description":{"content":"This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step.\nAny token with ORG_ADMIN authority or token of the user who originally requested the access request is required to cancel it.","type":"text/plain"},"url":{"path":["access-requests","cancel"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Cancel Access Request' (cancel-access-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Cancel Access Request + + + +This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. +Any token with ORG_ADMIN authority or token of the user who originally requested the access request is required to cancel it. + +
    Request Body required
    + +Accepted - Returned if the request was successfully accepted into the system. + +
    Schema
    • object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/certification-campaigns.tag.mdx b/products/idn/api/v3/certification-campaigns.tag.mdx new file mode 100644 index 000000000..97fd0c0af --- /dev/null +++ b/products/idn/api/v3/certification-campaigns.tag.mdx @@ -0,0 +1,85 @@ +--- +id: certification-campaigns +title: "Certification Campaigns" +description: "Certification Campaigns" +custom_edit_url: null +--- + + + +Use this API to implement certification campaign functionality. +With this functionality in place, administrators can create, customize, and manage certification campaigns for their organizations' use. +Certification campaigns provide IdentityNow (IDN) users with an interactive review process they can use to identify and verify access to systems. +Campaigns help organizations reduce risk of inappropriate access and satisfy audit requirements. + +A certification refers to IDN's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification campaign as a way of showing that a user's access has been reviewed and approved by multiple managers. +Once this campaign has been completed, IDN would provision all the access the user needs, nothing more. + +IDN provides two simple campaign types users can create without using search queries, Manager and Source Owner campaigns: + +You can create these types of campaigns without using any search queries in IDN: + +- ManagerCampaign: IDN provides this campaign type as a way to ensure that an identity's access is certified by their managers. +You only need to provide a name and description to create one. + +- Source Owner Campaign: IDN provides this campaign type as a way to ensure that an identity's access to a source is certified by its source owners. +You only need to provide a name and description to create one. +You can specify the sources whose owners you want involved or just run it across all sources. + +For more information about these campaign types, refer to [Starting a Manager or Source Owner Campaign](https://documentation.sailpoint.com/saas/help/certs/starting_campaign.html). + +One useful way to create certification campaigns in IDN is to use a specific search and then run a campaign on the results returned by that search. +This allows you to be much more specific about whom you are certifying in your campaigns and what access you are certifying in your campaigns. +For example, you can search for all identities who are managed by "Amanda.Ross" and also have the access to the "Accounting" role and then run a certification campaign based on that search to ensure that the returned identities are appropriately certified. + +You can use IDN search queries to create these types of campaigns: + +- Identities: Use this campaign type to review and revoke access items for specific identities. +You can either build a search query and create a campaign certifying all identities returned by that query, or you can search for individual identities and add those identities to the certification campaign. + +- Access Items: Use this campaign type to review and revoke a set of roles, access profiles, or entitlements from the identities that have them. +You can either build a search query and create a campaign certifying all access items returned by that query, or you can search for individual access items and add those items to the certification campaign. + +- Role Composition: Use this campaign type to review a role's composition, including its title, description, and membership criteria. +You can either build a search query and create a campaign certifying all roles returned by that query, or you can search for individual roles and add those roles to the certification campaign. + +- Uncorrelated Accounts: Use this campaign type to certify source accounts that aren't linked to an authoritative identity in IDN. +You can use this campaign type to view all the uncorrelated accounts for a source and certify them. + +For more information about search-based campaigns, refer to [Starting a Campaign from Search](https://documentation.sailpoint.com/saas/help/certs/starting_search_campaign.html). + +Once you have generated your campaign, it becomes available for preview. +An administrator can review the campaign and make changes, or if it's ready and accurate, activate it. + +Once the campaign is active, organization administrators or certification administrators can designate other IDN users as certification reviewers. +Those reviewers can view any of the certifications they either need to review (active) or have already reviewed (completed). + +When a certification campaign is in progress, certification reviewers see the listed active certifications whose involved identities they can review. +Reviewers can then make decisions to grant or revoke access, as well as reassign the ceritifcation to another reviewer. If the reviewer chooses this option, they must provide a reason for reassignment in the form of a comment. + +Once a reviewer has made decisions on all the certification's involved access items, he or she must "Sign Off" to complete the review process. +Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. + +Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. +In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. +In this situation, the certification campaign completes once all the remediation requests are completed. + +The end of a certification campaign is determined by its deadline, its completion status, or by an administrator's decision. + +For more information about certifications and certification campaigns, refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html). + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/certification-summaries.tag.mdx b/products/idn/api/v3/certification-summaries.tag.mdx new file mode 100644 index 000000000..115993477 --- /dev/null +++ b/products/idn/api/v3/certification-summaries.tag.mdx @@ -0,0 +1,34 @@ +--- +id: certification-summaries +title: "Certification Summaries" +description: "Certification Summaries" +custom_edit_url: null +--- + + + +Use this API to implement certification summary functionality. +With this functionality in place, administrators and designated certification reviewers can review summaries of identity certification campaigns and draw conclusions about the campaigns' scope, security, and effectiveness. +Implementing certification summary functionality improves organizations' ability to review their [certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html) and helps them satisfy audit and regulatory requirements by enabling them to trace access changes and the decisions made in their review processes. + +A certification refers to IdentityNow's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. +Once this certification has been completed, IdentityNow would provision all the access the user needs, nothing more. + +Certification summaries provide information about identity certification campaigns such as the identities involved, the number of decisions made, and the access changed. +For example, an administrator or designated certification reviewer can examine the Manager Certification campaign to get an overview of how many entitlement decisions are made in that campaign as opposed to role decisions, which identities would be affected by changes to the campaign, and how those identities' access would be affected. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/certifications.tag.mdx b/products/idn/api/v3/certifications.tag.mdx new file mode 100644 index 000000000..95a5a85f2 --- /dev/null +++ b/products/idn/api/v3/certifications.tag.mdx @@ -0,0 +1,45 @@ +--- +id: certifications +title: "Certifications" +description: "Certifications" +custom_edit_url: null +--- + + + +Use this API to implement certification functionality. +With this functionality in place, administrators and designated certification reviewers can review users' access certifications and decide whether to approve access, revoke it, or reassign the review to another reviewer. +Implementing certifications improves organizations' data security by reducing inappropriate access through a distributed review process and helping them satisfy audit and regulatory requirements. + +A certification refers to IdentityNow's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. +Once this certification has been completed, IdentityNow would provision all the access the user needs, nothing more. + +Organization administrators or certification administrators can designate other IdentityNow users as certification reviewers. +Those reviewers can select the 'Certifications' tab to view any of the certifications they either need to review or have already reviewed under the 'Active' and 'Completed' tabs, respectively. + +When a certification campaign is in progress, certification reviewers will see certifications listed under 'Active,' where they can review the involved identities. +Under the 'Decision' column on the right, next to each access item, reviewers can select the checkmark to approve access, select the 'X' to revoke access, or they can toggle the 'More Options' menu to reassign the certification to another reviewer and provide a reason for reassignment in the form of a comment. + +Once a reviewer has made decisions on all the certification's involved access items, he or she must select 'Sign Off' to complete the review process. +Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. + +Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. +In this situation, the certification campaign completes once all the remediation requests are completed. + +Refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html) for more information about certifications. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/complete-work-item.api.mdx b/products/idn/api/v3/complete-work-item.api.mdx new file mode 100644 index 000000000..afbd6c53c --- /dev/null +++ b/products/idn/api/v3/complete-work-item.api.mdx @@ -0,0 +1,87 @@ +--- +id: complete-work-item +sidebar_label: Complete a Work Item +hide_title: true +hide_table_of_contents: true +api: {"operationId":"completeWorkItem","tags":["Work Items"],"description":"This API completes a work item. Either an admin, or the owning/current user must make this request.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the work item","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"A WorkItems object","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the work item","example":"2c9180835d2e5168015d32f890ca1581"},"requesterId":{"type":"string","description":"ID of the requester","example":"2c9180835d2e5168015d32f890ca1581"},"requesterDisplayName":{"type":"string","description":"The displayname of the requester","example":"John Smith"},"ownerId":{"type":"string","description":"The ID of the owner","example":"2c9180835d2e5168015d32f890ca1581"},"ownerName":{"type":"string","description":"The name of the owner","example":"Jason Smith"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z","description":"Time when the work item was created"},"modified":{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"Time when the work item was last updated"},"description":{"type":"string","description":"The description of the work item","example":"Create account on source 'AD'"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"},"type":{"type":"string","enum":["UNKNOWN","GENERIC","CERTIFICATION","REMEDIATION","DELEGATION","APPROVAL","VIOLATIONREVIEW","FORM","POLICYVIOLATION","CHALLENGE","IMPACTANALYSIS","SIGNOFF","EVENT","MANUALACTION","TEST"],"example":"GENERIC","description":"The type of the work item"},"remediationItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the certification","example":"2c9180835d2e5168015d32f890ca1581"},"targetId":{"type":"string","description":"The ID of the certification target","example":"2c9180835d2e5168015d32f890ca1581"},"targetName":{"type":"string","description":"The name of the certification target","example":"john.smith"},"targetDisplayName":{"type":"string","description":"The display name of the certification target","example":"emailAddress"},"applicationName":{"type":"string","description":"The name of the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute being certified","example":"phoneNumber"},"attributeOperation":{"type":"string","description":"The operation of the certification on the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute being certified","example":"512-555-1212"},"nativeIdentity":{"type":"string","description":"The native identity of the target","example":"jason.smith2"}}},"approvalItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the approval item","example":"2c9180835d2e5168015d32f890ca1581"},"account":{"type":"string","description":"The account referenced by the approval item","example":"john.smith"},"application":{"type":"string","description":"The name the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute","example":"emailAddress"},"attributeOperation":{"type":"string","description":"The operation of the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute","example":"a@b.com"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"}}},"name":{"type":"string","description":"The work item name","example":"Account Create"},"completed":{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z","description":"The time at which the work item completed"},"numItems":{"type":"integer","format":"int32","description":"The number of items in the work item","example":19},"form":{"type":"object","properties":{"id":{"type":"string","description":"ID of the form","example":"2c9180835d2e5168015d32f890ca1581"},"name":{"type":"string","description":"Name of the form","example":"AccountSelection Form"},"title":{"type":"string","description":"The form title","example":"Account Selection for John.Doe"},"subtitle":{"type":"string","description":"The form subtitle.","example":"Please select from the following"},"targetUser":{"type":"string","description":"The name of the user that should be shown this form","example":"Jane.Doe"},"sections":{"type":"object","allOf":[{"type":"object","properties":{"name":{"type":"string","description":"Name of the FormItem","example":"Field1"}}},{"type":"object","properties":{"label":{"type":"string","description":"Label of the section","example":"Section 1"},"formItems":{"type":"array","items":{"type":"object"},"description":"List of FormItems. FormItems can be SectionDetails and/or FieldDetails","example":[]}}}]}}},"errors":{"type":"array","items":{"type":"string"},"example":["The work item ID that was specified was not found."],"description":"An array of errors that ocurred during the work item"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/work-items/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Complete a Work Item","description":{"content":"This API completes a work item. Either an admin, or the owning/current user must make this request.","type":"text/plain"},"url":{"path":["work-items",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the work item","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Complete a Work Item' (complete-work-item)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Complete a Work Item + + + +This API completes a work item. Either an admin, or the owning/current user must make this request. + +
    Path Parameters
    + +A WorkItems object + +
    Schema
      remediationItems object
      approvalItems object
      form object
      sections object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-access-profile.api.mdx b/products/idn/api/v3/create-access-profile.api.mdx new file mode 100644 index 000000000..dc8d8634e --- /dev/null +++ b/products/idn/api/v3/create-access-profile.api.mdx @@ -0,0 +1,149 @@ +--- +id: create-access-profile +sidebar_label: Create an Access Profile +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createAccessProfile","tags":["Access Profiles"],"description":"This API creates an Access Profile.\nA token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the Access Profile's Source.\nThe maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Access Profile","example":"2c91808a7190d06e01719938fcd20792","readOnly":true},"name":{"type":"string","description":"Name of the Access Profile","example":"Employee-database-read-write"},"description":{"type":"string","nullable":true,"description":"Information about the Access Profile","example":"Collection of entitlements to read/write the employee database"},"created":{"type":"string","description":"Date the Access Profile was created","format":"date-time","example":"2021-03-01T22:32:58.104Z","readOnly":true},"modified":{"type":"string","description":"Date the Access Profile was last modified.","format":"date-time","example":"2021-03-02T20:22:28.104Z","readOnly":true},"enabled":{"type":"boolean","description":"Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement.","example":true},"owner":{"description":"Owner of the Access Profile","type":"object","nullable":true,"properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"source":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Source with with which the Access Profile is associated","example":"2c91809773dee3610173fdb0b6061ef4"},"type":{"type":"string","enum":["SOURCE"],"description":"The type of the Source, will always be SOURCE","example":"SOURCE"},"name":{"type":"string","description":"The display name of the associated Source","example":"ODS-AD-SOURCE"}}},"entitlements":{"type":"array","description":"A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement.","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Entitlement","example":"2c91809773dee32014e13e122092014e"},"type":{"type":"string","enum":["ENTITLEMENT"],"description":"The type of the Entitlement, will always be ENTITLEMENT","example":"ENTITLEMENT"},"name":{"type":"string","description":"The display name of the Entitlement","example":"CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"}}}},"requestable":{"type":"boolean","description":"Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error.","example":true},"accessRequestConfig":{"nullable":true,"description":"Access request configuration for this object","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":true},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":true},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"revocationRequestConfig":{"nullable":true,"description":"Revocation request configuration for this object.","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":false,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":false,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the revocation request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"segments":{"type":"array","nullable":true,"items":{"type":"string"},"description":"List of IDs of segments, if any, to which this Access Profile is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]},"provisioningCriteria":{"description":"When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression is evaluated against those Accounts to choose one to provision with the Access Profile.","nullable":true,"example":{"operation":"OR","children":[{"operation":"AND","children":[{"attribute":"dn","operation":"CONTAINS","value":"useast"},{"attribute":"manager","operation":"CONTAINS","value":"Scott.Clark"}]},{"operation":"AND","children":[{"attribute":"dn","operation":"EQUALS","value":"Gibson"},{"attribute":"telephoneNumber","operation":"CONTAINS","value":"512"}]}]},"type":"object","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","nullable":true,"description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines matching criteria for an Account to be provisioned with a specific Access Profile","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","nullable":true,"description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines matching criteria for an Account to be provisioned with a specific Access Profile","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.","example":null}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.","example":null}}}},"required":["owner","name","source"]}}}},"responses":{"201":{"description":"Access Profile created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Access Profile","example":"2c91808a7190d06e01719938fcd20792","readOnly":true},"name":{"type":"string","description":"Name of the Access Profile","example":"Employee-database-read-write"},"description":{"type":"string","nullable":true,"description":"Information about the Access Profile","example":"Collection of entitlements to read/write the employee database"},"created":{"type":"string","description":"Date the Access Profile was created","format":"date-time","example":"2021-03-01T22:32:58.104Z","readOnly":true},"modified":{"type":"string","description":"Date the Access Profile was last modified.","format":"date-time","example":"2021-03-02T20:22:28.104Z","readOnly":true},"enabled":{"type":"boolean","description":"Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement.","example":true},"owner":{"description":"Owner of the Access Profile","type":"object","nullable":true,"properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"source":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Source with with which the Access Profile is associated","example":"2c91809773dee3610173fdb0b6061ef4"},"type":{"type":"string","enum":["SOURCE"],"description":"The type of the Source, will always be SOURCE","example":"SOURCE"},"name":{"type":"string","description":"The display name of the associated Source","example":"ODS-AD-SOURCE"}}},"entitlements":{"type":"array","description":"A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement.","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Entitlement","example":"2c91809773dee32014e13e122092014e"},"type":{"type":"string","enum":["ENTITLEMENT"],"description":"The type of the Entitlement, will always be ENTITLEMENT","example":"ENTITLEMENT"},"name":{"type":"string","description":"The display name of the Entitlement","example":"CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"}}}},"requestable":{"type":"boolean","description":"Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error.","example":true},"accessRequestConfig":{"nullable":true,"description":"Access request configuration for this object","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":true},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":true},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"revocationRequestConfig":{"nullable":true,"description":"Revocation request configuration for this object.","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":false,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":false,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the revocation request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"segments":{"type":"array","nullable":true,"items":{"type":"string"},"description":"List of IDs of segments, if any, to which this Access Profile is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]},"provisioningCriteria":{"description":"When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression is evaluated against those Accounts to choose one to provision with the Access Profile.","nullable":true,"example":{"operation":"OR","children":[{"operation":"AND","children":[{"attribute":"dn","operation":"CONTAINS","value":"useast"},{"attribute":"manager","operation":"CONTAINS","value":"Scott.Clark"}]},{"operation":"AND","children":[{"attribute":"dn","operation":"EQUALS","value":"Gibson"},{"attribute":"telephoneNumber","operation":"CONTAINS","value":"512"}]}]},"type":"object","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","nullable":true,"description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines matching criteria for an Account to be provisioned with a specific Access Profile","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","nullable":true,"description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines matching criteria for an Account to be provisioned with a specific Access Profile","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.","example":null}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.","example":null}}}},"required":["owner","name","source"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:access-profile:manage"]}],"method":"post","path":"/access-profiles","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"Employee-database-read-write","description":"Collection of entitlements to read/write the employee database","enabled":true,"owner":{"type":"IDENTITY","id":"2c9180a46faadee4016fb4e018c20639","name":"support"},"source":{"id":"2c91809773dee3610173fdb0b6061ef4","type":"SOURCE","name":"ODS-AD-SOURCE"},"entitlements":[{"id":"2c91809773dee32014e13e122092014e","type":"ENTITLEMENT","name":"CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"}],"requestable":true,"accessRequestConfig":{"commentsRequired":true,"denialCommentsRequired":true,"approvalSchemes":[{"approverType":"GOVERNANCE_GROUP","approverId":"46c79819-a69f-49a2-becb-12c971ae66c6"}]},"revocationRequestConfig":{"commentsRequired":false,"denialCommentsRequired":false,"approvalSchemes":[{"approverType":"GOVERNANCE_GROUP","approverId":"46c79819-a69f-49a2-becb-12c971ae66c6"}]},"segments":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"],"provisioningCriteria":{"operation":"OR","children":[{"operation":"AND","children":[{"attribute":"dn","operation":"CONTAINS","value":"useast"},{"attribute":"manager","operation":"CONTAINS","value":"Scott.Clark"}]},{"operation":"AND","children":[{"attribute":"dn","operation":"EQUALS","value":"Gibson"},{"attribute":"telephoneNumber","operation":"CONTAINS","value":"512"}]}]}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Create an Access Profile","description":{"content":"This API creates an Access Profile.\nA token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the Access Profile's Source.\nThe maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters.","type":"text/plain"},"url":{"path":["access-profiles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create an Access Profile' (create-access-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create an Access Profile + + + +This API creates an Access Profile. +A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the Access Profile's Source. +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. + +
    Request Body required
      owner object required
      + +Owner of the Access Profile + +
      source object required
      entitlements object[]
      + +A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. + +
      accessRequestConfig object
      + +Access request configuration for this object + +
      approvalSchemes object[]
      + +List describing the steps in approving the request + +
      revocationRequestConfig object
      + +Revocation request configuration for this object. + +
      approvalSchemes object[]
      + +List describing the steps in approving the revocation request + +
      provisioningCriteria object
      + +When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression is evaluated against those Accounts to choose one to provision with the Access Profile. + +
      children object[]
      + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + +
      children object[]
      + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + +
    + +Access Profile created + +
    Schema
      owner object
      + +Owner of the Access Profile + +
      source object
      entitlements object[]
      + +A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. + +
      accessRequestConfig object
      + +Access request configuration for this object + +
      approvalSchemes object[]
      + +List describing the steps in approving the request + +
      revocationRequestConfig object
      + +Revocation request configuration for this object. + +
      approvalSchemes object[]
      + +List describing the steps in approving the revocation request + +
      provisioningCriteria object
      + +When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression is evaluated against those Accounts to choose one to provision with the Access Profile. + +
      children object[]
      + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + +
      children object[]
      + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-access-request.api.mdx b/products/idn/api/v3/create-access-request.api.mdx new file mode 100644 index 000000000..172d877ff --- /dev/null +++ b/products/idn/api/v3/create-access-request.api.mdx @@ -0,0 +1,114 @@ +--- +id: create-access-request +sidebar_label: Submit an Access Request +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createAccessRequest","security":[{"oauth2":["idn:access-request:manage"]}],"tags":["Access Requests"],"description":"This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes.\n\nAccess requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request\nhas been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error\nif you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected.\nIt is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can\nbe accomplished by using the [access request status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [pending access request approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) endpoints. You can also\nuse the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting\nan access request to ensure you are not requesting access that is already granted.\n\nThere are two types of access request:\n\n__GRANT_ACCESS__\n* Can be requested for multiple identities in a single request.\n* Supports self request and request on behalf of other users, see '/beta/access-request-config' endpoint for request configuration options. \n* Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others.\n* Roles, Access Profiles and Entitlements can be requested.\n* While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request.\n \n__REVOKE_ACCESS__\n* Can only be requested for a single identity at a time.\n* Does not support self request. Only manager can request to revoke access for their directly managed employees.\n* If removeDate is specified, then the access will be removed on that date and time only for Roles and Access Profiles. Entitlements are currently unsupported for removeDate.\n* Roles, Access Profiles, and Entitlements can be requested for revocation.\n* Revoke requests for entitlements are limited to 1 entitlement per access request currently.\n* [Roles, Access Profiles] RemoveData can be specified only if access don't have a sunset date.\n* Allows a manager to request to revoke access for direct employees. A token with ORG_ADMIN authority can also request to revoke access from anyone.\n\nNOTE: There is no indication to the approver in the IdentityNow UI that the approval request is for a revoke action. Take this into consideration when calling this API.\n\nA token with API authority cannot be used to call this endpoint. \n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"requestedFor":{"description":"A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID.","type":"array","items":{"type":"string","example":"2c918084660f45d6016617daa9210584"}},"requestType":{"type":"string","enum":["GRANT_ACCESS","REVOKE_ACCESS"],"description":"Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field.","example":"GRANT_ACCESS"},"requestedItems":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"The type of the item being requested.","example":"ACCESS_PROFILE"},"id":{"type":"string","description":"ID of Role, Access Profile or Entitlement being requested.","example":"2c9180835d2e5168015d32f890ca1581"},"comment":{"type":"string","description":"Comment provided by requester.\n* Comment is required when the request is of type Revoke Access.\n","example":"Requesting access profile for John Doe"},"clientMetadata":{"type":"object","additionalProperties":{"type":"string","example":{"requestedAppId":"2c91808f7892918f0178b78da4a305a1","requestedAppName":"test-app"}},"example":{"requestedAppName":"test-app","requestedAppId":"2c91808f7892918f0178b78da4a305a1"},"description":"Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status."},"removeDate":{"type":"string","description":"The date the role or access profile is no longer assigned to the specified identity.\n* Specify a date in the future.\n* The current SLA for the deprovisioning is 24 hours.\n* This date can be modified to either extend or decrease the duration of access item assignments for the specified identity.\n* Currently it is not supported for entitlements.\n* If sunset date for role or access profile specified, removeDate cannot be established. This rule doesn't apply for entitlements.\n","format":"date-time","example":"2020-07-11T21:23:15.000Z"}},"required":["id","type"]}},"clientMetadata":{"type":"object","additionalProperties":{"type":"string","example":{"requestedAppId":"2c91808f7892918f0178b78da4a305a1","requestedAppName":"test-app"}},"example":{"requestedAppId":"2c91808f7892918f0178b78da4a305a1","requestedAppName":"test-app"},"description":"Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities."}},"required":["requestedFor","requestedItems"]}}}},"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/access-requests","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"requestedFor":["2c918084660f45d6016617daa9210584"],"requestType":"GRANT_ACCESS","requestedItems":[{"type":"ACCESS_PROFILE","id":"2c9180835d2e5168015d32f890ca1581","comment":"Requesting access profile for John Doe","clientMetadata":{"requestedAppName":"test-app","requestedAppId":"2c91808f7892918f0178b78da4a305a1"},"removeDate":"2020-07-11T21:23:15.000Z"}],"clientMetadata":{"requestedAppId":"2c91808f7892918f0178b78da4a305a1","requestedAppName":"test-app"}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Submit an Access Request","description":{"content":"This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes.\n\nAccess requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request\nhas been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error\nif you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected.\nIt is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can\nbe accomplished by using the [access request status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [pending access request approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) endpoints. You can also\nuse the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting\nan access request to ensure you are not requesting access that is already granted.\n\nThere are two types of access request:\n\n__GRANT_ACCESS__\n* Can be requested for multiple identities in a single request.\n* Supports self request and request on behalf of other users, see '/beta/access-request-config' endpoint for request configuration options. \n* Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others.\n* Roles, Access Profiles and Entitlements can be requested.\n* While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request.\n \n__REVOKE_ACCESS__\n* Can only be requested for a single identity at a time.\n* Does not support self request. Only manager can request to revoke access for their directly managed employees.\n* If removeDate is specified, then the access will be removed on that date and time only for Roles and Access Profiles. Entitlements are currently unsupported for removeDate.\n* Roles, Access Profiles, and Entitlements can be requested for revocation.\n* Revoke requests for entitlements are limited to 1 entitlement per access request currently.\n* [Roles, Access Profiles] RemoveData can be specified only if access don't have a sunset date.\n* Allows a manager to request to revoke access for direct employees. A token with ORG_ADMIN authority can also request to revoke access from anyone.\n\nNOTE: There is no indication to the approver in the IdentityNow UI that the approval request is for a revoke action. Take this into consideration when calling this API.\n\nA token with API authority cannot be used to call this endpoint. \n","type":"text/plain"},"url":{"path":["access-requests"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Submit an Access Request' (create-access-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Submit an Access Request + + + +This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes. + +Access requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request +has been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error +if you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected. +It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can +be accomplished by using the [access request status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [pending access request approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) endpoints. You can also +use the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting +an access request to ensure you are not requesting access that is already granted. + +There are two types of access request: + +__GRANT_ACCESS__ +* Can be requested for multiple identities in a single request. +* Supports self request and request on behalf of other users, see '/beta/access-request-config' endpoint for request configuration options. +* Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. +* Roles, Access Profiles and Entitlements can be requested. +* While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. + +__REVOKE_ACCESS__ +* Can only be requested for a single identity at a time. +* Does not support self request. Only manager can request to revoke access for their directly managed employees. +* If removeDate is specified, then the access will be removed on that date and time only for Roles and Access Profiles. Entitlements are currently unsupported for removeDate. +* Roles, Access Profiles, and Entitlements can be requested for revocation. +* Revoke requests for entitlements are limited to 1 entitlement per access request currently. +* [Roles, Access Profiles] RemoveData can be specified only if access don't have a sunset date. +* Allows a manager to request to revoke access for direct employees. A token with ORG_ADMIN authority can also request to revoke access from anyone. + +NOTE: There is no indication to the approver in the IdentityNow UI that the approval request is for a revoke action. Take this into consideration when calling this API. + +A token with API authority cannot be used to call this endpoint. + + +
    Request Body required
      requestedItems object[] required
      clientMetadata object
      + +Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. + +
    • property name* string
      • clientMetadata object
      + +Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. + +
    • property name* string
    + +Accepted - Returned if the request was successfully accepted into the system. + +
    Schema
    • object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-account.api.mdx b/products/idn/api/v3/create-account.api.mdx new file mode 100644 index 000000000..2e85b3473 --- /dev/null +++ b/products/idn/api/v3/create-account.api.mdx @@ -0,0 +1,81 @@ +--- +id: create-account +sidebar_label: Create Account +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createAccount","tags":["Accounts"],"description":"This API submits an account creation task and returns the task ID. \nThe `sourceId` where this account will be created must be included in the `attributes` object.\nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:accounts:manage"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["attributes"],"properties":{"attributes":{"description":"The schema attribute values for the account","type":"object","required":["sourceId"],"properties":{"sourceId":{"type":"string","description":"Target source to create an account","example":"34bfcbe116c9407464af37acbaf7a4dc"}},"additionalProperties":{"type":"string"},"example":{"sourceId":"34bfcbe116c9407464af37acbaf7a4dc","city":"Austin","displayName":"John Doe","userName":"jdoe","sAMAccountName":"jDoe","mail":"john.doe@sailpoint.com"}}}}}}},"responses":{"202":{"description":"Async task details","content":{"application/json":{"schema":{"description":"Accounts async response containing details on started async process","required":["id"],"type":"object","properties":{"id":{"description":"id of the task","type":"string","example":"2c91808474683da6017468693c260195"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/accounts","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"attributes":{"sourceId":"34bfcbe116c9407464af37acbaf7a4dc","city":"Austin","displayName":"John Doe","userName":"jdoe","sAMAccountName":"jDoe","mail":"john.doe@sailpoint.com"}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Create Account","description":{"content":"This API submits an account creation task and returns the task ID. \nThe `sourceId` where this account will be created must be included in the `attributes` object.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Account' (create-account)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Account + + + +This API submits an account creation task and returns the task ID. +The `sourceId` where this account will be created must be included in the `attributes` object. +A token with ORG_ADMIN authority is required to call this API. + +
    Request Body required
      attributes object required
      + +The schema attribute values for the account + +
    + +Async task details + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-campaign.api.mdx b/products/idn/api/v3/create-campaign.api.mdx new file mode 100644 index 000000000..ac9f175ba --- /dev/null +++ b/products/idn/api/v3/create-campaign.api.mdx @@ -0,0 +1,163 @@ +--- +id: create-campaign +sidebar_label: Create a campaign +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createCampaign","tags":["Certification Campaigns"],"description":"Creates a new Certification Campaign with the information provided in the request body.","security":[{"oauth2":["idn:campaign:create"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Campaign","allOf":[{"type":"object","title":"Slim Campaign","required":["name","description","type"],"properties":{"id":{"type":"string","readOnly":true,"description":"Id of the campaign","example":"2c9079b270a266a60170a2779fcb0007"},"name":{"description":"The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","type":"string","example":"Manager Campaign"},"description":{"type":"string","description":"The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","example":"Everyone needs to be reviewed by their manager"},"deadline":{"type":"string","format":"date-time","description":"The campaign's completion deadline.","example":"2020-03-15T10:00:01.456Z"},"type":{"type":"string","description":"The type of campaign. Could be extended in the future.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"},"emailNotificationEnabled":{"type":"boolean","description":"Enables email notification for this campaign","default":false,"example":false},"autoRevokeAllowed":{"type":"boolean","description":"Allows auto revoke for this campaign","default":false,"example":false},"recommendationsEnabled":{"type":"boolean","description":"Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.","default":false,"example":true},"status":{"type":"string","description":"The campaign's current status.","readOnly":true,"enum":["PENDING","STAGED","CANCELING","ACTIVATING","ACTIVE","COMPLETING","COMPLETED","ERROR","ARCHIVED"],"example":"ACTIVE"},"correlatedStatus":{"type":"string","description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"}}},{"type":"object","properties":{"created":{"type":"string","readOnly":true,"format":"date-time","description":"Created time of the campaign","example":"2020-03-03T22:15:13.611Z"},"modified":{"type":"string","readOnly":true,"format":"date-time","description":"Modified time of the campaign","example":"2020-03-03T22:20:12.674Z"},"correlatedStatus":{"description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"},"filter":{"type":"object","description":"Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank.","properties":{"id":{"type":"string","description":"The ID of whatever type of filter is being used.","example":"0fbe863c063c4c88a35fd7f17e8a3df5"},"type":{"type":"string","description":"Type of the filter","enum":["CAMPAIGN_FILTER","RULE"],"example":"CAMPAIGN_FILTER"},"name":{"type":"string","description":"Name of the filter","example":"Test Filter"}}},"sunsetCommentsRequired":{"type":"boolean","description":"Determines if comments on sunset date changes are required.","default":true,"example":true},"sourceOwnerCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SOURCE_OWNER.","properties":{"sourceIds":{"type":"array","description":"The list of sources to be included in the campaign.","items":{"type":"string"},"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]}}},"searchCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SEARCH.","properties":{"type":{"type":"string","description":"The type of search campaign represented.","enum":["IDENTITY","ACCESS"],"example":"ACCESS"},"description":{"type":"string","description":"Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available.","example":"Search Campaign description"},"reviewer":{"description":"If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"query":{"type":"string","description":"The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set.","example":"Search Campaign query description"},"identityIds":{"type":"array","description":"A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set.","items":{"type":"string"},"maxItems":1000,"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]},"accessConstraints":{"type":"array","description":"Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT","ACCESS_PROFILE","ROLE"],"description":"Type of Access","example":"ENTITLEMENT"},"ids":{"description":"Must be set only if operator is SELECTED.","type":"array","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"operator":{"type":"string","enum":["ALL","SELECTED"],"description":"Used to determine whether the scope of the campaign should be reduced for selected ids or all.","example":"SELECTED"}},"required":["type","operator"]},"maxItems":1000}},"required":["type"]},"roleCompositionCampaignInfo":{"type":"object","description":"Optional configuration options for role composition campaigns.","properties":{"reviewer":{"description":"If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"roleIds":{"type":"array","description":"Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"remediatorRef":{"type":"object","description":"This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin.","properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Legal Remediator Type","example":"IDENTITY"},"id":{"type":"string","description":"The ID of the remediator.","example":"2c90ad2a70ace7d50170acf22ca90010"},"name":{"type":"string","description":"The name of the remediator.","readOnly":true,"example":"Role Admin"}},"required":["type","id"]},"query":{"type":"string","description":"Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","example":"Search Query"},"description":{"type":"string","description":"Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available.","example":"Role Composition Description"}},"required":["remediatorRef"]},"alerts":{"type":"array","description":"A list of errors and warnings that have accumulated.","readOnly":true,"items":{"type":"object","properties":{"level":{"type":"string","enum":["ERROR","WARN","INFO"],"description":"Denotes the level of the message","example":"ERROR"},"localizations":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}},"totalCertifications":{"type":"integer","description":"The total number of certifications in this campaign.","readOnly":true,"example":100},"completedCertifications":{"type":"integer","description":"The number of completed certifications in this campaign.","readOnly":true,"example":10},"sourcesWithOrphanEntitlements":{"type":"array","description":"A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented).","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the source","example":"2c90ad2a70ace7d50170acf22ca90010"},"type":{"type":"string","enum":["SOURCE"],"description":"Type","example":"SOURCE"},"name":{"type":"string","description":"Name of the source","example":"Source with orphan entitlements"}}}},"mandatoryCommentRequirement":{"type":"string","description":"Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.","enum":["ALL_DECISIONS","REVOKE_ONLY_DECISIONS","NO_DECISIONS"],"example":"NO_DECISIONS"}}}]},"examples":{"Manager":{"value":{"name":"Manager Review","description":"A review of everyone's access by their manager.","deadline":"2020-12-25T06:00:00.468Z","type":"MANAGER","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"filter":{"type":"CAMPAIGN_FILTER","id":"0c46fb26c6b20967a55517ee90d15b93"},"mandatoryCommentRequirement":"NO_DECISIONS"}},"Search":{"value":{"name":"Search Campaign","description":"Search Campaign","deadline":"2020-12-25T06:00:00.468Z","type":"SEARCH","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"filter":{"type":"CAMPAIGN_FILTER","id":"0c46fb26c6b20967a55517ee90d15b93"},"searchCampaignInfo":{"type":"ACCESS","query":"user"},"mandatoryCommentRequirement":"NO_DECISIONS"}},"Source Owner":{"value":{"name":"Source Owner","description":"Source Owner Info","deadline":"2020-12-25T06:00:00.468Z","type":"SOURCE_OWNER","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"filter":{"type":"CAMPAIGN_FILTER","id":"0c46fb26c6b20967a55517ee90d15b93"},"sourceOwnerCampaignInfo":{"sourceIds":["612b31b1a0f04aaf83123bdb80e70db6"]},"correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"}},"Role Composition":{"value":{"name":"Role Composition Campaign","description":"A review done by a role owner.","deadline":"2020-12-25T06:00:00.468Z","type":"ROLE_COMPOSITION","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"filter":{"type":"CAMPAIGN_FILTER","id":"0c46fb26c6b20967a55517ee90d15b93"},"roleCompositionCampaignInfo":{"remediatorRef":{"type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"roleIds":["b15d609fc5c8434b865fe552315fda8f"]},"mandatoryCommentRequirement":"NO_DECISIONS"}}}}}},"responses":{"200":{"description":"Indicates that the campaign requested was successfully created and returns its representation.","content":{"application/json":{"schema":{"type":"object","title":"Campaign","allOf":[{"type":"object","title":"Slim Campaign","required":["name","description","type"],"properties":{"id":{"type":"string","readOnly":true,"description":"Id of the campaign","example":"2c9079b270a266a60170a2779fcb0007"},"name":{"description":"The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","type":"string","example":"Manager Campaign"},"description":{"type":"string","description":"The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","example":"Everyone needs to be reviewed by their manager"},"deadline":{"type":"string","format":"date-time","description":"The campaign's completion deadline.","example":"2020-03-15T10:00:01.456Z"},"type":{"type":"string","description":"The type of campaign. Could be extended in the future.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"},"emailNotificationEnabled":{"type":"boolean","description":"Enables email notification for this campaign","default":false,"example":false},"autoRevokeAllowed":{"type":"boolean","description":"Allows auto revoke for this campaign","default":false,"example":false},"recommendationsEnabled":{"type":"boolean","description":"Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.","default":false,"example":true},"status":{"type":"string","description":"The campaign's current status.","readOnly":true,"enum":["PENDING","STAGED","CANCELING","ACTIVATING","ACTIVE","COMPLETING","COMPLETED","ERROR","ARCHIVED"],"example":"ACTIVE"},"correlatedStatus":{"type":"string","description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"}}},{"type":"object","properties":{"created":{"type":"string","readOnly":true,"format":"date-time","description":"Created time of the campaign","example":"2020-03-03T22:15:13.611Z"},"modified":{"type":"string","readOnly":true,"format":"date-time","description":"Modified time of the campaign","example":"2020-03-03T22:20:12.674Z"},"correlatedStatus":{"description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"},"filter":{"type":"object","description":"Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank.","properties":{"id":{"type":"string","description":"The ID of whatever type of filter is being used.","example":"0fbe863c063c4c88a35fd7f17e8a3df5"},"type":{"type":"string","description":"Type of the filter","enum":["CAMPAIGN_FILTER","RULE"],"example":"CAMPAIGN_FILTER"},"name":{"type":"string","description":"Name of the filter","example":"Test Filter"}}},"sunsetCommentsRequired":{"type":"boolean","description":"Determines if comments on sunset date changes are required.","default":true,"example":true},"sourceOwnerCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SOURCE_OWNER.","properties":{"sourceIds":{"type":"array","description":"The list of sources to be included in the campaign.","items":{"type":"string"},"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]}}},"searchCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SEARCH.","properties":{"type":{"type":"string","description":"The type of search campaign represented.","enum":["IDENTITY","ACCESS"],"example":"ACCESS"},"description":{"type":"string","description":"Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available.","example":"Search Campaign description"},"reviewer":{"description":"If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"query":{"type":"string","description":"The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set.","example":"Search Campaign query description"},"identityIds":{"type":"array","description":"A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set.","items":{"type":"string"},"maxItems":1000,"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]},"accessConstraints":{"type":"array","description":"Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT","ACCESS_PROFILE","ROLE"],"description":"Type of Access","example":"ENTITLEMENT"},"ids":{"description":"Must be set only if operator is SELECTED.","type":"array","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"operator":{"type":"string","enum":["ALL","SELECTED"],"description":"Used to determine whether the scope of the campaign should be reduced for selected ids or all.","example":"SELECTED"}},"required":["type","operator"]},"maxItems":1000}},"required":["type"]},"roleCompositionCampaignInfo":{"type":"object","description":"Optional configuration options for role composition campaigns.","properties":{"reviewer":{"description":"If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"roleIds":{"type":"array","description":"Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"remediatorRef":{"type":"object","description":"This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin.","properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Legal Remediator Type","example":"IDENTITY"},"id":{"type":"string","description":"The ID of the remediator.","example":"2c90ad2a70ace7d50170acf22ca90010"},"name":{"type":"string","description":"The name of the remediator.","readOnly":true,"example":"Role Admin"}},"required":["type","id"]},"query":{"type":"string","description":"Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","example":"Search Query"},"description":{"type":"string","description":"Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available.","example":"Role Composition Description"}},"required":["remediatorRef"]},"alerts":{"type":"array","description":"A list of errors and warnings that have accumulated.","readOnly":true,"items":{"type":"object","properties":{"level":{"type":"string","enum":["ERROR","WARN","INFO"],"description":"Denotes the level of the message","example":"ERROR"},"localizations":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}},"totalCertifications":{"type":"integer","description":"The total number of certifications in this campaign.","readOnly":true,"example":100},"completedCertifications":{"type":"integer","description":"The number of completed certifications in this campaign.","readOnly":true,"example":10},"sourcesWithOrphanEntitlements":{"type":"array","description":"A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented).","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the source","example":"2c90ad2a70ace7d50170acf22ca90010"},"type":{"type":"string","enum":["SOURCE"],"description":"Type","example":"SOURCE"},"name":{"type":"string","description":"Name of the source","example":"Source with orphan entitlements"}}}},"mandatoryCommentRequirement":{"type":"string","description":"Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.","enum":["ALL_DECISIONS","REVOKE_ONLY_DECISIONS","NO_DECISIONS"],"example":"NO_DECISIONS"}}}]},"examples":{"Manager":{"value":{"id":"5594f43b76804a6980ece5fdccf74be7","name":"Manager Review","description":"A review of everyone's access by their manager.","deadline":"2020-12-25T06:00:00.468Z","type":"MANAGER","status":"PENDING","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"created":"2022-08-02T20:21:18.421Z","modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"0fbe863c063c4c88a35fd7f17e8a3df5","name":"Test Manager Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":null,"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":0,"completedCertifications":0,"sourcesWithOrphanEntitlements":null,"mandatoryCommentRequirement":"NO_DECISIONS"}},"Search":{"value":{"id":"ec041831cb2147778b594feb9d8db44a","name":"Search Campaign","description":"Search Campaign","deadline":"2020-12-25T06:00:00.468Z","type":"SEARCH","status":"PENDING","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"created":"2022-08-03T13:54:34.344Z","modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"0fbe863c063c4c88a35fd7f17e8a3df5","name":"Test Search Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":{"type":"ACCESS","description":"user","reviewer":{"type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":null},"query":"user","identityIds":null,"accessConstraints":[]},"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":0,"completedCertifications":0,"sourcesWithOrphanEntitlements":null,"mandatoryCommentRequirement":"NO_DECISIONS"}},"Source Owner":{"value":{"id":"fd7b76ba4ea042de8a9414aa12fc977a","name":"Source Owner","description":"Source Owner Info","deadline":"2020-12-25T06:00:00.468Z","type":"SOURCE_OWNER","status":"PENDING","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"created":"2022-08-03T13:34:19.541Z","modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"0fbe863c063c4c88a35fd7f17e8a3df5","name":"Test Source Owner Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"sourceIds":["612b31b1a0f04aaf83123bdb80e70db6"],"searchCampaignInfo":null,"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":0,"completedCertifications":0,"sourcesWithOrphanEntitlements":null,"correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"}},"Role Composition":{"value":{"id":"3b2e2e5821e84127b6d693d41c40623b","name":"Role Composition Campaign","description":"A review done by a role owner.","deadline":"2020-12-25T06:00:00.468Z","type":"ROLE_COMPOSITION","status":"PENDING","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"created":"2022-08-02T20:30:46.083Z","modified":null,"filter":{"type":"CAMPAIGN_FILTER","id":"0fbe863c063c4c88a35fd7f17e8a3df5","name":"Test Role Composition Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":null,"roleCompositionCampaignInfo":{"remediatorRef":{"type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"reviewerId":null,"reviewer":null,"roleIds":["b15d609fc5c8434b865fe552315fda8f"],"query":null,"description":null},"alerts":null,"totalCertifications":0,"completedCertifications":0,"sourcesWithOrphanEntitlements":null,"mandatoryCommentRequirement":"NO_DECISIONS"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/campaigns","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"Manager Campaign","description":"Everyone needs to be reviewed by their manager","deadline":"2020-03-15T10:00:01.456Z","type":"MANAGER","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":true,"correlatedStatus":"CORRELATED","filter":{"id":"0fbe863c063c4c88a35fd7f17e8a3df5","type":"CAMPAIGN_FILTER","name":"Test Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":{"sourceIds":["0fbe863c063c4c88a35fd7f17e8a3df5"]},"searchCampaignInfo":{"type":"ACCESS","description":"Search Campaign description","reviewer":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"},"query":"Search Campaign query description","identityIds":["0fbe863c063c4c88a35fd7f17e8a3df5"],"accessConstraints":[{"type":"ENTITLEMENT","ids":["2c90ad2a70ace7d50170acf22ca90010"],"operator":"SELECTED"}]},"roleCompositionCampaignInfo":{"reviewer":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"},"roleIds":["2c90ad2a70ace7d50170acf22ca90010"],"remediatorRef":{"type":"IDENTITY","id":"2c90ad2a70ace7d50170acf22ca90010"},"query":"Search Query","description":"Role Composition Description"},"mandatoryCommentRequirement":"NO_DECISIONS"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Create a campaign","description":{"content":"Creates a new Certification Campaign with the information provided in the request body.","type":"text/plain"},"url":{"path":["campaigns"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a campaign' (create-campaign)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create a campaign + + + +Creates a new Certification Campaign with the information provided in the request body. + +
    Request Body required
      filter object
      + +Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank. + +
      sourceOwnerCampaignInfo object
      + +Must be set only if the campaign type is SOURCE_OWNER. + +
      searchCampaignInfo object
      + +Must be set only if the campaign type is SEARCH. + +
      reviewer object
      + +If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP + +
      accessConstraints object[]
      + +**Possible values:** `<= 1000` + +
      + +Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. + +
      roleCompositionCampaignInfo object
      + +Optional configuration options for role composition campaigns. + +
      reviewer object
      + +If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP + +
      remediatorRef object required
      + +This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin. + +
      alerts object[]
      + +A list of errors and warnings that have accumulated. + +
      localizations object[]
      sourcesWithOrphanEntitlements object[]
      + +A list of sources in the campaign that contain \"orphan entitlements\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). + +
    + +Indicates that the campaign requested was successfully created and returns its representation. + +
    Schema
      filter object
      + +Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank. + +
      sourceOwnerCampaignInfo object
      + +Must be set only if the campaign type is SOURCE_OWNER. + +
      searchCampaignInfo object
      + +Must be set only if the campaign type is SEARCH. + +
      reviewer object
      + +If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP + +
      accessConstraints object[]
      + +**Possible values:** `<= 1000` + +
      + +Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. + +
      roleCompositionCampaignInfo object
      + +Optional configuration options for role composition campaigns. + +
      reviewer object
      + +If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP + +
      remediatorRef object
      + +This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin. + +
      alerts object[]
      + +A list of errors and warnings that have accumulated. + +
      localizations object[]
      sourcesWithOrphanEntitlements object[]
      + +A list of sources in the campaign that contain \"orphan entitlements\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-lifecycle-state.api.mdx b/products/idn/api/v3/create-lifecycle-state.api.mdx new file mode 100644 index 000000000..a88358dfa --- /dev/null +++ b/products/idn/api/v3/create-lifecycle-state.api.mdx @@ -0,0 +1,88 @@ +--- +id: create-lifecycle-state +sidebar_label: Create Lifecycle State +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createLifecycleState","tags":["Lifecycle States"],"description":"This API creates a new Lifecycle State.\nA token with ORG_ADMIN or API authority is required to call this API.","security":[{"oauth2":["idn:identity-profile-lifecycle-state:manage"]}],"parameters":[{"in":"path","name":"identity-profile-id","description":"Identity Profile ID","required":true,"schema":{"type":"string"},"example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"description":"Lifecycle State","required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true},"modified":{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}},{"type":"object","required":["technicalName"],"properties":{"enabled":{"type":"boolean","example":true,"description":"Whether the lifecycle state is enabled or disabled."},"technicalName":{"type":"string","example":"Technical Name","description":"The technical name for lifecycle state. This is for internal use."},"description":{"type":"string","example":"Lifecycle description","description":"Lifecycle state description."},"identityCount":{"type":"integer","format":"int32","example":42,"readOnly":true,"description":"Number of identities that have the lifecycle state."},"emailNotificationOption":{"type":"object","description":"This is used for representing email configuration for a lifecycle state","properties":{"notifyManagers":{"type":"boolean","example":true,"description":"If true, then the manager is notified of the lifecycle state change."},"notifyAllAdmins":{"type":"boolean","example":true,"description":"If true, then all the admins are notified of the lifecycle state change."},"notifySpecificUsers":{"type":"boolean","example":true,"description":"If true, then the users specified in \"emailAddressList\" below are notified of lifecycle state change."},"emailAddressList":{"type":"array","example":["test@test.com","test2@test.com"],"items":{"type":"string"},"description":"List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change."}}},"accountActions":{"type":"array","items":{"type":"object","description":"Object for specifying Actions to be performed on a specified list of sources' account.","properties":{"action":{"example":"ENABLE","type":"string","description":"Describes if action will be enabled or disabled","enum":["ENABLE","DISABLE"]},"sourceIds":{"type":"array","items":{"type":"string"},"uniqueItems":true,"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"],"description":"List of unique source IDs. The sources must have the ENABLE feature or flat file source. See \"/sources\" endpoint for source features."}}}},"accessProfileIds":{"type":"array","items":{"type":"string"},"uniqueItems":true,"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"],"description":"List of unique access-profile IDs that are associated with the lifecycle state."}}}]}}}},"responses":{"201":{"description":"Created LifecycleState object.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true},"modified":{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}},{"type":"object","required":["technicalName"],"properties":{"enabled":{"type":"boolean","example":true,"description":"Whether the lifecycle state is enabled or disabled."},"technicalName":{"type":"string","example":"Technical Name","description":"The technical name for lifecycle state. This is for internal use."},"description":{"type":"string","example":"Lifecycle description","description":"Lifecycle state description."},"identityCount":{"type":"integer","format":"int32","example":42,"readOnly":true,"description":"Number of identities that have the lifecycle state."},"emailNotificationOption":{"type":"object","description":"This is used for representing email configuration for a lifecycle state","properties":{"notifyManagers":{"type":"boolean","example":true,"description":"If true, then the manager is notified of the lifecycle state change."},"notifyAllAdmins":{"type":"boolean","example":true,"description":"If true, then all the admins are notified of the lifecycle state change."},"notifySpecificUsers":{"type":"boolean","example":true,"description":"If true, then the users specified in \"emailAddressList\" below are notified of lifecycle state change."},"emailAddressList":{"type":"array","example":["test@test.com","test2@test.com"],"items":{"type":"string"},"description":"List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change."}}},"accountActions":{"type":"array","items":{"type":"object","description":"Object for specifying Actions to be performed on a specified list of sources' account.","properties":{"action":{"example":"ENABLE","type":"string","description":"Describes if action will be enabled or disabled","enum":["ENABLE","DISABLE"]},"sourceIds":{"type":"array","items":{"type":"string"},"uniqueItems":true,"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"],"description":"List of unique source IDs. The sources must have the ENABLE feature or flat file source. See \"/sources\" endpoint for source features."}}}},"accessProfileIds":{"type":"array","items":{"type":"string"},"uniqueItems":true,"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"],"description":"List of unique access-profile IDs that are associated with the lifecycle state."}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/identity-profiles/{identity-profile-id}/lifecycle-states","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"aName","enabled":true,"technicalName":"Technical Name","description":"Lifecycle description","emailNotificationOption":{"notifyManagers":true,"notifyAllAdmins":true,"notifySpecificUsers":true,"emailAddressList":["test@test.com","test2@test.com"]},"accountActions":[{"action":"ENABLE","sourceIds":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}],"accessProfileIds":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Create Lifecycle State","description":{"content":"This API creates a new Lifecycle State.\nA token with ORG_ADMIN or API authority is required to call this API.","type":"text/plain"},"url":{"path":["identity-profiles",":identity-profile-id","lifecycle-states"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Identity Profile ID","type":"text/plain"},"type":"any","value":"","key":"identity-profile-id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Lifecycle State' (create-lifecycle-state)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Lifecycle State + + + +This API creates a new Lifecycle State. +A token with ORG_ADMIN or API authority is required to call this API. + +
    Path Parameters
    Request Body required
    + +Lifecycle State + +
      emailNotificationOption object
      + +This is used for representing email configuration for a lifecycle state + +
      accountActions object[]
    + +Created LifecycleState object. + +
    Schema
      emailNotificationOption object
      + +This is used for representing email configuration for a lifecycle state + +
      accountActions object[]
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-non-employee-record.api.mdx b/products/idn/api/v3/create-non-employee-record.api.mdx new file mode 100644 index 000000000..b59c3a001 --- /dev/null +++ b/products/idn/api/v3/create-non-employee-record.api.mdx @@ -0,0 +1,88 @@ +--- +id: create-non-employee-record +sidebar_label: Create Non-Employee Record +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createNonEmployeeRecord","tags":["Non-Employee Lifecycle Management"],"description":"This request will create a non-employee record.\nRequires role context of `idn:nesr:create`","requestBody":{"description":"Non-Employee record creation request body.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accountName":{"type":"string","description":"Requested identity account name.","example":"william.smith"},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"sourceId":{"type":"string","description":"Non-Employee's source id.","example":"2c91808568c529c60168cca6f90c1313"},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported.","example":{"description":"Auditing"}},"startDate":{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2020-03-24T00:00:00-05:00"},"endDate":{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2021-03-25T00:00:00-05:00"}},"required":["accountName","firstName","lastName","email","phone","manager","sourceId","startDate","endDate"]}}}},"responses":{"200":{"description":"Created non-employee record.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee record id.","example":"ef38f94347e94562b5bb8424a56397d8"},"accountName":{"type":"string","description":"Requested identity account name.","example":"Abby.Smith"},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"sourceId":{"type":"string","description":"Non-Employee's source id.","example":"2c91808568c529c60168cca6f90c1313"},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee.","example":{"description":"Auditing"}},"startDate":{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2019-08-23T18:52:59.162Z"},"endDate":{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2020-08-23T18:52:59.162Z"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/non-employee-records","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"accountName":"william.smith","firstName":"William","lastName":"Smith","email":"william.smith@example.com","phone":"5555555555","manager":"jane.doe","sourceId":"2c91808568c529c60168cca6f90c1313","data":{"description":"Auditing"},"startDate":"2020-03-24T00:00:00-05:00","endDate":"2021-03-25T00:00:00-05:00"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Create Non-Employee Record","description":{"content":"This request will create a non-employee record.\nRequires role context of `idn:nesr:create`","type":"text/plain"},"url":{"path":["non-employee-records"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Non-Employee Record' (create-non-employee-record)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Non-Employee Record + + + +This request will create a non-employee record. +Requires role context of `idn:nesr:create` + +
    Request Body required
    + +Non-Employee record creation request body. + +
      data object
      + +Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported. + +
    • property name* string
    + +Created non-employee record. + +
    Schema
      data object
      + +Attribute blob/bag for a non-employee. + +
    • property name* string
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-non-employee-request.api.mdx b/products/idn/api/v3/create-non-employee-request.api.mdx new file mode 100644 index 000000000..50572dbe8 --- /dev/null +++ b/products/idn/api/v3/create-non-employee-request.api.mdx @@ -0,0 +1,95 @@ +--- +id: create-non-employee-request +sidebar_label: Create Non-Employee Request +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createNonEmployeeRequest","security":[{"oauth2":[]}],"tags":["Non-Employee Lifecycle Management"],"description":"This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source.","requestBody":{"description":"Non-Employee creation request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accountName":{"type":"string","description":"Requested identity account name.","example":"william.smith"},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"sourceId":{"type":"string","description":"Non-Employee's source id.","example":"2c91808568c529c60168cca6f90c1313"},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported.","example":{"description":"Auditing"}},"startDate":{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2020-03-24T00:00:00-05:00"},"endDate":{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2021-03-25T00:00:00-05:00"}},"required":["accountName","firstName","lastName","email","phone","manager","sourceId","startDate","endDate"]}}}},"responses":{"200":{"description":"Non-Employee request creation object","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"},"sourceId":{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"},"description":{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}},{"type":"object","properties":{"accountName":{"type":"string","description":"Requested identity account name.","example":"william.smith"},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"nonEmployeeSource":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"},"sourceId":{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"},"description":{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee.","example":{"description":"Auditing"}},"approvalItems":{"description":"List of approval item for the request","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee approval item id","example":"2c1e388b-1e55-4b0a-ab5c-897f1204159c"},"approver":{"description":"Reference to the associated Identity","type":"object","properties":{"type":{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}},"accountName":{"type":"string","description":"Requested identity account name","example":"test.account"},"approvalStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status","example":"APPROVED"},"approvalOrder":{"type":"number","description":"Approval order","example":1,"format":"float"},"comment":{"type":"string","description":"comment of approver","example":"I approve"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}}},"approvalStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status","example":"APPROVED"},"comment":{"type":"string","description":"comment of requester","example":"approved"},"completionDate":{"type":"string","format":"date-time","description":"When the request was completely approved.","example":"2020-03-24T11:11:41.139-05:00"},"startDate":{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2020-03-24T00:00:00-05:00"},"endDate":{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2021-03-25T00:00:00-05:00"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2020-03-24T11:11:41.139-05:00"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2020-03-24T11:11:41.139-05:00"}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"400.1 Bad Request Content":{"description":"Response for bad request content","value":{"detailCode":"400.1 Bad Request Content","trackingId":"e7eab60924f64aa284175b9fa3309599","messages":[{"locale":"en","localeOrigin":"REQUEST","text":"firstName is required; accountName is required;"}]}},"400.1.409 Reference conflict":{"description":"Response for reference conflict","value":{"detailCode":"400.1.409 Reference conflict","trackingId":"e7eab60924f64aa284175b9fa3309599","messages":[{"locale":"en","localeOrigin":"REQUEST","text":"Unable to create Non-Employee because the accountName \"existed\" is already being used."}]}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/non-employee-requests","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"accountName":"william.smith","firstName":"William","lastName":"Smith","email":"william.smith@example.com","phone":"5555555555","manager":"jane.doe","sourceId":"2c91808568c529c60168cca6f90c1313","data":{"description":"Auditing"},"startDate":"2020-03-24T00:00:00-05:00","endDate":"2021-03-25T00:00:00-05:00"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Create Non-Employee Request","description":{"content":"This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source.","type":"text/plain"},"url":{"path":["non-employee-requests"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Non-Employee Request' (create-non-employee-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Non-Employee Request + + + +This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. + +
    Request Body required
    + +Non-Employee creation request body + +
      data object
      + +Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported. + +
    • property name* string
    + +Non-Employee request creation object + +
    Schema
      nonEmployeeSource object
      data object
      + +Attribute blob/bag for a non-employee. + +
    • property name* string
      • approvalItems object[]
      + +List of approval item for the request + +
      approver object
      + +Reference to the associated Identity + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-non-employee-source-schema-attributes.api.mdx b/products/idn/api/v3/create-non-employee-source-schema-attributes.api.mdx new file mode 100644 index 000000000..f5eb79df0 --- /dev/null +++ b/products/idn/api/v3/create-non-employee-source-schema-attributes.api.mdx @@ -0,0 +1,76 @@ +--- +id: create-non-employee-source-schema-attributes +sidebar_label: Create a new Schema Attribute for Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createNonEmployeeSourceSchemaAttributes","tags":["Non-Employee Lifecycle Management"],"description":"This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response.\nRequires role context of `idn:nesr:create`","parameters":[{"in":"path","name":"sourceId","schema":{"type":"string"},"required":true,"description":"The Source id","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Type of the attribute. Only type 'TEXT' is supported for custom attributes.","example":"TEXT"},"label":{"type":"string","description":"Label displayed on the UI for this schema attribute.","example":"Account Name"},"technicalName":{"type":"string","description":"The technical name of the attribute. Must be unique per source.","example":"account.name"},"helpText":{"type":"string","description":"help text displayed by UI.","example":"The unique identifier for the account"},"placeholder":{"type":"string","description":"Hint text that fills UI box.","example":"Enter a unique user name for this account."},"required":{"type":"boolean","description":"If true, the schema attribute is required for all non-employees in the source","example":true}},"required":["type","technicalName","label"]}}}},"responses":{"200":{"description":"Schema Attribute created.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"UUID","example":"ac110005-7156-1150-8171-5b292e3e0084","description":"Schema Attribute Id"},"system":{"type":"boolean","description":"True if this schema attribute is mandatory on all non-employees sources.","example":true},"modified":{"type":"string","format":"date-time","description":"When the schema attribute was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the schema attribute was created.","example":"2019-08-23T18:40:35.772Z"},"type":{"type":"string","enum":["TEXT","DATE","IDENTITY"],"description":"Enum representing the type of data a schema attribute accepts.","example":"TEXT"},"label":{"type":"string","description":"Label displayed on the UI for this schema attribute.","example":"Account Name"},"technicalName":{"type":"string","description":"The technical name of the attribute. Must be unique per source.","example":"account.name"},"helpText":{"type":"string","description":"help text displayed by UI.","example":"The unique identifier for the account"},"placeholder":{"type":"string","description":"Hint text that fills UI box.","example":"Enter a unique user name for this account."},"required":{"type":"boolean","description":"If true, the schema attribute is required for all non-employees in the source","example":true}},"required":["type","technicalName","label"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/non-employee-sources/{sourceId}/schema-attributes","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"type":"TEXT","label":"Account Name","technicalName":"account.name","helpText":"The unique identifier for the account","placeholder":"Enter a unique user name for this account.","required":true},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Create a new Schema Attribute for Non-Employee Source","description":{"content":"This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response.\nRequires role context of `idn:nesr:create`","type":"text/plain"},"url":{"path":["non-employee-sources",":sourceId","schema-attributes"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a new Schema Attribute for Non-Employee Source' (create-non-employee-source-schema-attributes)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create a new Schema Attribute for Non-Employee Source + + + +This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. +Requires role context of `idn:nesr:create` + +
    Path Parameters
    Request Body required
    + +Schema Attribute created. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-non-employee-source.api.mdx b/products/idn/api/v3/create-non-employee-source.api.mdx new file mode 100644 index 000000000..b151ad872 --- /dev/null +++ b/products/idn/api/v3/create-non-employee-source.api.mdx @@ -0,0 +1,107 @@ +--- +id: create-non-employee-source +sidebar_label: Create Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createNonEmployeeSource","tags":["Non-Employee Lifecycle Management"],"description":"This request will create a non-employee source. Requires role context of `idn:nesr:create`","requestBody":{"description":"Non-Employee source creation request body.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of non-employee source.","example":"Retail"},"description":{"type":"string","description":"Description of non-employee source.","example":"Source description"},"owner":{"description":"Owner of non-employee source.","type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Identity id.","example":"2c91808570313110017040b06f344ec9"}},"required":["id"]},"managementWorkgroup":{"type":"string","description":"The ID for the management workgroup that contains source sub-admins","example":"123299"},"approvers":{"description":"List of approvers.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Identity id.","example":"2c91808570313110017040b06f344ec9"}},"required":["id"]},"maxItems":3},"accountManagers":{"description":"List of account managers.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Identity id.","example":"2c91808570313110017040b06f344ec9"}},"required":["id"]},"maxItems":10}},"required":["owner","name","description"]}}}},"responses":{"200":{"description":"Created non-employee source.","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"},"sourceId":{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"},"description":{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}},{"type":"object","properties":{"approvers":{"description":"List of approvers","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}}},"accountManagers":{"description":"List of account managers","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}}},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}}]},{"type":"object","properties":{"cloudExternalId":{"type":"string","description":"Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present.","example":"99999"}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/non-employee-sources","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"Retail","description":"Source description","owner":{"id":"2c91808570313110017040b06f344ec9"},"managementWorkgroup":"123299","approvers":[{"id":"2c91808570313110017040b06f344ec9"}],"accountManagers":[{"id":"2c91808570313110017040b06f344ec9"}]},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Create Non-Employee Source","description":{"content":"This request will create a non-employee source. Requires role context of `idn:nesr:create`","type":"text/plain"},"url":{"path":["non-employee-sources"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Non-Employee Source' (create-non-employee-source)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Non-Employee Source + + + +This request will create a non-employee source. Requires role context of `idn:nesr:create` + +
    Request Body required
    + +Non-Employee source creation request body. + +
      owner object required
      + +Owner of non-employee source. + +
      approvers object[]
      + +**Possible values:** `<= 3` + +
      + +List of approvers. + +
      accountManagers object[]
      + +**Possible values:** `<= 10` + +
      + +List of account managers. + +
    + +Created non-employee source. + +
    Schema
      approvers object[]
      + +List of approvers + +
      accountManagers object[]
      + +List of account managers + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-oauth-client.api.mdx b/products/idn/api/v3/create-oauth-client.api.mdx new file mode 100644 index 000000000..551068bbb --- /dev/null +++ b/products/idn/api/v3/create-oauth-client.api.mdx @@ -0,0 +1,75 @@ +--- +id: create-oauth-client +sidebar_label: Create OAuth Client +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createOauthClient","security":[{"oauth2":["sp:oauth-client:manage"]}],"tags":["OAuth Clients"],"description":"This creates an OAuth client.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"businessName":{"type":"string","nullable":true,"description":"The name of the business the API Client should belong to","example":"Acme-Solar"},"homepageUrl":{"type":"string","nullable":true,"description":"The homepage URL associated with the owner of the API Client","example":"http://localhost:12345"},"name":{"type":"string","nullable":true,"description":"A human-readable name for the API Client","example":"Demo API Client"},"description":{"type":"string","nullable":true,"description":"A description of the API Client","example":"An API client used for the authorization_code, refresh_token, and client_credentials flows"},"accessTokenValiditySeconds":{"description":"The number of seconds an access token generated for this API Client is valid for","type":"integer","format":"int32","example":750},"refreshTokenValiditySeconds":{"description":"The number of seconds a refresh token generated for this API Client is valid for","example":86400,"type":"integer","format":"int32"},"redirectUris":{"type":"array","nullable":true,"items":{"type":"string"},"description":"A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client.","example":["http://localhost:12345"]},"grantTypes":{"type":"array","nullable":true,"items":{"description":"OAuth2 Grant Type","type":"string","example":"CLIENT_CREDENTIALS","enum":["CLIENT_CREDENTIALS","AUTHORIZATION_CODE","REFRESH_TOKEN"]},"description":"A list of OAuth 2.0 grant types this API Client can be used with","example":["AUTHORIZATION_CODE","CLIENT_CREDENTIALS","REFRESH_TOKEN"]},"accessType":{"description":"The access type (online or offline) of this API Client","example":"OFFLINE","type":"string","enum":["ONLINE","OFFLINE"]},"type":{"description":"The type of the API Client (public or confidential)","example":"CONFIDENTIAL","type":"string","enum":["CONFIDENTIAL","PUBLIC"]},"internal":{"type":"boolean","description":"An indicator of whether the API Client can be used for requests internal within the product.","example":false},"enabled":{"type":"boolean","description":"An indicator of whether the API Client is enabled for use","example":true},"strongAuthSupported":{"type":"boolean","description":"An indicator of whether the API Client supports strong authentication","example":false},"claimsSupported":{"type":"boolean","description":"An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow","example":false},"scope":{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the API Client. If no scope is specified, the client will be created with the default scope \"sp:scopes:all\". This means the API Client will have all the rights of the owner who created it.","example":["demo:api-client-scope:first","demo:api-client-scope:second"]}},"required":["name","description","accessTokenValiditySeconds","grantTypes","accessType","enabled"]}}}},"responses":{"200":{"description":"Request succeeded.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the OAuth client","example":"2c9180835d2e5168015d32f890ca1581"},"secret":{"type":"string","description":"Secret of the OAuth client (This field is only returned on the intial create call.)","example":"5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3"},"businessName":{"type":"string","description":"The name of the business the API Client should belong to","example":"Acme-Solar"},"homepageUrl":{"type":"string","description":"The homepage URL associated with the owner of the API Client","example":"http://localhost:12345"},"name":{"type":"string","description":"A human-readable name for the API Client","example":"Demo API Client"},"description":{"type":"string","description":"A description of the API Client","example":"An API client used for the authorization_code, refresh_token, and client_credentials flows"},"accessTokenValiditySeconds":{"description":"The number of seconds an access token generated for this API Client is valid for","example":750,"type":"integer","format":"int32"},"refreshTokenValiditySeconds":{"description":"The number of seconds a refresh token generated for this API Client is valid for","example":86400,"type":"integer","format":"int32"},"redirectUris":{"type":"array","items":{"type":"string"},"description":"A list of the approved redirect URIs used with the authorization_code flow","example":["http://localhost:12345"]},"grantTypes":{"type":"array","items":{"description":"OAuth2 Grant Type","type":"string","example":"CLIENT_CREDENTIALS","enum":["CLIENT_CREDENTIALS","AUTHORIZATION_CODE","REFRESH_TOKEN"]},"description":"A list of OAuth 2.0 grant types this API Client can be used with","example":["AUTHORIZATION_CODE","CLIENT_CREDENTIALS","REFRESH_TOKEN"]},"accessType":{"description":"The access type (online or offline) of this API Client","example":"OFFLINE","type":"string","enum":["ONLINE","OFFLINE"]},"type":{"description":"The type of the API Client (public or confidential)","example":"CONFIDENTIAL","type":"string","enum":["CONFIDENTIAL","PUBLIC"]},"internal":{"type":"boolean","description":"An indicator of whether the API Client can be used for requests internal to IDN","example":false},"enabled":{"type":"boolean","description":"An indicator of whether the API Client is enabled for use","example":true},"strongAuthSupported":{"type":"boolean","description":"An indicator of whether the API Client supports strong authentication","example":false},"claimsSupported":{"type":"boolean","description":"An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow","example":false},"created":{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when the API Client was created","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when the API Client was last updated","example":"2018-06-25T20:22:28.104Z"},"scope":{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the API Client.","example":["demo:api-client-scope:first","demo:api-client-scope:second"]}},"required":["id","secret","businessName","homepageUrl","name","description","accessTokenValiditySeconds","refreshTokenValiditySeconds","redirectUris","grantTypes","accessType","type","internal","enabled","strongAuthSupported","claimsSupported","created","modified","scope"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/oauth-clients","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"businessName":"Acme-Solar","homepageUrl":"http://localhost:12345","name":"Demo API Client","description":"An API client used for the authorization_code, refresh_token, and client_credentials flows","accessTokenValiditySeconds":750,"refreshTokenValiditySeconds":86400,"redirectUris":["http://localhost:12345"],"grantTypes":["AUTHORIZATION_CODE","CLIENT_CREDENTIALS","REFRESH_TOKEN"],"accessType":"OFFLINE","type":"CONFIDENTIAL","internal":false,"enabled":true,"strongAuthSupported":false,"claimsSupported":false,"scope":["demo:api-client-scope:first","demo:api-client-scope:second"]},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Create OAuth Client","description":{"content":"This creates an OAuth client.","type":"text/plain"},"url":{"path":["oauth-clients"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create OAuth Client' (create-oauth-client)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create OAuth Client + + + +This creates an OAuth client. + +
    Request Body required
    + +Request succeeded. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-password-org-config.api.mdx b/products/idn/api/v3/create-password-org-config.api.mdx new file mode 100644 index 000000000..7297d0693 --- /dev/null +++ b/products/idn/api/v3/create-password-org-config.api.mdx @@ -0,0 +1,75 @@ +--- +id: create-password-org-config +sidebar_label: Create Password Org Config +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createPasswordOrgConfig","tags":["Password Configuration"],"description":"This API creates the password org config. Unspecified fields will use default value. Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'","security":[{"oauth2":["idn:password-org-config:write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customInstructionsEnabled":{"type":"boolean","description":"Indicator whether custom password instructions feature is enabled. The default value is false.","default":false,"example":true},"digitTokenEnabled":{"type":"boolean","description":"Indicator whether \"digit token\" feature is enabled. The default value is false.","default":false,"example":true},"digitTokenDurationMinutes":{"type":"integer","format":"int32","description":"The duration of \"digit token\" in minutes. The default value is 5.","minimum":1,"maximum":60,"default":5,"example":10},"digitTokenLength":{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}},"example":{"customInstructionsEnabled":true,"digitTokenEnabled":true,"digitTokenDurationMinutes":12,"digitTokenLength":9}}}},"responses":{"200":{"description":"Reference to the password org config.","content":{"application/json":{"schema":{"type":"object","properties":{"customInstructionsEnabled":{"type":"boolean","description":"Indicator whether custom password instructions feature is enabled. The default value is false.","default":false,"example":true},"digitTokenEnabled":{"type":"boolean","description":"Indicator whether \"digit token\" feature is enabled. The default value is false.","default":false,"example":true},"digitTokenDurationMinutes":{"type":"integer","format":"int32","description":"The duration of \"digit token\" in minutes. The default value is 5.","minimum":1,"maximum":60,"default":5,"example":10},"digitTokenLength":{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}},"example":{"customInstructionsEnabled":true,"digitTokenDurationMinutes":9,"digitTokenEnabled":true,"digitTokenLength":12}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/password-org-config","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"customInstructionsEnabled":true,"digitTokenEnabled":true,"digitTokenDurationMinutes":10,"digitTokenLength":9},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Create Password Org Config","description":{"content":"This API creates the password org config. Unspecified fields will use default value. Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'","type":"text/plain"},"url":{"path":["password-org-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Password Org Config' (create-password-org-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Password Org Config + + + +This API creates the password org config. Unspecified fields will use default value. Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +
    Request Body required
      = 1` and `<= 60`"} defaultValue={5}>= 6` and `<= 18`"} defaultValue={6}>
    + +Reference to the password org config. + +
    Schema
      = 1` and `<= 60`"} defaultValue={5}>= 6` and `<= 18`"} defaultValue={6}>
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-password-sync-group.api.mdx b/products/idn/api/v3/create-password-sync-group.api.mdx new file mode 100644 index 000000000..abf4766a9 --- /dev/null +++ b/products/idn/api/v3/create-password-sync-group.api.mdx @@ -0,0 +1,75 @@ +--- +id: create-password-sync-group +sidebar_label: Create Password Sync Group +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createPasswordSyncGroup","tags":["Password Sync Groups"],"description":"This API creates a password sync group based on the specifications provided. A token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:password-sync-group-management:write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the sync group","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"},"name":{"description":"Name of the sync group","type":"string","example":"Password Sync Group 1"},"passwordPolicyId":{"type":"string","description":"ID of the password policy","example":"2c91808d744ba0ce01746f93b6204501"},"sourceIds":{"type":"array","description":"List of password managed sources IDs","items":{"type":"string"},"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}},"example":{"name":"Password Sync Group 2","passwordPolicyId":"2c91808d744ba0ce01746f93b6204501","sourceIds":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}}},"responses":{"200":{"description":"Reference to the password sync group.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the sync group","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"},"name":{"description":"Name of the sync group","type":"string","example":"Password Sync Group 1"},"passwordPolicyId":{"type":"string","description":"ID of the password policy","example":"2c91808d744ba0ce01746f93b6204501"},"sourceIds":{"type":"array","description":"List of password managed sources IDs","items":{"type":"string"},"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}},"example":{"id":"6881f631-3bd5-4213-9c75-8e05cc3e35dd","name":"Password Sync Group 2","passwordPolicyId":"2c91808d744ba0ce01746f93b6204501","sourceIds":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/password-sync-groups","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"id":"6881f631-3bd5-4213-9c75-8e05cc3e35dd","name":"Password Sync Group 1","passwordPolicyId":"2c91808d744ba0ce01746f93b6204501","sourceIds":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Create Password Sync Group","description":{"content":"This API creates a password sync group based on the specifications provided. A token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["password-sync-groups"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Password Sync Group' (create-password-sync-group)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Password Sync Group + + + +This API creates a password sync group based on the specifications provided. A token with ORG_ADMIN authority is required to call this API. + +
    Request Body required
    + +Reference to the password sync group. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-personal-access-token.api.mdx b/products/idn/api/v3/create-personal-access-token.api.mdx new file mode 100644 index 000000000..9d7b3ef4b --- /dev/null +++ b/products/idn/api/v3/create-personal-access-token.api.mdx @@ -0,0 +1,83 @@ +--- +id: create-personal-access-token +sidebar_label: Create Personal Access Token +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createPersonalAccessToken","security":[{"oauth2":["sp:my-personal-access-tokens:manage","sp:all-personal-access-tokens:manage"]}],"tags":["Personal Access Tokens"],"description":"This creates a personal access token.","requestBody":{"description":"Name and scope of personal access token.","required":true,"content":{"application/json":{"schema":{"type":"object","description":"Object for specifying the name of a personal access token to create","properties":{"name":{"type":"string","description":"The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created.","example":"NodeJS Integration"},"scope":{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the personal access token. If no scope is specified, the token will be created with the default scope \"sp:scopes:all\". This means the personal access token will have all the rights of the owner who created it.","example":["demo:personal-access-token-scope:first","demo:personal-access-token-scope:second"]}},"required":["name"]}}}},"responses":{"200":{"description":"Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the personal access token (to be used as the username for Basic Auth).","example":"86f1dc6fe8f54414950454cbb11278fa"},"secret":{"type":"string","description":"The secret of the personal access token (to be used as the password for Basic Auth).","example":"1d1bef2b9f426383447f64f69349fc7cac176042578d205c256ba3f37c59adb9"},"scope":{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the personal access token.","example":["demo:personal-access-token-scope:first","demo:personal-access-token-scope:second"]},"name":{"type":"string","description":"The name of the personal access token. Cannot be the same as other personal access tokens owned by a user.","example":"NodeJS Integration"},"owner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Details about the owner of the personal access token."},"created":{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when this personal access token was created.","example":"2017-07-11T18:45:37.098Z"}},"required":["id","secret","scope","name","owner","created"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/personal-access-tokens","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"NodeJS Integration","scope":["demo:personal-access-token-scope:first","demo:personal-access-token-scope:second"]},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Create Personal Access Token","description":{"content":"This creates a personal access token.","type":"text/plain"},"url":{"path":["personal-access-tokens"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Personal Access Token' (create-personal-access-token)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Personal Access Token + + + +This creates a personal access token. + +
    Request Body required
    + +Name and scope of personal access token. + +
    + +Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed. + +
    Schema
      owner object
      + +Details about the owner of the personal access token. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-provisioning-policy.api.mdx b/products/idn/api/v3/create-provisioning-policy.api.mdx new file mode 100644 index 000000000..370a13cca --- /dev/null +++ b/products/idn/api/v3/create-provisioning-policy.api.mdx @@ -0,0 +1,90 @@ +--- +id: create-provisioning-policy +sidebar_label: Create Provisioning Policy +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createProvisioningPolicy","tags":["Sources"],"description":"This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types.\nTransforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.\nRefer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.\nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:provisioning-policy:manage"]}],"parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source id","example":"2c9180835d191a86015d28455b4a2329"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"the provisioning policy name","example":"example provisioning policy for inactive identities"},"description":{"type":"string","description":"the description of the provisioning policy","example":"this provisioning policy creates access based on an identity going inactive"},"usageType":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"userName"},"transform":{"type":"object","description":"The transform to apply to the field","example":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"default":{}},"attributes":{"type":"object","description":"Attributes required for the transform","example":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"}},"type":{"type":"string","description":"The type of the attribute.","example":"string"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","default":false,"example":false}}}}}},"examples":{"Create Account Provisioning Policy":{"value":{"name":"Account","description":"Account Provisioning Policy","usageType":"CREATE","fields":[{"name":"displayName","transform":{"type":"identityAttribute","attributes":{"name":"displayName"}},"attributes":{},"isRequired":false,"type":"string","isMultiValued":false},{"name":"distinguishedName","transform":{"type":"usernameGenerator","attributes":{"sourceCheck":true,"patterns":["CN=$fi $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com","CN=$fti $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com","CN=$fn $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com","CN=$fn$ln${uniqueCounter},OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"],"fn":{"type":"identityAttribute","attributes":{"name":"firstname"}},"ln":{"type":"identityAttribute","attributes":{"name":"lastname"}},"fi":{"type":"substring","attributes":{"input":{"type":"identityAttribute","attributes":{"name":"firstname"}},"begin":0,"end":1}},"fti":{"type":"substring","attributes":{"input":{"type":"identityAttribute","attributes":{"name":"firstname"}},"begin":0,"end":2}}}},"attributes":{"cloudMaxUniqueChecks":"5","cloudMaxSize":"100","cloudRequired":"true"},"isRequired":false,"type":"","isMultiValued":false},{"name":"description","transform":{"type":"static","attributes":{"value":""}},"attributes":{},"isRequired":false,"type":"string","isMultiValued":false}]}}}}}},"responses":{"201":{"description":"Created ProvisioningPolicyDto object","content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"the provisioning policy name","example":"example provisioning policy for inactive identities"},"description":{"type":"string","description":"the description of the provisioning policy","example":"this provisioning policy creates access based on an identity going inactive"},"usageType":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"userName"},"transform":{"type":"object","description":"The transform to apply to the field","example":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"default":{}},"attributes":{"type":"object","description":"Attributes required for the transform","example":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"}},"isRequired":{"type":"boolean","readOnly":true,"description":"Flag indicating whether or not the attribute is required.","default":false,"example":false},"type":{"type":"string","description":"The type of the attribute.","example":"string"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","default":false,"example":false}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sources/{sourceId}/provisioning-policies","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"example provisioning policy for inactive identities","description":"this provisioning policy creates access based on an identity going inactive","usageType":"CREATE","fields":[{"name":"userName","transform":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"attributes":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"},"type":"string","isMultiValued":false}]},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Create Provisioning Policy","description":{"content":"This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types.\nTransforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.\nRefer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":sourceId","provisioning-policies"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Provisioning Policy' (create-provisioning-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Provisioning Policy + + + +This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. +A token with ORG_ADMIN authority is required to call this API. + +
    Path Parameters
    Request Body required
      fields object[]
    + +Created ProvisioningPolicyDto object + +
    Schema
      fields object[]
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-role.api.mdx b/products/idn/api/v3/create-role.api.mdx new file mode 100644 index 000000000..13470e59b --- /dev/null +++ b/products/idn/api/v3/create-role.api.mdx @@ -0,0 +1,190 @@ +--- +id: create-role +sidebar_label: Create a Role +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createRole","tags":["Roles"],"description":"This API creates a Role.\nThere is a soft limit of 800 roles per org in IdentityNow. You will receive an error if you attempt to add more than 800 roles via the API or the UI. If you need to add roles above this limit, please create a support ticket.\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a ROLE_SUBADMIN may not create a Role including an Access Profile if that Access Profile is associated with a Source with which the ROLE_SUBADMIN is not themselves associated.\nThe maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"A Role","properties":{"id":{"type":"string","description":"The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.","example":"2c918086749d78830174a1a40e121518"},"name":{"type":"string","description":"The human-readable display name of the Role","maxLength":128,"example":"Role 2567"},"created":{"type":"string","description":"Date the Role was created","format":"date-time","example":"2021-03-01T22:32:58.104Z","readOnly":true},"modified":{"type":"string","description":"Date the Role was last modified.","format":"date-time","example":"2021-03-02T20:22:28.104Z","readOnly":true},"description":{"type":"string","nullable":true,"description":"A human-readable description of the Role","example":"Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor."},"owner":{"type":"object","nullable":true,"description":"The owner of this object.","properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"accessProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the Access Profile","example":"ff808081751e6e129f1518161919ecca"},"type":{"type":"string","description":"Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result.","enum":["ACCESS_PROFILE"],"example":"ACCESS_PROFILE"},"name":{"type":"string","description":"Human-readable display name of the Access Profile. This field is ignored on input.","example":"Access Profile 2567"}}},"nullable":true},"membership":{"nullable":true,"type":"object","description":"When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.","properties":{"type":{"type":"string","enum":["STANDARD","IDENTITY_LIST"],"description":"This enum characterizes the type of a Role's membership selector. Only the following two are fully supported:\n\nSTANDARD: Indicates that Role membership is defined in terms of a criteria expression\n\nIDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed","example":"IDENTITY_LIST"},"criteria":{"nullable":true,"type":"object","description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","nullable":true,"description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","nullable":true,"description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","nullable":true,"description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa."}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa."}}},"identities":{"type":"array","items":{"type":"object","description":"A reference to an Identity in an IDENTITY_LIST role membership criteria.","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY","nullable":true},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","nullable":true,"description":"Human-readable display name of the Identity.","example":"Thomas Edison"},"aliasName":{"type":"string","nullable":true,"description":"User name of the Identity","example":"t.edison"}}},"nullable":true,"description":"Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST."}}},"legacyMembershipInfo":{"type":"object","nullable":true,"description":"This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.","example":{"type":"IDENTITY_LIST"},"additionalProperties":true},"enabled":{"type":"boolean","description":"Whether the Role is enabled or not.","example":true,"default":false},"requestable":{"type":"boolean","description":"Whether the Role can be the target of access requests.","example":true,"default":false},"accessRequestConfig":{"nullable":true,"description":"Access request configuration for this object","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":true,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":true,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n\n**OWNER**: Owner of the associated Role\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"revocationRequestConfig":{"nullable":true,"default":null,"description":"Revocation request configuration for this object.","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":false,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":false,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the revocation request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"segments":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of IDs of segments, if any, to which this Role is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]}},"required":["name","owner"]}}}},"responses":{"201":{"description":"Role created","content":{"application/json":{"schema":{"type":"object","description":"A Role","properties":{"id":{"type":"string","description":"The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.","example":"2c918086749d78830174a1a40e121518"},"name":{"type":"string","description":"The human-readable display name of the Role","maxLength":128,"example":"Role 2567"},"created":{"type":"string","description":"Date the Role was created","format":"date-time","example":"2021-03-01T22:32:58.104Z","readOnly":true},"modified":{"type":"string","description":"Date the Role was last modified.","format":"date-time","example":"2021-03-02T20:22:28.104Z","readOnly":true},"description":{"type":"string","nullable":true,"description":"A human-readable description of the Role","example":"Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor."},"owner":{"type":"object","nullable":true,"description":"The owner of this object.","properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"accessProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the Access Profile","example":"ff808081751e6e129f1518161919ecca"},"type":{"type":"string","description":"Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result.","enum":["ACCESS_PROFILE"],"example":"ACCESS_PROFILE"},"name":{"type":"string","description":"Human-readable display name of the Access Profile. This field is ignored on input.","example":"Access Profile 2567"}}},"nullable":true},"membership":{"nullable":true,"type":"object","description":"When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.","properties":{"type":{"type":"string","enum":["STANDARD","IDENTITY_LIST"],"description":"This enum characterizes the type of a Role's membership selector. Only the following two are fully supported:\n\nSTANDARD: Indicates that Role membership is defined in terms of a criteria expression\n\nIDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed","example":"IDENTITY_LIST"},"criteria":{"nullable":true,"type":"object","description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","nullable":true,"description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","nullable":true,"description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","nullable":true,"description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa."}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa."}}},"identities":{"type":"array","items":{"type":"object","description":"A reference to an Identity in an IDENTITY_LIST role membership criteria.","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY","nullable":true},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","nullable":true,"description":"Human-readable display name of the Identity.","example":"Thomas Edison"},"aliasName":{"type":"string","nullable":true,"description":"User name of the Identity","example":"t.edison"}}},"nullable":true,"description":"Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST."}}},"legacyMembershipInfo":{"type":"object","nullable":true,"description":"This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.","example":{"type":"IDENTITY_LIST"},"additionalProperties":true},"enabled":{"type":"boolean","description":"Whether the Role is enabled or not.","example":true,"default":false},"requestable":{"type":"boolean","description":"Whether the Role can be the target of access requests.","example":true,"default":false},"accessRequestConfig":{"nullable":true,"description":"Access request configuration for this object","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":true,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":true,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n\n**OWNER**: Owner of the associated Role\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"revocationRequestConfig":{"nullable":true,"default":null,"description":"Revocation request configuration for this object.","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":false,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":false,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the revocation request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"segments":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of IDs of segments, if any, to which this Role is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]}},"required":["name","owner"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:role-unchecked:manage","idn:role-checked:manage"]}],"method":"post","path":"/roles","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"id":"2c918086749d78830174a1a40e121518","name":"Role 2567","description":"Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.","owner":{"type":"IDENTITY","id":"2c9180a46faadee4016fb4e018c20639","name":"support"},"accessProfiles":[{"id":"ff808081751e6e129f1518161919ecca","type":"ACCESS_PROFILE","name":"Access Profile 2567"}],"membership":{"type":"IDENTITY_LIST","criteria":{"operation":"EQUALS","key":{"type":"ACCOUNT","property":"attribute.email","sourceId":"2c9180867427f3a301745aec18211519"},"stringValue":"carlee.cert1c9f9b6fd@mailinator.com","children":[{"operation":"EQUALS","key":{"type":"ACCOUNT","property":"attribute.email","sourceId":"2c9180867427f3a301745aec18211519"},"stringValue":"carlee.cert1c9f9b6fd@mailinator.com","children":[{"operation":"EQUALS","key":{"type":"ACCOUNT","property":"attribute.email","sourceId":"2c9180867427f3a301745aec18211519"},"stringValue":"carlee.cert1c9f9b6fd@mailinator.com"}]}]},"identities":[{"type":"IDENTITY","id":"2c9180a46faadee4016fb4e018c20639","name":"Thomas Edison","aliasName":"t.edison"}]},"legacyMembershipInfo":{"type":"IDENTITY_LIST"},"enabled":true,"requestable":true,"accessRequestConfig":{"commentsRequired":true,"denialCommentsRequired":true,"approvalSchemes":[{"approverType":"GOVERNANCE_GROUP","approverId":"46c79819-a69f-49a2-becb-12c971ae66c6"}]},"revocationRequestConfig":{"commentsRequired":false,"denialCommentsRequired":false,"approvalSchemes":[{"approverType":"GOVERNANCE_GROUP","approverId":"46c79819-a69f-49a2-becb-12c971ae66c6"}]},"segments":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Create a Role","description":{"content":"This API creates a Role.\nThere is a soft limit of 800 roles per org in IdentityNow. You will receive an error if you attempt to add more than 800 roles via the API or the UI. If you need to add roles above this limit, please create a support ticket.\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a ROLE_SUBADMIN may not create a Role including an Access Profile if that Access Profile is associated with a Source with which the ROLE_SUBADMIN is not themselves associated.\nThe maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.","type":"text/plain"},"url":{"path":["roles"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a Role' (create-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create a Role + + + +This API creates a Role. +There is a soft limit of 800 roles per org in IdentityNow. You will receive an error if you attempt to add more than 800 roles via the API or the UI. If you need to add roles above this limit, please create a support ticket. +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a ROLE_SUBADMIN may not create a Role including an Access Profile if that Access Profile is associated with a Source with which the ROLE_SUBADMIN is not themselves associated. +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +
    Request Body required
      owner object required
      + +The owner of this object. + +
      accessProfiles object[]
      membership object
      + +When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities. + +
      criteria object
      + +Defines STANDARD type Role membership + +
      key object
      + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
      children object[]
      + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + +
      key object
      + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
      children object[]
      + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + +
      key object
      + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
      identities object[]
      + +Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. + +
      legacyMembershipInfo object
      + +This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. + +
      accessRequestConfig object
      + +Access request configuration for this object + +
      approvalSchemes object[]
      + +List describing the steps in approving the request + +
      revocationRequestConfig object
      + +Revocation request configuration for this object. + +
      approvalSchemes object[]
      + +List describing the steps in approving the revocation request + +
    + +Role created + +
    Schema
      owner object
      + +The owner of this object. + +
      accessProfiles object[]
      membership object
      + +When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities. + +
      criteria object
      + +Defines STANDARD type Role membership + +
      key object
      + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
      children object[]
      + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + +
      key object
      + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
      children object[]
      + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + +
      key object
      + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
      identities object[]
      + +Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. + +
      legacyMembershipInfo object
      + +This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. + +
      accessRequestConfig object
      + +Access request configuration for this object + +
      approvalSchemes object[]
      + +List describing the steps in approving the request + +
      revocationRequestConfig object
      + +Revocation request configuration for this object. + +
      approvalSchemes object[]
      + +List describing the steps in approving the revocation request + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-saved-search.api.mdx b/products/idn/api/v3/create-saved-search.api.mdx new file mode 100644 index 000000000..d13240d2c --- /dev/null +++ b/products/idn/api/v3/create-saved-search.api.mdx @@ -0,0 +1,111 @@ +--- +id: create-saved-search +sidebar_label: Create a saved search +hide_title: true +hide_table_of_contents: true +api: {"tags":["Saved Search"],"description":"Creates a new saved search.\n","operationId":"createSavedSearch","requestBody":{"description":"The saved search to persist.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"name":{"description":"The name of the saved search.\n","type":"string","example":"Disabled accounts"},"description":{"description":"The description of the saved search.\n","type":"string","nullable":true,"example":"Disabled accounts"}}},{"type":"object","properties":{"public":{"description":"Indicates if the saved search is public.\n","type":"boolean","default":false,"example":false},"created":{"description":"The date the saved search was initially created.\n","type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"},"modified":{"description":"The last date the saved search was modified.\n","type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"},"indices":{"description":"The names of the Elasticsearch indices in which to search.\n","type":"array","items":{"description":"Enum representing the currently supported indices.\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofiles","accountactivities","entitlements","events","identities","roles","*"],"example":"identities"},"example":["identities"]},"columns":{"description":"The columns to be returned (specifies the order in which they will be presented) for each document type.\n\nThe currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_.\n","type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"field":{"description":"The name of the field.\n","type":"string","example":"email"},"header":{"description":"The value of the header.\n","type":"string","example":"Work Email"}},"required":["field"]}},"example":{"identity":[{"field":"displayName","header":"Display Name"},{"field":"e-mail","header":"Work Email"}]}},"query":{"description":"The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL.\n","type":"string","example":"@accounts(disabled:true)"},"fields":{"description":"The fields to be searched against in a multi-field query.\n","type":"array","nullable":true,"items":{"type":"string"},"example":["disabled"]},"sort":{"description":"The fields to be used to sort the search results.\n","type":"array","items":{"type":"string"},"example":["displayName"]},"filters":{"nullable":true,"allOf":[{"type":"object","description":"The filters to be applied for each filtered field name.","example":{"attributes.cloudAuthoritativeSource":{"type":"EXISTS","exclude":true},"accessCount":{"type":"RANGE","range":{"lower":{"value":"3"}}},"created":{"type":"RANGE","range":{"lower":{"value":"2019-12-01","inclusive":true},"upper":{"value":"2020-01-01"}}},"source.name":{"type":"TERMS","terms":["HR Employees","Corporate Active Directory"],"exclude":true},"protected":{"type":"TERMS","terms":["true"]}}},{"type":"object","properties":{"type":{"description":"Enum representing the currently supported filter types.\nAdditional values may be added in the future without notice.","type":"string","enum":["EXISTS","RANGE","TERMS"],"example":"RANGE"},"range":{"type":"object","description":"The range of values to be filtered.","properties":{"lower":{"description":"The lower bound of the range.","type":"object","required":["value"],"properties":{"value":{"description":"The value of the range's endpoint.","type":"string","example":"1"},"inclusive":{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}},"upper":{"description":"The upper bound of the range.","type":"object","required":["value"],"properties":{"value":{"description":"The value of the range's endpoint.","type":"string","example":"1"},"inclusive":{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}}}},"terms":{"description":"The terms to be filtered.","type":"array","items":{"type":"string","example":"account_count"}},"exclude":{"description":"Indicates if the filter excludes results.","type":"boolean","default":false,"example":false}}}]}},"required":["indices","query"]}]}}},"required":true},"responses":{"201":{"description":"The persisted saved search.","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"id":{"description":"The saved search ID.\n","type":"string","example":"0de46054-fe90-434a-b84e-c6b3359d0c64"},"owner":{"description":"The owner of the saved search.\n","type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"description":"The id of the object.\n","type":"string","example":"2c91808568c529c60168cca6f90c1313"}},"required":["type","id"]}}},{"type":"object","properties":{"name":{"description":"The name of the saved search.\n","type":"string","example":"Disabled accounts"},"description":{"description":"The description of the saved search.\n","type":"string","nullable":true,"example":"Disabled accounts"}}},{"type":"object","properties":{"public":{"description":"Indicates if the saved search is public.\n","type":"boolean","default":false,"example":false},"created":{"description":"The date the saved search was initially created.\n","type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"},"modified":{"description":"The last date the saved search was modified.\n","type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"},"indices":{"description":"The names of the Elasticsearch indices in which to search.\n","type":"array","items":{"description":"Enum representing the currently supported indices.\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofiles","accountactivities","entitlements","events","identities","roles","*"],"example":"identities"},"example":["identities"]},"columns":{"description":"The columns to be returned (specifies the order in which they will be presented) for each document type.\n\nThe currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_.\n","type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"field":{"description":"The name of the field.\n","type":"string","example":"email"},"header":{"description":"The value of the header.\n","type":"string","example":"Work Email"}},"required":["field"]}},"example":{"identity":[{"field":"displayName","header":"Display Name"},{"field":"e-mail","header":"Work Email"}]}},"query":{"description":"The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL.\n","type":"string","example":"@accounts(disabled:true)"},"fields":{"description":"The fields to be searched against in a multi-field query.\n","type":"array","nullable":true,"items":{"type":"string"},"example":["disabled"]},"sort":{"description":"The fields to be used to sort the search results.\n","type":"array","items":{"type":"string"},"example":["displayName"]},"filters":{"nullable":true,"allOf":[{"type":"object","description":"The filters to be applied for each filtered field name.","example":{"attributes.cloudAuthoritativeSource":{"type":"EXISTS","exclude":true},"accessCount":{"type":"RANGE","range":{"lower":{"value":"3"}}},"created":{"type":"RANGE","range":{"lower":{"value":"2019-12-01","inclusive":true},"upper":{"value":"2020-01-01"}}},"source.name":{"type":"TERMS","terms":["HR Employees","Corporate Active Directory"],"exclude":true},"protected":{"type":"TERMS","terms":["true"]}}},{"type":"object","properties":{"type":{"description":"Enum representing the currently supported filter types.\nAdditional values may be added in the future without notice.","type":"string","enum":["EXISTS","RANGE","TERMS"],"example":"RANGE"},"range":{"type":"object","description":"The range of values to be filtered.","properties":{"lower":{"description":"The lower bound of the range.","type":"object","required":["value"],"properties":{"value":{"description":"The value of the range's endpoint.","type":"string","example":"1"},"inclusive":{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}},"upper":{"description":"The upper bound of the range.","type":"object","required":["value"],"properties":{"value":{"description":"The value of the range's endpoint.","type":"string","example":"1"},"inclusive":{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}}}},"terms":{"description":"The terms to be filtered.","type":"array","items":{"type":"string","example":"account_count"}},"exclude":{"description":"Indicates if the filter excludes results.","type":"boolean","default":false,"example":false}}}]}},"required":["indices","query"]}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}}},"method":"post","path":"/saved-searches","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"Disabled accounts","description":"Disabled accounts","public":false,"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"}]},"query":"@accounts(disabled:true)","fields":["disabled"],"sort":["displayName"],"filters":{"attributes.cloudAuthoritativeSource":{"type":"EXISTS","exclude":true},"accessCount":{"type":"RANGE","range":{"lower":{"value":"3"}}},"created":{"type":"RANGE","range":{"lower":{"value":"2019-12-01","inclusive":true},"upper":{"value":"2020-01-01"}}},"source.name":{"type":"TERMS","terms":["HR Employees","Corporate Active Directory"],"exclude":true},"protected":{"type":"TERMS","terms":["true"]}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Create a saved search","description":{"content":"Creates a new saved search.\n","type":"text/plain"},"url":{"path":["saved-searches"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a saved search' (create-saved-search)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create a saved search + + + +Creates a new saved search. + + +
    Request Body required
    + +The saved search to persist. + +
      columns object
      + +The columns to be returned (specifies the order in which they will be presented) for each document type. + +The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. + + +
      items object
      filters object
      + +The filters to be applied for each filtered field name. + +
      range object
      + +The range of values to be filtered. + +
      lower object
      + +The lower bound of the range. + +
      upper object
      + +The upper bound of the range. + +
    + +The persisted saved search. + +
    Schema
      owner object
      + +The owner of the saved search. + + +
      columns object
      + +The columns to be returned (specifies the order in which they will be presented) for each document type. + +The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. + + +
      items object
      filters object
      + +The filters to be applied for each filtered field name. + +
      range object
      + +The range of values to be filtered. + +
      lower object
      + +The lower bound of the range. + +
      upper object
      + +The upper bound of the range. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-scheduled-search.api.mdx b/products/idn/api/v3/create-scheduled-search.api.mdx new file mode 100644 index 000000000..9f94d275d --- /dev/null +++ b/products/idn/api/v3/create-scheduled-search.api.mdx @@ -0,0 +1,138 @@ +--- +id: create-scheduled-search +sidebar_label: Create a new scheduled search +hide_title: true +hide_table_of_contents: true +api: {"tags":["Scheduled Search"],"description":"Creates a new scheduled search.\n","operationId":"createScheduledSearch","requestBody":{"description":"The scheduled search to persist.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"name":{"description":"The name of the scheduled search.\n","type":"string","example":"Daily disabled accounts","nullable":true},"description":{"description":"The description of the scheduled search.\n","type":"string","nullable":true,"example":"Daily disabled accounts"}}},{"type":"object","properties":{"savedSearchId":{"description":"The ID of the saved search that will be executed.","type":"string","example":"554f1511-f0a1-4744-ab14-599514d3e57c"},"created":{"allOf":[{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}],"description":"The date the scheduled search was initially created.","readOnly":true},"modified":{"allOf":[{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}],"description":"The last date the scheduled search was modified.","readOnly":true},"schedule":{"type":"object","description":"The schedule information.","properties":{"type":{"description":"Enum representing the currently supported schedule types.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["DAILY","WEEKLY","MONTHLY","CALENDAR"],"example":"WEEKLY"},"days":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The days to execute the search.\n\nIf `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`.\n\nIf `type` is `MONTHLY`, the values will be a number in double quotes, like `\"1\"`, `\"10\"`, or `\"28\"`. Optionally, the value `\"L\"` can be used to refer to the last day of the month.\n","example":{"type":"LIST","values":["MON","WED","FRI"]},"nullable":true}]},"hours":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The hours selected.","example":{"type":"RANGE","values":["9","18"],"interval":3}}]},"expiration":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"timeZoneId":{"description":"The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org's default timezone is used.","nullable":true,"type":"string","example":"GMT-06:00"}},"required":["type","hours"]},"recipients":{"description":"A list of identities that should receive the scheduled search report via email.","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"The ID of the referenced object","example":"2c9180867624cbd7017642d8c8c81f67"}},"required":["type","id"]}},"enabled":{"description":"Indicates if the scheduled search is enabled.\n","type":"boolean","default":false,"example":false},"emailEmptyResults":{"description":"Indicates if email generation should not be suppressed if search returns no results.\n","type":"boolean","default":false,"example":false},"displayQueryDetails":{"description":"Indicates if the generated email should include the query and search results preview (which could include PII).\n","type":"boolean","default":false,"example":false}},"required":["savedSearchId","schedule","recipients"]}]},"examples":{"Daily Search":{"description":"A search that executes each day at a 9 AM","value":{"savedSearchId":"9c620e13-cd33-4804-a13d-403bd7bcdbad","schedule":{"type":"DAILY","hours":{"type":"LIST","values":["9"]}},"recipients":[{"type":"IDENTITY","id":"2c9180867624cbd7017642d8c8c81f67"}]}},"Weekly Search":{"description":"A search that executes each week on select days and times","value":{"savedSearchId":"9c620e13-cd33-4804-a13d-403bd7bcdbad","schedule":{"type":"WEEKLY","days":{"type":"LIST","values":["MON","TUE","WED","THU","FRI","SAT","SUN"]},"hours":{"type":"LIST","values":["9"]}},"recipients":[{"type":"IDENTITY","id":"2c9180867624cbd7017642d8c8c81f67"}]}},"Monthly Search":{"description":"A search that executes each month on select days and times","value":{"savedSearchId":"9c620e13-cd33-4804-a13d-403bd7bcdbad","schedule":{"type":"MONTHLY","days":{"type":"LIST","values":["1","7","14","L"]},"hours":{"type":"LIST","values":["9"]}},"recipients":[{"type":"IDENTITY","id":"2c9180867624cbd7017642d8c8c81f67"}]}},"Calendar Search":{"description":"A search that executes on specific calendar days","value":{"savedSearchId":"9c620e13-cd33-4804-a13d-403bd7bcdbad","schedule":{"type":"CALENDAR","days":{"type":"LIST","values":["2023-01-22","2023-02-22"]},"hours":{"type":"LIST","values":["9"]}},"recipients":[{"type":"IDENTITY","id":"2c9180867624cbd7017642d8c8c81f67"}]}}}}},"required":true},"responses":{"201":{"description":"The persisted scheduled search.","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"id":{"description":"The scheduled search ID.","type":"string","example":"0de46054-fe90-434a-b84e-c6b3359d0c64","readOnly":true},"owner":{"description":"The owner of the scheduled search","readOnly":true,"type":"object","properties":{"type":{"type":"string","description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"The ID of the referenced object","example":"2c9180867624cbd7017642d8c8c81f67"}},"required":["type","id"]},"ownerId":{"description":"The ID of the scheduled search owner.\n\nPlease use the `id` in the `owner` object instead.\n","type":"string","example":"2c9180867624cbd7017642d8c8c81f67","readOnly":true,"deprecated":true}}},{"type":"object","properties":{"name":{"description":"The name of the scheduled search.\n","type":"string","example":"Daily disabled accounts","nullable":true},"description":{"description":"The description of the scheduled search.\n","type":"string","nullable":true,"example":"Daily disabled accounts"}}},{"type":"object","properties":{"savedSearchId":{"description":"The ID of the saved search that will be executed.","type":"string","example":"554f1511-f0a1-4744-ab14-599514d3e57c"},"created":{"allOf":[{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}],"description":"The date the scheduled search was initially created.","readOnly":true},"modified":{"allOf":[{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}],"description":"The last date the scheduled search was modified.","readOnly":true},"schedule":{"type":"object","description":"The schedule information.","properties":{"type":{"description":"Enum representing the currently supported schedule types.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["DAILY","WEEKLY","MONTHLY","CALENDAR"],"example":"WEEKLY"},"days":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The days to execute the search.\n\nIf `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`.\n\nIf `type` is `MONTHLY`, the values will be a number in double quotes, like `\"1\"`, `\"10\"`, or `\"28\"`. Optionally, the value `\"L\"` can be used to refer to the last day of the month.\n","example":{"type":"LIST","values":["MON","WED","FRI"]},"nullable":true}]},"hours":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The hours selected.","example":{"type":"RANGE","values":["9","18"],"interval":3}}]},"expiration":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"timeZoneId":{"description":"The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org's default timezone is used.","nullable":true,"type":"string","example":"GMT-06:00"}},"required":["type","hours"]},"recipients":{"description":"A list of identities that should receive the scheduled search report via email.","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"The ID of the referenced object","example":"2c9180867624cbd7017642d8c8c81f67"}},"required":["type","id"]}},"enabled":{"description":"Indicates if the scheduled search is enabled.\n","type":"boolean","default":false,"example":false},"emailEmptyResults":{"description":"Indicates if email generation should not be suppressed if search returns no results.\n","type":"boolean","default":false,"example":false},"displayQueryDetails":{"description":"Indicates if the generated email should include the query and search results preview (which could include PII).\n","type":"boolean","default":false,"example":false}},"required":["savedSearchId","schedule","recipients"]}],"required":["id","owner","ownerId"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/scheduled-searches","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"Daily disabled accounts","description":"Daily disabled accounts","savedSearchId":"554f1511-f0a1-4744-ab14-599514d3e57c","schedule":{"type":"WEEKLY","days":{"type":"LIST","values":["MON","WED","FRI"]},"hours":{"type":"RANGE","values":["9","18"],"interval":3},"expiration":"2018-06-25T20:22:28.104Z","timeZoneId":"GMT-06:00"},"recipients":[{"type":"IDENTITY","id":"2c9180867624cbd7017642d8c8c81f67"}],"enabled":false,"emailEmptyResults":false,"displayQueryDetails":false},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Create a new scheduled search","description":{"content":"Creates a new scheduled search.\n","type":"text/plain"},"url":{"path":["scheduled-searches"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a new scheduled search' (create-scheduled-search)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create a new scheduled search + + + +Creates a new scheduled search. + + +
    Request Body required
    + +The scheduled search to persist. + +
      schedule object required
      + +The schedule information. + +
      days object
      + +The days to execute the search. + +If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. + +If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. + + +
      hours object required
      + +The hours selected. + +
      recipients object[] required
      + +A list of identities that should receive the scheduled search report via email. + +
    + +The persisted scheduled search. + +
    Schema
      owner object
      + +The owner of the scheduled search + +
      schedule object
      + +The schedule information. + +
      days object
      + +The days to execute the search. + +If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. + +If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. + + +
      hours object
      + +The hours selected. + +
      recipients object[]
      + +A list of identities that should receive the scheduled search report via email. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-segment.api.mdx b/products/idn/api/v3/create-segment.api.mdx new file mode 100644 index 000000000..3c4d49b73 --- /dev/null +++ b/products/idn/api/v3/create-segment.api.mdx @@ -0,0 +1,95 @@ +--- +id: create-segment +sidebar_label: Create Segment +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createSegment","security":[{"oauth2":["idn:segment:manage"]}],"tags":["Segments"],"description":"This API creates a segment.\n\nNote that segment definitions may take time to propagate to all identities.\n\nA token with ORG_ADMIN or API authority is required to call this API.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Segment.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"name":{"type":"string","description":"Segment Business Name","example":"segment-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this Segment is created","example":"2020-01-01T00:00:00.000000Z"},"modified":{"type":"string","format":"date-time","description":"The time when this Segment is modified","example":"2020-01-01T00:00:00.000000Z"},"description":{"type":"string","description":"Optional description of the Segment","example":"This segment represents xyz"},"owner":{"type":"object","nullable":true,"description":"The owner of this object.","properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"visibilityCriteria":{"type":"object","properties":{"expression":{"type":"object","properties":{"operator":{"type":"string","description":"Operator for the expression","enum":["AND","EQUALS"],"example":"EQUALS"},"attribute":{"type":"string","description":"Name for the attribute","example":"location"},"value":{"type":"object","properties":{"type":{"type":"string","description":"The type of attribute value","example":"STRING"},"value":{"type":"string","description":"The attribute value","example":"Austin"}}},"children":{"type":"array","nullable":true,"description":"List of expressions","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of attribute value","example":"STRING"},"value":{"type":"string","description":"The attribute value","example":"Austin"}}},"example":[]}}}}},"active":{"type":"boolean","description":"Whether the Segment is currently active. Inactive segments have no effect.","default":false,"example":true}}}}}},"responses":{"201":{"description":"Segment created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Segment.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"name":{"type":"string","description":"Segment Business Name","example":"segment-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this Segment is created","example":"2020-01-01T00:00:00.000000Z"},"modified":{"type":"string","format":"date-time","description":"The time when this Segment is modified","example":"2020-01-01T00:00:00.000000Z"},"description":{"type":"string","description":"Optional description of the Segment","example":"This segment represents xyz"},"owner":{"type":"object","nullable":true,"description":"The owner of this object.","properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"visibilityCriteria":{"type":"object","properties":{"expression":{"type":"object","properties":{"operator":{"type":"string","description":"Operator for the expression","enum":["AND","EQUALS"],"example":"EQUALS"},"attribute":{"type":"string","description":"Name for the attribute","example":"location"},"value":{"type":"object","properties":{"type":{"type":"string","description":"The type of attribute value","example":"STRING"},"value":{"type":"string","description":"The attribute value","example":"Austin"}}},"children":{"type":"array","nullable":true,"description":"List of expressions","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of attribute value","example":"STRING"},"value":{"type":"string","description":"The attribute value","example":"Austin"}}},"example":[]}}}}},"active":{"type":"boolean","description":"Whether the Segment is currently active. Inactive segments have no effect.","default":false,"example":true}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/segments","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"segment-xyz","created":"2020-01-01T00:00:00.000000Z","modified":"2020-01-01T00:00:00.000000Z","description":"This segment represents xyz","owner":{"type":"IDENTITY","id":"2c9180a46faadee4016fb4e018c20639","name":"support"},"visibilityCriteria":{"expression":{"operator":"EQUALS","attribute":"location","value":{"type":"STRING","value":"Austin"},"children":[]}},"active":true},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Create Segment","description":{"content":"This API creates a segment.\n\nNote that segment definitions may take time to propagate to all identities.\n\nA token with ORG_ADMIN or API authority is required to call this API.","type":"text/plain"},"url":{"path":["segments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Segment' (create-segment)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Segment + + + +This API creates a segment. + +Note that segment definitions may take time to propagate to all identities. + +A token with ORG_ADMIN or API authority is required to call this API. + +
    Request Body required
      owner object
      + +The owner of this object. + +
      visibilityCriteria object
      expression object
      value object
      children object[]
      + +List of expressions + +
    + +Segment created + +
    Schema
      owner object
      + +The owner of this object. + +
      visibilityCriteria object
      expression object
      value object
      children object[]
      + +List of expressions + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-service-desk-integration.api.mdx b/products/idn/api/v3/create-service-desk-integration.api.mdx new file mode 100644 index 000000000..ba3b7e803 --- /dev/null +++ b/products/idn/api/v3/create-service-desk-integration.api.mdx @@ -0,0 +1,147 @@ +--- +id: create-service-desk-integration +sidebar_label: Create new Service Desk integration +hide_title: true +hide_table_of_contents: true +api: {"tags":["Service Desk Integration"],"description":"Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","operationId":"createServiceDeskIntegration","requestBody":{"description":"The specifics of a new integration to create","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true},"modified":{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}},{"type":"object","description":"Specification of a Service Desk integration","required":["description","type","attributes"],"properties":{"description":{"description":"Description of the Service Desk integration","type":"string","example":"A very nice Service Desk integration"},"type":{"description":"Service Desk integration types\n\n- ServiceNowSDIM\n- ServiceNow\n","type":"string","default":"ServiceNowSDIM","example":"ServiceNowSDIM"},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the identity that is the owner of this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the identity","example":"MyName"}}},"clusterRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the source cluster for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"cluster":{"description":"ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)","type":"string","example":"xyzzy999","deprecated":true},"managedSources":{"description":"Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)","type":"array","items":{"type":"string"},"deprecated":true,"example":["2c9180835d191a86015d28455b4a2329","2c5680835d191a85765d28455b4a9823"]},"provisioningConfig":{"description":"The 'provisioningConfig' property specifies the configuration used to provision integrations.","type":"object","properties":{"universalManager":{"description":"Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.","type":"boolean","readOnly":true,"example":true},"managedResourceRefs":{"description":"References to sources for the Service Desk integration template. May only be specified if universalManager is false.","type":"array","items":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"properties":{"type":{"description":"The type of object being referenced","enum":["SOURCE"],"example":"SOURCE"},"id":{"description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the source","example":"My Source"}}},"example":[{"type":"SOURCE","id":"2c9180855d191c59015d291ceb051111","name":"My Source 1"},{"type":"SOURCE","id":"2c9180855d191c59015d291ceb052222","name":"My Source 2"}]},"planInitializerScript":{"description":"This is a reference to a plan initializer script.","type":"object","properties":{"source":{"description":"This is a Rule that allows provisioning instruction changes.","type":"string","example":"\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n"}}},"noProvisioningRequests":{"description":"Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.","type":"boolean","example":true},"provisioningRequestExpiration":{"description":"When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.","type":"integer","format":"int32","example":7}}},"attributes":{"description":"Attributes of the Service Desk integration. Validation constraints enforced by the implementation.","type":"object","additionalProperties":true,"example":{"property":"value","key":"value"}},"beforeProvisioningRule":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to beforeProvisioningRule for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["RULE"],"example":"RULE"},"id":{"description":"ID of the rule","example":"2c91808568c529c60168cca6f90c1333"},"name":{"description":"Human-readable display name of the rule","example":"Example Rule"}}}}}]}}},"required":true},"responses":{"200":{"description":"details of the created integration","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true},"modified":{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}},{"type":"object","description":"Specification of a Service Desk integration","required":["description","type","attributes"],"properties":{"description":{"description":"Description of the Service Desk integration","type":"string","example":"A very nice Service Desk integration"},"type":{"description":"Service Desk integration types\n\n- ServiceNowSDIM\n- ServiceNow\n","type":"string","default":"ServiceNowSDIM","example":"ServiceNowSDIM"},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the identity that is the owner of this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the identity","example":"MyName"}}},"clusterRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the source cluster for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"cluster":{"description":"ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)","type":"string","example":"xyzzy999","deprecated":true},"managedSources":{"description":"Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)","type":"array","items":{"type":"string"},"deprecated":true,"example":["2c9180835d191a86015d28455b4a2329","2c5680835d191a85765d28455b4a9823"]},"provisioningConfig":{"description":"The 'provisioningConfig' property specifies the configuration used to provision integrations.","type":"object","properties":{"universalManager":{"description":"Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.","type":"boolean","readOnly":true,"example":true},"managedResourceRefs":{"description":"References to sources for the Service Desk integration template. May only be specified if universalManager is false.","type":"array","items":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"properties":{"type":{"description":"The type of object being referenced","enum":["SOURCE"],"example":"SOURCE"},"id":{"description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the source","example":"My Source"}}},"example":[{"type":"SOURCE","id":"2c9180855d191c59015d291ceb051111","name":"My Source 1"},{"type":"SOURCE","id":"2c9180855d191c59015d291ceb052222","name":"My Source 2"}]},"planInitializerScript":{"description":"This is a reference to a plan initializer script.","type":"object","properties":{"source":{"description":"This is a Rule that allows provisioning instruction changes.","type":"string","example":"\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n"}}},"noProvisioningRequests":{"description":"Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.","type":"boolean","example":true},"provisioningRequestExpiration":{"description":"When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.","type":"integer","format":"int32","example":7}}},"attributes":{"description":"Attributes of the Service Desk integration. Validation constraints enforced by the implementation.","type":"object","additionalProperties":true,"example":{"property":"value","key":"value"}},"beforeProvisioningRule":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to beforeProvisioningRule for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["RULE"],"example":"RULE"},"id":{"description":"ID of the rule","example":"2c91808568c529c60168cca6f90c1333"},"name":{"description":"Human-readable display name of the rule","example":"Example Rule"}}}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:service-desk-admin:manage","idn:service-desk-integration:manage"]}],"method":"post","path":"/service-desk-integrations","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"aName","description":"A very nice Service Desk integration","type":"ServiceNowSDIM","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":true},"clusterRef":{"type":true,"id":true,"name":true},"provisioningConfig":{"managedResourceRefs":[{"type":"SOURCE","id":"2c9180855d191c59015d291ceb051111","name":"My Source 1"},{"type":"SOURCE","id":"2c9180855d191c59015d291ceb052222","name":"My Source 2"}],"planInitializerScript":{"source":"\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n"},"noProvisioningRequests":true,"provisioningRequestExpiration":7},"attributes":{"property":"value","key":"value"},"beforeProvisioningRule":{"type":true,"id":true,"name":true}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Create new Service Desk integration","description":{"content":"Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","type":"text/plain"},"url":{"path":["service-desk-integrations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create new Service Desk integration' (create-service-desk-integration)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create new Service Desk integration + + + +Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +
    Request Body required
    + +The specifics of a new integration to create + +
      ownerRef object
      + +Reference to the identity that is the owner of this Service Desk integration + +
      clusterRef object
      + +Reference to the source cluster for this Service Desk integration + +
      provisioningConfig object
      + +The 'provisioningConfig' property specifies the configuration used to provision integrations. + +
      managedResourceRefs object[]
      + +References to sources for the Service Desk integration template. May only be specified if universalManager is false. + +
      planInitializerScript object
      + +This is a reference to a plan initializer script. + +
      attributes object required
      + +Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + +
      beforeProvisioningRule object
      + +Reference to beforeProvisioningRule for this Service Desk integration + +
    + +details of the created integration + +
    Schema
      ownerRef object
      + +Reference to the identity that is the owner of this Service Desk integration + +
      clusterRef object
      + +Reference to the source cluster for this Service Desk integration + +
      provisioningConfig object
      + +The 'provisioningConfig' property specifies the configuration used to provision integrations. + +
      managedResourceRefs object[]
      + +References to sources for the Service Desk integration template. May only be specified if universalManager is false. + +
      planInitializerScript object
      + +This is a reference to a plan initializer script. + +
      attributes object
      + +Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + +
      beforeProvisioningRule object
      + +Reference to beforeProvisioningRule for this Service Desk integration + +
    \\\\r\\\\n\\\\r\\\\n\\\\r\\\\n Before Provisioning Rule which changes disables and enables to a modify.\\\\r\\\\n \\n\"\n },\n \"noProvisioningRequests\": true,\n \"provisioningRequestExpiration\": 7\n },\n \"attributes\": {\n \"property\": \"value\",\n \"key\": \"value\"\n },\n \"beforeProvisioningRule\": {\n \"type\": true,\n \"id\": true,\n \"name\": true\n }\n}"} language={"json"}>
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-sod-policy.api.mdx b/products/idn/api/v3/create-sod-policy.api.mdx new file mode 100644 index 000000000..22802d26b --- /dev/null +++ b/products/idn/api/v3/create-sod-policy.api.mdx @@ -0,0 +1,108 @@ +--- +id: create-sod-policy +sidebar_label: Create SOD policy +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:sod-policy:write"]}],"operationId":"createSodPolicy","tags":["SOD Policy"],"description":"This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy.\nRequires role of ORG_ADMIN.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Policy id","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"name":{"type":"string","description":"Policy Business Name","example":"policy-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this SOD policy is created.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"modified":{"type":"string","format":"date-time","description":"The time when this SOD policy is modified.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"description":{"type":"string","description":"Optional description of the SOD policy","example":"This policy ensures compliance of xyz","nullable":true},"ownerRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"externalPolicyReference":{"type":"string","description":"Optional External Policy Reference","example":"XYZ policy","nullable":true},"policyQuery":{"type":"string","description":"Search query of the SOD policy","example":"@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)"},"compensatingControls":{"type":"string","description":"Optional compensating controls(Mitigating Controls)","example":"Have a manager review the transaction decisions for their \"out of compliance\" employee","nullable":true},"correctionAdvice":{"type":"string","description":"Optional correction advice","example":"Based on the role of the employee, managers should remove access that is not required for their job function.","nullable":true},"state":{"type":"string","description":"whether the policy is enforced or not","enum":["ENFORCED","NOT_ENFORCED"],"example":"ENFORCED"},"tags":{"type":"array","description":"tags for this policy object","example":["TAG1","TAG2"],"items":{"type":"string"}},"creatorId":{"type":"string","description":"Policy's creator ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"modifierId":{"type":"string","description":"Policy's modifier ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","nullable":true,"readOnly":true},"violationOwnerAssignmentConfig":{"nullable":true,"type":"object","properties":{"assignmentRule":{"type":"string","enum":["MANAGER","STATIC",null],"description":"Details about the violations owner.\nMANAGER - identity's manager\nSTATIC - Governance Group or Identity","example":"MANAGER","nullable":true},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"nullable":true}]}}},"scheduled":{"type":"boolean","description":"defines whether a policy has been scheduled or not","example":true,"default":false},"type":{"type":"string","description":"whether a policy is query based or conflicting access based","default":"GENERAL","enum":["GENERAL","CONFLICTING_ACCESS_BASED"],"example":"GENERAL"},"conflictingAccessCriteria":{"allOf":[{"type":"object","properties":{"leftCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","minItems":1,"maxItems":50,"items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"Type of the propery to which this reference applies to","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}},"rightCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","minItems":1,"maxItems":50,"items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"Type of the propery to which this reference applies to","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}}}},{"nullable":true}]}}},"examples":{"Conflicting Access Based Policy":{"value":{"name":"Conflicting-Policy-Name","description":"This policy ensures compliance of xyz","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Owner Name"},"externalPolicyReference":"XYZ policy","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":["string"],"creatorId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","modifierId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","violationOwnerAssignmentConfig":{"assignmentRule":"MANAGER","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Violation Owner Name"}},"scheduled":true,"type":"CONFLICTING_ACCESS_BASED","conflictingAccessCriteria":{"leftCriteria":{"name":"money-in","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67"}]},"rightCriteria":{"name":"money-out","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a68"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a69"}]}}}},"General Policy":{"value":{"description":"Description","ownerRef":{"type":"IDENTITY","id":"2c918087682f9a86016839c05e8f1aff","name":"Owner Name"},"externalPolicyReference":"New policy","policyQuery":"policy query implementation","compensatingControls":"Compensating controls","correctionAdvice":"Correction advice","tags":[],"state":"ENFORCED","scheduled":false,"creatorId":"2c918087682f9a86016839c05e8f1aff","modifierId":null,"violationOwnerAssignmentConfig":null,"name":"General-Policy-Name"}}}}}},"responses":{"201":{"description":"SOD policy created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Policy id","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"name":{"type":"string","description":"Policy Business Name","example":"policy-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this SOD policy is created.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"modified":{"type":"string","format":"date-time","description":"The time when this SOD policy is modified.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"description":{"type":"string","description":"Optional description of the SOD policy","example":"This policy ensures compliance of xyz","nullable":true},"ownerRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"externalPolicyReference":{"type":"string","description":"Optional External Policy Reference","example":"XYZ policy","nullable":true},"policyQuery":{"type":"string","description":"Search query of the SOD policy","example":"@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)"},"compensatingControls":{"type":"string","description":"Optional compensating controls(Mitigating Controls)","example":"Have a manager review the transaction decisions for their \"out of compliance\" employee","nullable":true},"correctionAdvice":{"type":"string","description":"Optional correction advice","example":"Based on the role of the employee, managers should remove access that is not required for their job function.","nullable":true},"state":{"type":"string","description":"whether the policy is enforced or not","enum":["ENFORCED","NOT_ENFORCED"],"example":"ENFORCED"},"tags":{"type":"array","description":"tags for this policy object","example":["TAG1","TAG2"],"items":{"type":"string"}},"creatorId":{"type":"string","description":"Policy's creator ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"modifierId":{"type":"string","description":"Policy's modifier ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","nullable":true,"readOnly":true},"violationOwnerAssignmentConfig":{"nullable":true,"type":"object","properties":{"assignmentRule":{"type":"string","enum":["MANAGER","STATIC",null],"description":"Details about the violations owner.\nMANAGER - identity's manager\nSTATIC - Governance Group or Identity","example":"MANAGER","nullable":true},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"nullable":true}]}}},"scheduled":{"type":"boolean","description":"defines whether a policy has been scheduled or not","example":true,"default":false},"type":{"type":"string","description":"whether a policy is query based or conflicting access based","default":"GENERAL","enum":["GENERAL","CONFLICTING_ACCESS_BASED"],"example":"GENERAL"},"conflictingAccessCriteria":{"allOf":[{"type":"object","properties":{"leftCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","minItems":1,"maxItems":50,"items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"Type of the propery to which this reference applies to","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}},"rightCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","minItems":1,"maxItems":50,"items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"Type of the propery to which this reference applies to","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}}}},{"nullable":true}]}}},"examples":{"Conflicting Access Based Policy":{"value":{"id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"Conflicting-Policy-Name","created":"2020-01-01T00:00:00.000000Z","modified":"2020-01-01T00:00:00.000000Z","description":"This policy ensures compliance of xyz","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Owner Name"},"externalPolicyReference":"XYZ policy","policyQuery":"@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)","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":["string"],"creatorId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","modifierId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","violationOwnerAssignmentConfig":{"assignmentRule":"MANAGER","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Violation Owner Name"}},"scheduled":true,"type":"CONFLICTING_ACCESS_BASED","conflictingAccessCriteria":{"leftCriteria":{"name":"money-in","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67"}]},"rightCriteria":{"name":"money-out","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a68"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a69"}]}}}},"General Policy":{"value":{"description":"Description","ownerRef":{"type":"IDENTITY","id":"2c918087682f9a86016839c05e8f1aff","name":"Owner Name"},"externalPolicyReference":"New policy","policyQuery":"policy query implementation","compensatingControls":"Compensating controls","correctionAdvice":"Correction advice","tags":[],"state":"ENFORCED","scheduled":false,"creatorId":"2c918087682f9a86016839c05e8f1aff","modifierId":null,"violationOwnerAssignmentConfig":null,"type":"GENERAL","conflictingAccessCriteria":null,"id":"52c11db4-733e-4c31-949a-766c95ec95f1","name":"General-Policy-Name","created":"2020-05-12T19:47:38Z","modified":"2020-05-12T19:47:38Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sod-policies","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"policy-xyz","description":"This policy ensures compliance of xyz","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"},"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","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"],"violationOwnerAssignmentConfig":{"assignmentRule":"MANAGER","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"}},"scheduled":true,"type":"GENERAL","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"}]}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Create SOD policy","description":{"content":"This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy.\nRequires role of ORG_ADMIN.","type":"text/plain"},"url":{"path":["sod-policies"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create SOD policy' (create-sod-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create SOD policy + + + +This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. +Requires role of ORG_ADMIN. + +
    Request Body required
      ownerRef object
      violationOwnerAssignmentConfig object
      ownerRef object
      conflictingAccessCriteria object
      leftCriteria object
      criteriaList object[]
      + +**Possible values:** `>= 1`, `<= 50` + +
      + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
      rightCriteria object
      criteriaList object[]
      + +**Possible values:** `>= 1`, `<= 50` + +
      + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
    + +SOD policy created + +
    Schema
      ownerRef object
      violationOwnerAssignmentConfig object
      ownerRef object
      conflictingAccessCriteria object
      leftCriteria object
      criteriaList object[]
      + +**Possible values:** `>= 1`, `<= 50` + +
      + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
      rightCriteria object
      criteriaList object[]
      + +**Possible values:** `>= 1`, `<= 50` + +
      + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-source-schema.api.mdx b/products/idn/api/v3/create-source-schema.api.mdx new file mode 100644 index 000000000..ade1d72e3 --- /dev/null +++ b/products/idn/api/v3/create-source-schema.api.mdx @@ -0,0 +1,92 @@ +--- +id: create-source-schema +sidebar_label: Create Schema on a Source +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createSourceSchema","tags":["Sources"],"description":"Creates a new Schema on the specified Source in IdentityNow.\n","parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source id.","example":"2c9180835d191a86015d28455b4a2329"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Schema.","example":"2c9180835d191a86015d28455b4a2329"},"name":{"type":"string","description":"The name of the Schema.","example":"account"},"nativeObjectType":{"type":"string","description":"The name of the object type on the native system that the schema represents.","example":"User"},"identityAttribute":{"type":"string","description":"The name of the attribute used to calculate the unique identifier for an object in the schema.","example":"sAMAccountName"},"displayAttribute":{"type":"string","description":"The name of the attribute used to calculate the display value for an object in the schema.","example":"distinguishedName"},"hierarchyAttribute":{"type":"string","description":"The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.","example":"memberOf"},"includePermissions":{"type":"boolean","description":"Flag indicating whether or not the include permissions with the object data when aggregating the schema.","example":false},"features":{"type":"array","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.","example":"AUTHENTICATE"},"description":"The features that the schema supports.","example":["PROVISIONING","NO_PERMISSIONS_PROVISIONING","GROUPS_HAVE_MEMBERS"]},"configuration":{"type":"object","description":"Holds any extra configuration data that the schema may require.","example":{"groupMemberAttribute":"member"}},"attributes":{"type":"array","description":"The attribute definitions which form the schema.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"sAMAccountName"},"type":{"description":"The type of the attribute.","example":"STRING","type":"string","enum":["STRING","LONG","INT","BOOLEAN"]},"schema":{"description":"A reference to the schema on the source to the attribute values map to.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"The object ID this reference applies to.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The human-readable display name of the object.","example":"group"}}},"description":{"type":"string","description":"A human-readable description of the attribute.","example":"SAM Account Name"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","example":false},"isEntitlement":{"type":"boolean","description":"Flag indicating whether or not the attribute is an entitlement.","example":false},"isGroup":{"type":"boolean","description":"Flag indicating whether or not the attribute represents a group.\nThis can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute..\n","example":false}}},"example":[{"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":{"type":"string","description":"The date the Schema was created.","format":"date-time","example":"2019-12-24T22:32:58.104Z"},"modified":{"type":"string","description":"The date the Schema was last modified.","format":"date-time","example":"2019-12-31T20:22:28.104Z"}}}}}},"responses":{"201":{"description":"The Schema was successfully created on the specified Source.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Schema.","example":"2c9180835d191a86015d28455b4a2329"},"name":{"type":"string","description":"The name of the Schema.","example":"account"},"nativeObjectType":{"type":"string","description":"The name of the object type on the native system that the schema represents.","example":"User"},"identityAttribute":{"type":"string","description":"The name of the attribute used to calculate the unique identifier for an object in the schema.","example":"sAMAccountName"},"displayAttribute":{"type":"string","description":"The name of the attribute used to calculate the display value for an object in the schema.","example":"distinguishedName"},"hierarchyAttribute":{"type":"string","description":"The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.","example":"memberOf"},"includePermissions":{"type":"boolean","description":"Flag indicating whether or not the include permissions with the object data when aggregating the schema.","example":false},"features":{"type":"array","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.","example":"AUTHENTICATE"},"description":"The features that the schema supports.","example":["PROVISIONING","NO_PERMISSIONS_PROVISIONING","GROUPS_HAVE_MEMBERS"]},"configuration":{"type":"object","description":"Holds any extra configuration data that the schema may require.","example":{"groupMemberAttribute":"member"}},"attributes":{"type":"array","description":"The attribute definitions which form the schema.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"sAMAccountName"},"type":{"description":"The type of the attribute.","example":"STRING","type":"string","enum":["STRING","LONG","INT","BOOLEAN"]},"schema":{"description":"A reference to the schema on the source to the attribute values map to.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"The object ID this reference applies to.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The human-readable display name of the object.","example":"group"}}},"description":{"type":"string","description":"A human-readable description of the attribute.","example":"SAM Account Name"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","example":false},"isEntitlement":{"type":"boolean","description":"Flag indicating whether or not the attribute is an entitlement.","example":false},"isGroup":{"type":"boolean","description":"Flag indicating whether or not the attribute represents a group.\nThis can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute..\n","example":false}}},"example":[{"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":{"type":"string","description":"The date the Schema was created.","format":"date-time","example":"2019-12-24T22:32:58.104Z"},"modified":{"type":"string","description":"The date the Schema was last modified.","format":"date-time","example":"2019-12-31T20:22:28.104Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sources/{sourceId}/schemas","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"id":"2c9180835d191a86015d28455b4a2329","name":"account","nativeObjectType":"User","identityAttribute":"sAMAccountName","displayAttribute":"distinguishedName","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}],"created":"2019-12-24T22:32:58.104Z","modified":"2019-12-31T20:22:28.104Z"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Create Schema on a Source","description":{"content":"Creates a new Schema on the specified Source in IdentityNow.\n","type":"text/plain"},"url":{"path":["sources",":sourceId","schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id.","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create Schema on a Source' (create-source-schema)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create Schema on a Source + + + +Creates a new Schema on the specified Source in IdentityNow. + + +
    Path Parameters
    Request Body required
      attributes object[]
      + +The attribute definitions which form the schema. + +
      schema object
      + +A reference to the schema on the source to the attribute values map to. + +
    + +The Schema was successfully created on the specified Source. + +
    Schema
      attributes object[]
      + +The attribute definitions which form the schema. + +
      schema object
      + +A reference to the schema on the source to the attribute values map to. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-source.api.mdx b/products/idn/api/v3/create-source.api.mdx new file mode 100644 index 000000000..ce74db9b6 --- /dev/null +++ b/products/idn/api/v3/create-source.api.mdx @@ -0,0 +1,156 @@ +--- +id: create-source +sidebar_label: Creates a source in IdentityNow. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createSource","security":[{"oauth2":["idn:sources:manage"]}],"tags":["Sources"],"description":"This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow.\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","parameters":[{"in":"query","name":"provisionAsCsv","description":"If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. ","schema":{"type":"boolean"},"required":false,"example":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"the id of the Source","example":"2c91808568c529c60168cca6f90c1324"},"name":{"type":"string","description":"Human-readable name of the source","example":"My Source"},"description":{"type":"string","description":"Human-readable description of the source","example":"This is the corporate directory."},"owner":{"description":"Reference to an owning Identity Object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity","example":"MyName"}}},"cluster":{"description":"Reference to the associated Cluster","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"type":"string","description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"accountCorrelationConfig":{"description":"Reference to an Account Correlation Config object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG"],"example":"ACCOUNT_CORRELATION_CONFIG"},"id":{"type":"string","description":"ID of the account correlation config","example":"2c9180855d191c59015d28583727245a"},"name":{"type":"string","description":"Human-readable display name of the account correlation config","example":"Directory [source-62867] Account Correlation"}}},"accountCorrelationRule":{"description":"Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"managerCorrelationMapping":{"description":"Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity","type":"object","properties":{"accountAttribute":{"type":"string","description":"Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.","example":"manager"},"identityAttribute":{"type":"string","description":"Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.","example":"manager"}}},"managerCorrelationRule":{"description":"Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"beforeProvisioningRule":{"description":"Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"schemas":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"ID of the schema","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the schema","example":"MySchema"}}},"description":"List of references to Schema objects","example":[{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232a","name":"account"},{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232b","name":"group"}]},"passwordPolicies":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["PASSWORD_POLICY"],"example":"PASSWORD_POLICY"},"id":{"type":"string","description":"ID of the policy","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the policy","example":"My Password Policy"}}},"description":"List of references to the associated PasswordPolicy objects.","example":[{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb053980","name":"Corporate Password Policy"},{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb057777","name":"Vendor Password Policy"}]},"features":{"type":"array","description":"Optional features that can be supported by a source.","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.","example":"AUTHENTICATE"},"example":["SYNC_PROVISIONING","MANAGER_LOOKUP","SEARCH","PROVISIONING","AUTHENTICATE","GROUP_PROVISIONING","PASSWORD"]},"type":{"type":"string","description":"Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ","example":"OpenLDAP - Direct"},"connector":{"type":"string","description":"Connector script name.","example":"active-directory"},"connectorClass":{"type":"string","description":"The fully qualified name of the Java class that implements the connector interface.","example":"sailpoint.connector.LDAPConnector"},"connectorAttributes":{"type":"object","description":"Connector specific configuration; will differ from type to type.","example":{"healthCheckTimeout":30,"authSearchAttributes":["cn","uid","mail"]}},"deleteThreshold":{"type":"integer","format":"int32","description":"Number from 0 to 100 that specifies when to skip the delete phase.","example":10},"authoritative":{"type":"boolean","description":"When true indicates the source is referenced by an IdentityProfile.","example":false},"managementWorkgroup":{"description":"Reference to Management Workgroup for this Source","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["GOVERNANCE_GROUP"],"example":"GOVERNANCE_GROUP"},"id":{"type":"string","description":"ID of the management workgroup","example":"2c91808568c529c60168cca6f90c2222"},"name":{"type":"string","description":"Human-readable display name of the management workgroup","example":"My Management Workgroup"}}},"healthy":{"type":"boolean","description":"When true indicates a healthy source","example":true},"status":{"type":"string","description":"A status identifier, giving specific information on why a source is healthy or not","example":"SOURCE_STATE_HEALTHY"},"since":{"type":"string","description":"Timestamp showing when a source health check was last performed","example":"2021-09-28T15:48:29.3801666300Z"},"connectorId":{"type":"string","description":"The id of connector","example":"active-directory"},"connectorName":{"type":"string","description":"The name of the connector that was chosen on source creation","example":"Active Directory"},"connectionType":{"type":"string","description":"The type of connection (direct or file)","example":"file"},"connectorImplementstionId":{"type":"string","description":"The connector implementstion id","example":"delimited-file"}},"required":["name","owner","connector"]}}}},"responses":{"201":{"description":"Created Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"the id of the Source","example":"2c91808568c529c60168cca6f90c1324"},"name":{"type":"string","description":"Human-readable name of the source","example":"My Source"},"description":{"type":"string","description":"Human-readable description of the source","example":"This is the corporate directory."},"owner":{"description":"Reference to an owning Identity Object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity","example":"MyName"}}},"cluster":{"description":"Reference to the associated Cluster","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"type":"string","description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"accountCorrelationConfig":{"description":"Reference to an Account Correlation Config object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG"],"example":"ACCOUNT_CORRELATION_CONFIG"},"id":{"type":"string","description":"ID of the account correlation config","example":"2c9180855d191c59015d28583727245a"},"name":{"type":"string","description":"Human-readable display name of the account correlation config","example":"Directory [source-62867] Account Correlation"}}},"accountCorrelationRule":{"description":"Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"managerCorrelationMapping":{"description":"Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity","type":"object","properties":{"accountAttribute":{"type":"string","description":"Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.","example":"manager"},"identityAttribute":{"type":"string","description":"Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.","example":"manager"}}},"managerCorrelationRule":{"description":"Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"beforeProvisioningRule":{"description":"Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"schemas":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"ID of the schema","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the schema","example":"MySchema"}}},"description":"List of references to Schema objects","example":[{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232a","name":"account"},{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232b","name":"group"}]},"passwordPolicies":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["PASSWORD_POLICY"],"example":"PASSWORD_POLICY"},"id":{"type":"string","description":"ID of the policy","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the policy","example":"My Password Policy"}}},"description":"List of references to the associated PasswordPolicy objects.","example":[{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb053980","name":"Corporate Password Policy"},{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb057777","name":"Vendor Password Policy"}]},"features":{"type":"array","description":"Optional features that can be supported by a source.","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.","example":"AUTHENTICATE"},"example":["SYNC_PROVISIONING","MANAGER_LOOKUP","SEARCH","PROVISIONING","AUTHENTICATE","GROUP_PROVISIONING","PASSWORD"]},"type":{"type":"string","description":"Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ","example":"OpenLDAP - Direct"},"connector":{"type":"string","description":"Connector script name.","example":"active-directory"},"connectorClass":{"type":"string","description":"The fully qualified name of the Java class that implements the connector interface.","example":"sailpoint.connector.LDAPConnector"},"connectorAttributes":{"type":"object","description":"Connector specific configuration; will differ from type to type.","example":{"healthCheckTimeout":30,"authSearchAttributes":["cn","uid","mail"]}},"deleteThreshold":{"type":"integer","format":"int32","description":"Number from 0 to 100 that specifies when to skip the delete phase.","example":10},"authoritative":{"type":"boolean","description":"When true indicates the source is referenced by an IdentityProfile.","example":false},"managementWorkgroup":{"description":"Reference to Management Workgroup for this Source","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["GOVERNANCE_GROUP"],"example":"GOVERNANCE_GROUP"},"id":{"type":"string","description":"ID of the management workgroup","example":"2c91808568c529c60168cca6f90c2222"},"name":{"type":"string","description":"Human-readable display name of the management workgroup","example":"My Management Workgroup"}}},"healthy":{"type":"boolean","description":"When true indicates a healthy source","example":true},"status":{"type":"string","description":"A status identifier, giving specific information on why a source is healthy or not","example":"SOURCE_STATE_HEALTHY"},"since":{"type":"string","description":"Timestamp showing when a source health check was last performed","example":"2021-09-28T15:48:29.3801666300Z"},"connectorId":{"type":"string","description":"The id of connector","example":"active-directory"},"connectorName":{"type":"string","description":"The name of the connector that was chosen on source creation","example":"Active Directory"},"connectionType":{"type":"string","description":"The type of connection (direct or file)","example":"file"},"connectorImplementstionId":{"type":"string","description":"The connector implementstion id","example":"delimited-file"}},"required":["name","owner","connector"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sources","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"My Source","description":"This is the corporate directory.","owner":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"MyName"},"cluster":{"type":"CLUSTER","id":"2c9180866166b5b0016167c32ef31a66","name":"Corporate Cluster"},"accountCorrelationConfig":{"type":"ACCOUNT_CORRELATION_CONFIG","id":"2c9180855d191c59015d28583727245a","name":"Directory [source-62867] Account Correlation"},"accountCorrelationRule":{"type":"RULE","id":"2c918085708c274401708c2a8a760001","name":"Example Rule"},"managerCorrelationMapping":{"accountAttribute":"manager","identityAttribute":"manager"},"managerCorrelationRule":{"type":"RULE","id":"2c918085708c274401708c2a8a760001","name":"Example Rule"},"beforeProvisioningRule":{"type":"RULE","id":"2c918085708c274401708c2a8a760001","name":"Example Rule"},"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":["SYNC_PROVISIONING","MANAGER_LOOKUP","SEARCH","PROVISIONING","AUTHENTICATE","GROUP_PROVISIONING","PASSWORD"],"type":"OpenLDAP - Direct","connector":"active-directory","connectorClass":"sailpoint.connector.LDAPConnector","connectorAttributes":{"healthCheckTimeout":30,"authSearchAttributes":["cn","uid","mail"]},"deleteThreshold":10,"authoritative":false,"managementWorkgroup":{"type":"GOVERNANCE_GROUP","id":"2c91808568c529c60168cca6f90c2222","name":"My Management Workgroup"},"healthy":true,"status":"SOURCE_STATE_HEALTHY","since":"2021-09-28T15:48:29.3801666300Z","connectorId":"active-directory","connectorName":"Active Directory","connectionType":"file","connectorImplementstionId":"delimited-file"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Creates a source in IdentityNow.","description":{"content":"This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow.\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. ","type":"text/plain"},"key":"provisionAsCsv","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Creates a source in IdentityNow.' (create-source)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Creates a source in IdentityNow. + + + +This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +
    Query Parameters
    Request Body required
      owner object required
      + +Reference to an owning Identity Object + +
      cluster object
      + +Reference to the associated Cluster + +
      accountCorrelationConfig object
      + +Reference to an Account Correlation Config object + +
      accountCorrelationRule object
      + +Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used. + +
      managerCorrelationMapping object
      + +Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + +
      managerCorrelationRule object
      + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
      beforeProvisioningRule object
      + +Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + +
      schemas object[]
      + +List of references to Schema objects + +
      passwordPolicies object[]
      + +List of references to the associated PasswordPolicy objects. + +
      managementWorkgroup object
      + +Reference to Management Workgroup for this Source + +
    + +Created Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design. + +
    Schema
      owner object
      + +Reference to an owning Identity Object + +
      cluster object
      + +Reference to the associated Cluster + +
      accountCorrelationConfig object
      + +Reference to an Account Correlation Config object + +
      accountCorrelationRule object
      + +Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used. + +
      managerCorrelationMapping object
      + +Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + +
      managerCorrelationRule object
      + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
      beforeProvisioningRule object
      + +Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + +
      schemas object[]
      + +List of references to Schema objects + +
      passwordPolicies object[]
      + +List of references to the associated PasswordPolicy objects. + +
      managementWorkgroup object
      + +Reference to Management Workgroup for this Source + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/create-transform.api.mdx b/products/idn/api/v3/create-transform.api.mdx new file mode 100644 index 000000000..ffeb7552c --- /dev/null +++ b/products/idn/api/v3/create-transform.api.mdx @@ -0,0 +1,903 @@ +--- +id: create-transform +sidebar_label: Create transform +hide_title: true +hide_table_of_contents: true +api: {"tags":["Transforms"],"description":"Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. A token with transform write authority is required to call this API.","operationId":"createTransform","requestBody":{"required":true,"description":"The transform to be created.","content":{"application/json":{"schema":{"type":"object","description":"The representation of an internally- or customer-defined transform.","required":["name","type","attributes"],"properties":{"id":{"type":"string","readOnly":true,"description":"Unique ID of this transform","example":"2cd78adghjkja34jh2b1hkjhasuecd"},"name":{"type":"string","description":"Unique name of this transform","example":"Timestamp To Date","minLength":1,"maxLength":50},"type":{"type":"string","description":"The type of transform operation","enum":["accountAttribute","base64Decode","base64Encode","concat","conditional","dateCompare","dateFormat","dateMath","decomposeDiacriticalMarks","e164phone","firstValid","rule","identityAttribute","indexOf","iso3166","lastIndexOf","leftPad","lookup","lower","normalizeNames","randomAlphaNumeric","randomNumeric","reference","replaceAll","replace","rightPad","split","static","substring","trim","upper","usernameGenerator","uuid"],"example":"dateFormat","externalDocs":{"description":"Transform Operations","url":"https://developer.sailpoint.com/idn/docs/transforms/operations"}},"attributes":{"description":"Meta-data about the transform. Values in this list are specific to the type of transform to be executed.","oneOf":[{"title":"accountAttribute","type":"object","required":["sourceName","attributeName"],"properties":{"sourceName":{"type":"string","description":"A reference to the source to search for the account","example":"Workday"},"attributeName":{"type":"string","description":"The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.","example":"DEPARTMENT"},"accountSortAttribute":{"type":"string","description":"The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries","example":"created"},"accountSortDescending":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)","example":false},"accountReturnFirstLink":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false","example":false},"accountFilter":{"type":"string","description":"This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria.\nOnly certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements","example":"!(nativeIdentity.startsWith(\"*DELETED*\"))"},"accountPropertyFilter":{"type":"string","description":"This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.\n\nAll account attributes are available for filtering as this operation is performed in memory.","example":"(groups.containsAll({'Admin'}) || location == 'Austin')"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"base64Decode","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"base64Encode","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"concat","type":"object","required":["values"],"properties":{"values":{"type":"array","items":{"type":"object"},"description":"An array of items to join together","example":["John"," ","Smith"]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"conditional","type":"object","required":["expression","positiveCondition","negativeCondition"],"properties":{"expression":{"type":"string","description":"A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. \n\nThe `eq` operator is the only valid comparison","example":"ValueA eq ValueB"},"positiveCondition":{"type":"string","description":"The output of the transform if the expression evalutes to true","example":"true"},"negativeCondition":{"type":"string","description":"The output of the transform if the expression evalutes to false","example":"false"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateCompare","type":"object","required":["firstDate","secondDate","operator","positiveCondition","negativeCondition"],"properties":{"firstDate":{"description":"This is the first date to consider (The date that would be on the left hand side of the comparison operation).","oneOf":[{"title":"accountAttribute","type":"object","required":["sourceName","attributeName"],"properties":{"sourceName":{"type":"string","description":"A reference to the source to search for the account","example":"Workday"},"attributeName":{"type":"string","description":"The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.","example":"DEPARTMENT"},"accountSortAttribute":{"type":"string","description":"The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries","example":"created"},"accountSortDescending":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)","example":false},"accountReturnFirstLink":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false","example":false},"accountFilter":{"type":"string","description":"This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria.\nOnly certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements","example":"!(nativeIdentity.startsWith(\"*DELETED*\"))"},"accountPropertyFilter":{"type":"string","description":"This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.\n\nAll account attributes are available for filtering as this operation is performed in memory.","example":"(groups.containsAll({'Admin'}) || location == 'Austin')"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateFormat","type":"object","properties":{"inputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"outputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}}]},"secondDate":{"description":"This is the second date to consider (The date that would be on the right hand side of the comparison operation).","oneOf":[{"title":"accountAttribute","type":"object","required":["sourceName","attributeName"],"properties":{"sourceName":{"type":"string","description":"A reference to the source to search for the account","example":"Workday"},"attributeName":{"type":"string","description":"The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.","example":"DEPARTMENT"},"accountSortAttribute":{"type":"string","description":"The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries","example":"created"},"accountSortDescending":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)","example":false},"accountReturnFirstLink":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false","example":false},"accountFilter":{"type":"string","description":"This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria.\nOnly certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements","example":"!(nativeIdentity.startsWith(\"*DELETED*\"))"},"accountPropertyFilter":{"type":"string","description":"This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.\n\nAll account attributes are available for filtering as this operation is performed in memory.","example":"(groups.containsAll({'Admin'}) || location == 'Austin')"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateFormat","type":"object","properties":{"inputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"outputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}}]},"operator":{"type":"string","description":"This is the comparison to perform.\n| Operation | Description |\n| --------- | ------- |\n| LT | Strictly less than: firstDate < secondDate |\n| LTE | Less than or equal to: firstDate <= secondDate |\n| GT | Strictly greater than: firstDate > secondDate |\n| GTE | Greater than or equal to: firstDate >= secondDate |\n","enum":["LT","LTE","GT","GTE"],"example":"LT"},"positiveCondition":{"type":"string","description":"The output of the transform if the expression evalutes to true","example":"true"},"negativeCondition":{"type":"string","description":"The output of the transform if the expression evalutes to false","example":false},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateFormat","type":"object","properties":{"inputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"outputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateMath","type":"object","required":["expression"],"properties":{"expression":{"type":"string","description":"A string value of the date and time components to operation on, along with the math operations to execute.\n","externalDocs":{"description":"Date Math Expressions","url":"https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure"},"example":"now+1w"},"roundUp":{"type":"boolean","description":"A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. \n\n\nIf not provided, the transform will default to `false`\n\n\n`true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component)\n\n\n`false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated)\n","example":false},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"decomposeDiacriticalMarks","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"e164phone","type":"object","properties":{"defaultRegion":{"type":"string","description":"This is an optional attribute that can be used to define the region of the phone number to format into.\n\n\nIf defaultRegion is not provided, it will take US as the default country.\n\n\nThe format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\n","example":"US"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"firstValid","type":"object","required":["values"],"properties":{"values":{"type":"array","items":{"type":"object"},"description":"An array of attributes to evaluate for existence.","example":[{"attributes":{"sourceName":"Active Directory","attributeName":"sAMAccountName"},"type":"accountAttribute"},{"attributes":{"sourceName":"Okta","attributeName":"login"},"type":"accountAttribute"},{"attributes":{"sourceName":"HR Source","attributeName":"employeeID"},"type":"accountAttribute"}]},"ignoreErrors":{"type":"boolean","description":"a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur.","example":false},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false}}},{"title":"rule","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"This is the name of the Generic rule that needs to be invoked by the transform","example":"Generic Calculation Rule"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false}}},{"type":"object","required":["name","operation","includeNumbers","includeSpecialChars","length"],"properties":{"name":{"type":"string","description":"This must always be set to \"Cloud Services Deployment Utility\"","example":"Cloud Services Deployment Utility"},"operation":{"type":"string","description":"The operation to perform `generateRandomString`","example":"generateRandomString"},"includeNumbers":{"type":"boolean","description":"This must be either \"true\" or \"false\" to indicate whether the generator logic should include numbers","example":true},"includeSpecialChars":{"type":"boolean","description":"This must be either \"true\" or \"false\" to indicate whether the generator logic should include special characters","example":true},"length":{"type":"string","description":"This specifies how long the randomly generated string needs to be\n\n\n>NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters\n","example":"10"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false}}},{"type":"object","required":["name","operation","uid"],"properties":{"name":{"type":"string","description":"This must always be set to \"Cloud Services Deployment Utility\"","example":"Cloud Services Deployment Utility"},"operation":{"type":"string","description":"The operation to perform `getReferenceIdentityAttribute`","example":"getReferenceIdentityAttribute"},"uid":{"type":"string","description":"This is the SailPoint User Name (uid) value of the identity whose attribute is desired\n\nAs a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute.\n","example":"2c91808570313110017040b06f344ec9"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false}}}]},{"title":"identityAttribute","type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The system (camel-cased) name of the identity attribute to bring in","example":"email"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"indexOf","type":"object","required":["substring"],"properties":{"substring":{"type":"string","description":"A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.","example":"admin_"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"iso3166","type":"object","properties":{"format":{"type":"string","description":"An optional value to denote which ISO 3166 format to return. Valid values are:\n\n\n`alpha2` - Two-character country code (e.g., \"US\"); this is the default value if no format is supplied\n\n\n`alpha3` - Three-character country code (e.g., \"USA\")\n\n\n`numeric` - The numeric country code (e.g., \"840\")\n","example":"alpha2"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"leftPad","type":"object","required":["length"],"properties":{"length":{"type":"string","description":"An integer value for the desired length of the final output string","example":"4"},"padding":{"type":"string","description":"A string value representing the character that the incoming data should be padded with to get to the desired length\n\n\nIf not provided, the transform will default to a single space (\" \") character for padding\n","example":"0"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"lookup","type":"object","required":["table"],"properties":{"table":{"type":"object","additionalProperties":true,"description":"This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched\n\n\n>**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return \"Unknown Region\" for the attribute that is mapped to this transform.\n","example":{"USA":"Americas","FRA":"EMEA","AUS":"APAC","default":"Unknown Region"}},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"lower","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"nameNormalizer","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"randomAlphaNumeric","type":"object","properties":{"length":{"type":"string","description":"This is an integer value specifying the size/number of characters the random string must contain\n\n\n* This value must be a positive number and cannot be blank\n\n\n* If no length is provided, the transform will default to a value of `32`\n\n\n* Due to identity attribute data constraints, the maximum allowable value is `450` characters\n","example":"10"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"randomNumeric","type":"object","properties":{"length":{"type":"string","description":"This is an integer value specifying the size/number of characters the random string must contain\n\n\n* This value must be a positive number and cannot be blank\n\n\n* If no length is provided, the transform will default to a value of `32`\n\n\n* Due to identity attribute data constraints, the maximum allowable value is `450` characters\n","example":"10"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"reference","type":"object","required":["id"],"properties":{"id":{"type":"string","description":"This ID specifies the name of the pre-existing transform which you want to use within your current transform","example":"Existing Transform"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"replaceAll","type":"object","required":["table"],"properties":{"table":{"type":"object","additionalProperties":true,"description":"An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.","example":{"-":" ","\"":"'","ñ":"n"}},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"replace","type":"object","required":["regex","replacement"],"properties":{"regex":{"type":"string","description":"This can be a string or a regex pattern in which you want to replace.","example":"[^a-zA-Z]","externalDocs":{"description":"Regex Builder","url":"https://regex101.com/"}},"replacement":{"type":"string","description":"This is the replacement string that should be substituded wherever the string or pattern is found.","example":" "},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"rightPad","type":"object","required":["length"],"properties":{"length":{"type":"string","description":"An integer value for the desired length of the final output string","example":"4"},"padding":{"type":"string","description":"A string value representing the character that the incoming data should be padded with to get to the desired length\n\n\nIf not provided, the transform will default to a single space (\" \") character for padding\n","example":"0"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"split","type":"object","required":["delimiter","index"],"properties":{"delimiter":{"type":"string","description":"This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data","example":","},"index":{"type":"string","description":"An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.","example":"5"},"throws":{"type":"boolean","description":"A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array)\n\n\n`true` - The transform should return \"IndexOutOfBoundsException\"\n\n\n`false` - The transform should return null\n\n\nIf not provided, the transform will default to false and return a null\n","example":true},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"static","type":"object","required":["values"],"properties":{"values":{"type":"string","description":"This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.","example":"string$variable","externalDocs":{"description":"Static Transform Documentation","url":"https://developer.sailpoint.com/idn/docs/transforms/operations/static"}},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false}}},{"title":"substring","type":"object","required":["begin"],"properties":{"begin":{"type":"integer","description":"The index of the first character to include in the returned substring.\n\n\nIf `begin` is set to -1, the transform will begin at character 0 of the input data\n","example":1,"format":"int32"},"beginOffset":{"type":"integer","description":"This integer value is the number of characters to add to the begin attribute when returning a substring. \n\nThis attribute is only used if begin is not -1.\n","example":3,"format":"int32"},"end":{"type":"integer","description":"The index of the first character to exclude from the returned substring.\n\nIf end is -1 or not provided at all, the substring transform will return everything up to the end of the input string.\n","example":6,"format":"int32"},"endOffset":{"type":"integer","description":"This integer value is the number of characters to add to the end attribute when returning a substring. \n\nThis attribute is only used if end is provided and is not -1.\n","example":1,"format":"int32"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"trim","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"upper","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"uuid","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false}}}]},"internal":{"type":"boolean","readOnly":true,"description":"Indicates whether this is an internal SailPoint-created transform or a customer-created transform","example":false}}},"example":{"name":"Timestamp To Date","type":"dateFormat","attributes":{"inputFormat":"MMM dd yyyy, HH:mm:ss.SSS","outputFormat":"yyyy/dd/MM"}}}}},"responses":{"201":{"description":"Indicates the transform was successfully created and returns its representation.","content":{"application/json":{"schema":{"type":"object","description":"The representation of an internally- or customer-defined transform.","required":["name","type","attributes"],"properties":{"id":{"type":"string","readOnly":true,"description":"Unique ID of this transform","example":"2cd78adghjkja34jh2b1hkjhasuecd"},"name":{"type":"string","description":"Unique name of this transform","example":"Timestamp To Date","minLength":1,"maxLength":50},"type":{"type":"string","description":"The type of transform operation","enum":["accountAttribute","base64Decode","base64Encode","concat","conditional","dateCompare","dateFormat","dateMath","decomposeDiacriticalMarks","e164phone","firstValid","rule","identityAttribute","indexOf","iso3166","lastIndexOf","leftPad","lookup","lower","normalizeNames","randomAlphaNumeric","randomNumeric","reference","replaceAll","replace","rightPad","split","static","substring","trim","upper","usernameGenerator","uuid"],"example":"dateFormat","externalDocs":{"description":"Transform Operations","url":"https://developer.sailpoint.com/idn/docs/transforms/operations"}},"attributes":{"description":"Meta-data about the transform. Values in this list are specific to the type of transform to be executed.","oneOf":[{"title":"accountAttribute","type":"object","required":["sourceName","attributeName"],"properties":{"sourceName":{"type":"string","description":"A reference to the source to search for the account","example":"Workday"},"attributeName":{"type":"string","description":"The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.","example":"DEPARTMENT"},"accountSortAttribute":{"type":"string","description":"The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries","example":"created"},"accountSortDescending":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)","example":false},"accountReturnFirstLink":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false","example":false},"accountFilter":{"type":"string","description":"This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria.\nOnly certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements","example":"!(nativeIdentity.startsWith(\"*DELETED*\"))"},"accountPropertyFilter":{"type":"string","description":"This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.\n\nAll account attributes are available for filtering as this operation is performed in memory.","example":"(groups.containsAll({'Admin'}) || location == 'Austin')"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"base64Decode","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"base64Encode","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"concat","type":"object","required":["values"],"properties":{"values":{"type":"array","items":{"type":"object"},"description":"An array of items to join together","example":["John"," ","Smith"]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"conditional","type":"object","required":["expression","positiveCondition","negativeCondition"],"properties":{"expression":{"type":"string","description":"A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. \n\nThe `eq` operator is the only valid comparison","example":"ValueA eq ValueB"},"positiveCondition":{"type":"string","description":"The output of the transform if the expression evalutes to true","example":"true"},"negativeCondition":{"type":"string","description":"The output of the transform if the expression evalutes to false","example":"false"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateCompare","type":"object","required":["firstDate","secondDate","operator","positiveCondition","negativeCondition"],"properties":{"firstDate":{"description":"This is the first date to consider (The date that would be on the left hand side of the comparison operation).","oneOf":[{"title":"accountAttribute","type":"object","required":["sourceName","attributeName"],"properties":{"sourceName":{"type":"string","description":"A reference to the source to search for the account","example":"Workday"},"attributeName":{"type":"string","description":"The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.","example":"DEPARTMENT"},"accountSortAttribute":{"type":"string","description":"The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries","example":"created"},"accountSortDescending":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)","example":false},"accountReturnFirstLink":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false","example":false},"accountFilter":{"type":"string","description":"This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria.\nOnly certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements","example":"!(nativeIdentity.startsWith(\"*DELETED*\"))"},"accountPropertyFilter":{"type":"string","description":"This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.\n\nAll account attributes are available for filtering as this operation is performed in memory.","example":"(groups.containsAll({'Admin'}) || location == 'Austin')"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateFormat","type":"object","properties":{"inputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"outputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}}]},"secondDate":{"description":"This is the second date to consider (The date that would be on the right hand side of the comparison operation).","oneOf":[{"title":"accountAttribute","type":"object","required":["sourceName","attributeName"],"properties":{"sourceName":{"type":"string","description":"A reference to the source to search for the account","example":"Workday"},"attributeName":{"type":"string","description":"The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.","example":"DEPARTMENT"},"accountSortAttribute":{"type":"string","description":"The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries","example":"created"},"accountSortDescending":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)","example":false},"accountReturnFirstLink":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false","example":false},"accountFilter":{"type":"string","description":"This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria.\nOnly certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements","example":"!(nativeIdentity.startsWith(\"*DELETED*\"))"},"accountPropertyFilter":{"type":"string","description":"This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.\n\nAll account attributes are available for filtering as this operation is performed in memory.","example":"(groups.containsAll({'Admin'}) || location == 'Austin')"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateFormat","type":"object","properties":{"inputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"outputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}}]},"operator":{"type":"string","description":"This is the comparison to perform.\n| Operation | Description |\n| --------- | ------- |\n| LT | Strictly less than: firstDate < secondDate |\n| LTE | Less than or equal to: firstDate <= secondDate |\n| GT | Strictly greater than: firstDate > secondDate |\n| GTE | Greater than or equal to: firstDate >= secondDate |\n","enum":["LT","LTE","GT","GTE"],"example":"LT"},"positiveCondition":{"type":"string","description":"The output of the transform if the expression evalutes to true","example":"true"},"negativeCondition":{"type":"string","description":"The output of the transform if the expression evalutes to false","example":false},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateFormat","type":"object","properties":{"inputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"outputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateMath","type":"object","required":["expression"],"properties":{"expression":{"type":"string","description":"A string value of the date and time components to operation on, along with the math operations to execute.\n","externalDocs":{"description":"Date Math Expressions","url":"https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure"},"example":"now+1w"},"roundUp":{"type":"boolean","description":"A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. \n\n\nIf not provided, the transform will default to `false`\n\n\n`true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component)\n\n\n`false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated)\n","example":false},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"decomposeDiacriticalMarks","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"e164phone","type":"object","properties":{"defaultRegion":{"type":"string","description":"This is an optional attribute that can be used to define the region of the phone number to format into.\n\n\nIf defaultRegion is not provided, it will take US as the default country.\n\n\nThe format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\n","example":"US"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"firstValid","type":"object","required":["values"],"properties":{"values":{"type":"array","items":{"type":"object"},"description":"An array of attributes to evaluate for existence.","example":[{"attributes":{"sourceName":"Active Directory","attributeName":"sAMAccountName"},"type":"accountAttribute"},{"attributes":{"sourceName":"Okta","attributeName":"login"},"type":"accountAttribute"},{"attributes":{"sourceName":"HR Source","attributeName":"employeeID"},"type":"accountAttribute"}]},"ignoreErrors":{"type":"boolean","description":"a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur.","example":false},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false}}},{"title":"rule","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"This is the name of the Generic rule that needs to be invoked by the transform","example":"Generic Calculation Rule"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false}}},{"type":"object","required":["name","operation","includeNumbers","includeSpecialChars","length"],"properties":{"name":{"type":"string","description":"This must always be set to \"Cloud Services Deployment Utility\"","example":"Cloud Services Deployment Utility"},"operation":{"type":"string","description":"The operation to perform `generateRandomString`","example":"generateRandomString"},"includeNumbers":{"type":"boolean","description":"This must be either \"true\" or \"false\" to indicate whether the generator logic should include numbers","example":true},"includeSpecialChars":{"type":"boolean","description":"This must be either \"true\" or \"false\" to indicate whether the generator logic should include special characters","example":true},"length":{"type":"string","description":"This specifies how long the randomly generated string needs to be\n\n\n>NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters\n","example":"10"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false}}},{"type":"object","required":["name","operation","uid"],"properties":{"name":{"type":"string","description":"This must always be set to \"Cloud Services Deployment Utility\"","example":"Cloud Services Deployment Utility"},"operation":{"type":"string","description":"The operation to perform `getReferenceIdentityAttribute`","example":"getReferenceIdentityAttribute"},"uid":{"type":"string","description":"This is the SailPoint User Name (uid) value of the identity whose attribute is desired\n\nAs a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute.\n","example":"2c91808570313110017040b06f344ec9"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false}}}]},{"title":"identityAttribute","type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The system (camel-cased) name of the identity attribute to bring in","example":"email"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"indexOf","type":"object","required":["substring"],"properties":{"substring":{"type":"string","description":"A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.","example":"admin_"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"iso3166","type":"object","properties":{"format":{"type":"string","description":"An optional value to denote which ISO 3166 format to return. Valid values are:\n\n\n`alpha2` - Two-character country code (e.g., \"US\"); this is the default value if no format is supplied\n\n\n`alpha3` - Three-character country code (e.g., \"USA\")\n\n\n`numeric` - The numeric country code (e.g., \"840\")\n","example":"alpha2"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"leftPad","type":"object","required":["length"],"properties":{"length":{"type":"string","description":"An integer value for the desired length of the final output string","example":"4"},"padding":{"type":"string","description":"A string value representing the character that the incoming data should be padded with to get to the desired length\n\n\nIf not provided, the transform will default to a single space (\" \") character for padding\n","example":"0"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"lookup","type":"object","required":["table"],"properties":{"table":{"type":"object","additionalProperties":true,"description":"This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched\n\n\n>**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return \"Unknown Region\" for the attribute that is mapped to this transform.\n","example":{"USA":"Americas","FRA":"EMEA","AUS":"APAC","default":"Unknown Region"}},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"lower","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"nameNormalizer","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"randomAlphaNumeric","type":"object","properties":{"length":{"type":"string","description":"This is an integer value specifying the size/number of characters the random string must contain\n\n\n* This value must be a positive number and cannot be blank\n\n\n* If no length is provided, the transform will default to a value of `32`\n\n\n* Due to identity attribute data constraints, the maximum allowable value is `450` characters\n","example":"10"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"randomNumeric","type":"object","properties":{"length":{"type":"string","description":"This is an integer value specifying the size/number of characters the random string must contain\n\n\n* This value must be a positive number and cannot be blank\n\n\n* If no length is provided, the transform will default to a value of `32`\n\n\n* Due to identity attribute data constraints, the maximum allowable value is `450` characters\n","example":"10"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"reference","type":"object","required":["id"],"properties":{"id":{"type":"string","description":"This ID specifies the name of the pre-existing transform which you want to use within your current transform","example":"Existing Transform"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"replaceAll","type":"object","required":["table"],"properties":{"table":{"type":"object","additionalProperties":true,"description":"An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.","example":{"-":" ","\"":"'","ñ":"n"}},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"replace","type":"object","required":["regex","replacement"],"properties":{"regex":{"type":"string","description":"This can be a string or a regex pattern in which you want to replace.","example":"[^a-zA-Z]","externalDocs":{"description":"Regex Builder","url":"https://regex101.com/"}},"replacement":{"type":"string","description":"This is the replacement string that should be substituded wherever the string or pattern is found.","example":" "},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"rightPad","type":"object","required":["length"],"properties":{"length":{"type":"string","description":"An integer value for the desired length of the final output string","example":"4"},"padding":{"type":"string","description":"A string value representing the character that the incoming data should be padded with to get to the desired length\n\n\nIf not provided, the transform will default to a single space (\" \") character for padding\n","example":"0"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"split","type":"object","required":["delimiter","index"],"properties":{"delimiter":{"type":"string","description":"This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data","example":","},"index":{"type":"string","description":"An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.","example":"5"},"throws":{"type":"boolean","description":"A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array)\n\n\n`true` - The transform should return \"IndexOutOfBoundsException\"\n\n\n`false` - The transform should return null\n\n\nIf not provided, the transform will default to false and return a null\n","example":true},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"static","type":"object","required":["values"],"properties":{"values":{"type":"string","description":"This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.","example":"string$variable","externalDocs":{"description":"Static Transform Documentation","url":"https://developer.sailpoint.com/idn/docs/transforms/operations/static"}},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false}}},{"title":"substring","type":"object","required":["begin"],"properties":{"begin":{"type":"integer","description":"The index of the first character to include in the returned substring.\n\n\nIf `begin` is set to -1, the transform will begin at character 0 of the input data\n","example":1,"format":"int32"},"beginOffset":{"type":"integer","description":"This integer value is the number of characters to add to the begin attribute when returning a substring. \n\nThis attribute is only used if begin is not -1.\n","example":3,"format":"int32"},"end":{"type":"integer","description":"The index of the first character to exclude from the returned substring.\n\nIf end is -1 or not provided at all, the substring transform will return everything up to the end of the input string.\n","example":6,"format":"int32"},"endOffset":{"type":"integer","description":"This integer value is the number of characters to add to the end attribute when returning a substring. \n\nThis attribute is only used if end is provided and is not -1.\n","example":1,"format":"int32"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"trim","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"upper","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"uuid","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false}}}]},"internal":{"type":"boolean","readOnly":true,"description":"Indicates whether this is an internal SailPoint-created transform or a customer-created transform","example":false}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:transform:update"]}],"method":"post","path":"/transforms","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"Timestamp To Date","type":"dateFormat","attributes":{"sourceName":"Workday","attributeName":"DEPARTMENT","accountSortAttribute":"created","accountSortDescending":false,"accountReturnFirstLink":false,"accountFilter":"!(nativeIdentity.startsWith(\"*DELETED*\"))","accountPropertyFilter":"(groups.containsAll({'Admin'}) || location == 'Austin')","requiresPeriodicRefresh":false,"input":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Create transform","description":{"content":"Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. A token with transform write authority is required to call this API.","type":"text/plain"},"url":{"path":["transforms"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create transform' (create-transform)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Create transform + + + +Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. A token with transform write authority is required to call this API. + +
    Request Body required
    + +The transform to be created. + +
      attributes object required
      + +Meta-data about the transform. Values in this list are specific to the type of transform to be executed. + +
      oneOf
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      firstDate object required
      + +This is the first date to consider (The date that would be on the left hand side of the comparison operation). + +
      oneOf
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      inputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • outputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      secondDate object required
      + +This is the second date to consider (The date that would be on the right hand side of the comparison operation). + +
      oneOf
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      inputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • outputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
       secondDate |\n| GTE | Greater than or equal to: firstDate >= secondDate |\n"} schemaName={"string"} qualifierMessage={"**Possible values:** [`LT`, `LTE`, `GT`, `GTE`]"} defaultValue={undefined}>
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      inputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • outputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      table object required
      + +This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched + + +>**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. + + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      table object required
      + +An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
    + +Indicates the transform was successfully created and returns its representation. + +
    Schema
      attributes object
      + +Meta-data about the transform. Values in this list are specific to the type of transform to be executed. + +
      oneOf
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      firstDate object
      + +This is the first date to consider (The date that would be on the left hand side of the comparison operation). + +
      oneOf
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      inputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • outputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      secondDate object
      + +This is the second date to consider (The date that would be on the right hand side of the comparison operation). + +
      oneOf
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      inputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • outputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
       secondDate |\n| GTE | Greater than or equal to: firstDate >= secondDate |\n"} schemaName={"string"} qualifierMessage={"**Possible values:** [`LT`, `LTE`, `GT`, `GTE`]"} defaultValue={undefined}>
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      inputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • outputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      table object
      + +This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched + + +>**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. + + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      table object
      + +An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-access-profiles-in-bulk.api.mdx b/products/idn/api/v3/delete-access-profiles-in-bulk.api.mdx new file mode 100644 index 000000000..c88710fd8 --- /dev/null +++ b/products/idn/api/v3/delete-access-profiles-in-bulk.api.mdx @@ -0,0 +1,99 @@ +--- +id: delete-access-profiles-in-bulk +sidebar_label: Delete Access Profile(s) +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteAccessProfilesInBulk","tags":["Access Profiles"],"description":"This API initiates a bulk deletion of one or more Access Profiles.\n\nBy default, if any of the indicated Access Profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated Access Profiles will be deleted.\n\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to delete Access Profiles which are associated with Sources they are able to administer.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accessProfileIds":{"description":"List of IDs of Access Profiles to be deleted.","type":"array","items":{"type":"string"},"example":["2c9180847812e0b1017817051919ecca","2c9180887812e0b201781e129f151816"]},"bestEffortOnly":{"description":"If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use.","type":"boolean","example":true}}},"example":{"bestEffortOnly":true,"accessProfileIds":["2c91808876438bb2017668b91919ecca","2c91808876438ba801766e129f151816"]}}}},"responses":{"200":{"description":"Returned only if **bestEffortOnly** is **false**, and one or more Access Profiles are in use.","content":{"application/json":{"schema":{"type":"object","properties":{"taskId":{"type":"string","description":"ID of the task which is executing the bulk deletion. This can be passed to the **/task-status** API to track status.","example":"2c9180867817ac4d017817c491119a20"},"pending":{"type":"array","description":"List of IDs of Access Profiles which are pending deletion.","items":{"type":"string"},"example":["2c91808876438bbb017668c21919ecca","2c91808876438bb201766e129f151816"]},"inUse":{"type":"array","description":"List of usages of Access Profiles targeted for deletion.","items":{"type":"object","properties":{"accessProfileId":{"type":"string","description":"ID of the Access Profile that is in use","example":"2c91808876438bbb017668c21919ecca"},"usedBy":{"type":"array","description":"List of references to objects which are using the indicated Access Profile","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}}}}}}},"example":{"pending":[],"inUse":[{"accessProfileId":"2c91808876438ba801766e129f151816","usages":[{"type":"Role","id":"2c9180887643764201766e9f6e121518"}]}]}}}},"202":{"description":"Returned if at least one deletion will be performed.","content":{"application/json":{"schema":{"type":"object","properties":{"taskId":{"type":"string","description":"ID of the task which is executing the bulk deletion. This can be passed to the **/task-status** API to track status.","example":"2c9180867817ac4d017817c491119a20"},"pending":{"type":"array","description":"List of IDs of Access Profiles which are pending deletion.","items":{"type":"string"},"example":["2c91808876438bbb017668c21919ecca","2c91808876438bb201766e129f151816"]},"inUse":{"type":"array","description":"List of usages of Access Profiles targeted for deletion.","items":{"type":"object","properties":{"accessProfileId":{"type":"string","description":"ID of the Access Profile that is in use","example":"2c91808876438bbb017668c21919ecca"},"usedBy":{"type":"array","description":"List of references to objects which are using the indicated Access Profile","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}}}}}}},"example":{"taskId":"2c91808a7813090a01781412a1119a20","pending":["2c91808a7813090a017813fe1919ecca"],"inUse":[{"accessProfileId":"2c91808876438ba801766e129f151816","usages":[{"type":"Role","id":"2c9180887643764201766e9f6e121518"}]}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:access-profile:manage"]}],"method":"post","path":"/access-profiles/bulk-delete","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"accessProfileIds":["2c9180847812e0b1017817051919ecca","2c9180887812e0b201781e129f151816"],"bestEffortOnly":true},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete Access Profile(s)","description":{"content":"This API initiates a bulk deletion of one or more Access Profiles.\n\nBy default, if any of the indicated Access Profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated Access Profiles will be deleted.\n\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to delete Access Profiles which are associated with Sources they are able to administer.","type":"text/plain"},"url":{"path":["access-profiles","bulk-delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Access Profile(s)' (delete-access-profiles-in-bulk)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Access Profile(s) + + + +This API initiates a bulk deletion of one or more Access Profiles. + +By default, if any of the indicated Access Profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated Access Profiles will be deleted. + +A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to delete Access Profiles which are associated with Sources they are able to administer. + +
    Request Body required
    + +Returned only if **bestEffortOnly** is **false**, and one or more Access Profiles are in use. + +
    Schema
      inUse object[]
      + +List of usages of Access Profiles targeted for deletion. + +
      usedBy object[]
      + +List of references to objects which are using the indicated Access Profile + +
    + +Returned if at least one deletion will be performed. + +
    Schema
      inUse object[]
      + +List of usages of Access Profiles targeted for deletion. + +
      usedBy object[]
      + +List of references to objects which are using the indicated Access Profile + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-account.api.mdx b/products/idn/api/v3/delete-account.api.mdx new file mode 100644 index 000000000..5a56eccd4 --- /dev/null +++ b/products/idn/api/v3/delete-account.api.mdx @@ -0,0 +1,88 @@ +--- +id: delete-account +sidebar_label: Delete Account +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteAccount","tags":["Accounts"],"description":"This API submits an account delete task and returns the task ID. This operation can only be used on Flat File Sources. Any attempt to execute this request on the source of other type will result in an error response with a status code of 400.\nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:accounts:manage"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The account ID","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"202":{"description":"Async task details","content":{"application/json":{"schema":{"description":"Accounts async response containing details on started async process","required":["id"],"type":"object","properties":{"id":{"description":"id of the task","type":"string","example":"2c91808474683da6017468693c260195"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/accounts/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete Account","description":{"content":"This API submits an account delete task and returns the task ID. This operation can only be used on Flat File Sources. Any attempt to execute this request on the source of other type will result in an error response with a status code of 400.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The account ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Account' (delete-account)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Account + + + +This API submits an account delete task and returns the task ID. This operation can only be used on Flat File Sources. Any attempt to execute this request on the source of other type will result in an error response with a status code of 400. +A token with ORG_ADMIN authority is required to call this API. + +
    Path Parameters
    + +Async task details + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-lifecycle-state.api.mdx b/products/idn/api/v3/delete-lifecycle-state.api.mdx new file mode 100644 index 000000000..e0bd4c9a4 --- /dev/null +++ b/products/idn/api/v3/delete-lifecycle-state.api.mdx @@ -0,0 +1,88 @@ +--- +id: delete-lifecycle-state +sidebar_label: Delete Lifecycle State by ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteLifecycleState","tags":["Lifecycle States"],"description":"This endpoint deletes the Lifecycle State using it's ID.\nA token with API, or ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:identity-profile-lifecycle-state:manage"]}],"parameters":[{"in":"path","name":"identity-profile-id","description":"Identity Profile ID","required":true,"schema":{"type":"string"},"example":"2b838de9-db9b-abcf-e646-d4f274ad4238"},{"in":"path","name":"lifecycle-state-id","description":"Lifecycle State ID","required":true,"schema":{"type":"string"},"example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"202":{"description":"The request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete Lifecycle State by ID","description":{"content":"This endpoint deletes the Lifecycle State using it's ID.\nA token with API, or ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["identity-profiles",":identity-profile-id","lifecycle-states",":lifecycle-state-id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Identity Profile ID","type":"text/plain"},"type":"any","value":"","key":"identity-profile-id"},{"disabled":false,"description":{"content":"(Required) Lifecycle State ID","type":"text/plain"},"type":"any","value":"","key":"lifecycle-state-id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Lifecycle State by ID' (delete-lifecycle-state)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Lifecycle State by ID + + + +This endpoint deletes the Lifecycle State using it's ID. +A token with API, or ORG_ADMIN authority is required to call this API. + +
    Path Parameters
    + +The request was successfully accepted into the system. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-non-employee-record.api.mdx b/products/idn/api/v3/delete-non-employee-record.api.mdx new file mode 100644 index 000000000..203f80b11 --- /dev/null +++ b/products/idn/api/v3/delete-non-employee-record.api.mdx @@ -0,0 +1,76 @@ +--- +id: delete-non-employee-record +sidebar_label: Delete Non-Employee Record +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteNonEmployeeRecord","tags":["Non-Employee Lifecycle Management"],"description":"This request will delete a non-employee record.\nRequires role context of `idn:nesr:delete`","parameters":[{"in":"path","name":"id","description":"Non-Employee record id (UUID)","example":"ef38f94347e94562b5bb8424a56397d8","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/non-employee-records/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete Non-Employee Record","description":{"content":"This request will delete a non-employee record.\nRequires role context of `idn:nesr:delete`","type":"text/plain"},"url":{"path":["non-employee-records",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Non-Employee record id (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Non-Employee Record' (delete-non-employee-record)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Non-Employee Record + + + +This request will delete a non-employee record. +Requires role context of `idn:nesr:delete` + +
    Path Parameters
    + +No content - indicates the request was successful but there is no content to be returned in the response. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-non-employee-records-in-bulk.api.mdx b/products/idn/api/v3/delete-non-employee-records-in-bulk.api.mdx new file mode 100644 index 000000000..b7a41bff8 --- /dev/null +++ b/products/idn/api/v3/delete-non-employee-records-in-bulk.api.mdx @@ -0,0 +1,79 @@ +--- +id: delete-non-employee-records-in-bulk +sidebar_label: Delete Multiple Non-Employee Records +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteNonEmployeeRecordsInBulk","tags":["Non-Employee Lifecycle Management"],"description":"This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete`","requestBody":{"description":"Non-Employee bulk delete request body.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"List of non-employee ids.","type":"array","items":{"type":"string","format":"uuid"},"example":["2b838de9-db9b-abcf-e646-d4f274ad4238","2d838de9-db9b-abcf-e646-d4f274ad4238"]}},"required":["ids"]}}}},"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/non-employee-records/bulk-delete","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"ids":["2b838de9-db9b-abcf-e646-d4f274ad4238","2d838de9-db9b-abcf-e646-d4f274ad4238"]},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete Multiple Non-Employee Records","description":{"content":"This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete`","type":"text/plain"},"url":{"path":["non-employee-records","bulk-delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Multiple Non-Employee Records' (delete-non-employee-records-in-bulk)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Multiple Non-Employee Records + + + +This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` + +
    Request Body required
    + +Non-Employee bulk delete request body. + +
    + +No content - indicates the request was successful but there is no content to be returned in the response. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-non-employee-request.api.mdx b/products/idn/api/v3/delete-non-employee-request.api.mdx new file mode 100644 index 000000000..0b5c10cd4 --- /dev/null +++ b/products/idn/api/v3/delete-non-employee-request.api.mdx @@ -0,0 +1,88 @@ +--- +id: delete-non-employee-request +sidebar_label: Delete Non-Employee Request +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteNonEmployeeRequest","tags":["Non-Employee Lifecycle Management"],"description":"This request will delete a non-employee request. \nRequires role context of `idn:nesr:delete`","parameters":[{"in":"path","name":"id","description":"Non-Employee request id in the UUID format","required":true,"schema":{"type":"string","format":"uuid"},"example":"ac110005-7156-1150-8171-5b292e3e0084"}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/non-employee-requests/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete Non-Employee Request","description":{"content":"This request will delete a non-employee request. \nRequires role context of `idn:nesr:delete`","type":"text/plain"},"url":{"path":["non-employee-requests",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Non-Employee request id in the UUID format","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Non-Employee Request' (delete-non-employee-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Non-Employee Request + + + +This request will delete a non-employee request. +Requires role context of `idn:nesr:delete` + +
    Path Parameters
    + +No content - indicates the request was successful but there is no content to be returned in the response. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-non-employee-schema-attribute.api.mdx b/products/idn/api/v3/delete-non-employee-schema-attribute.api.mdx new file mode 100644 index 000000000..488b56c2e --- /dev/null +++ b/products/idn/api/v3/delete-non-employee-schema-attribute.api.mdx @@ -0,0 +1,77 @@ +--- +id: delete-non-employee-schema-attribute +sidebar_label: Delete a Schema Attribute for Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteNonEmployeeSchemaAttribute","tags":["Non-Employee Lifecycle Management"],"description":"This end-point deletes a specific schema attribute for a non-employee source.\nRequires role context of `idn:nesr:delete`\n","parameters":[{"in":"path","name":"attributeId","schema":{"type":"string"},"required":true,"description":"The Schema Attribute Id (UUID)","example":"ef38f94347e94562b5bb8424a56397d8"},{"in":"path","name":"sourceId","schema":{"type":"string"},"required":true,"description":"The Source id","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/non-employee-sources/{sourceId}/schema-attributes/{attributeId}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete a Schema Attribute for Non-Employee Source","description":{"content":"This end-point deletes a specific schema attribute for a non-employee source.\nRequires role context of `idn:nesr:delete`\n","type":"text/plain"},"url":{"path":["non-employee-sources",":sourceId","schema-attributes",":attributeId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Schema Attribute Id (UUID)","type":"text/plain"},"type":"any","value":"","key":"attributeId"},{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete a Schema Attribute for Non-Employee Source' (delete-non-employee-schema-attribute)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete a Schema Attribute for Non-Employee Source + + + +This end-point deletes a specific schema attribute for a non-employee source. +Requires role context of `idn:nesr:delete` + + +
    Path Parameters
    + +No content - indicates the request was successful but there is no content to be returned in the response. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-non-employee-source-schema-attributes.api.mdx b/products/idn/api/v3/delete-non-employee-source-schema-attributes.api.mdx new file mode 100644 index 000000000..6227f50a5 --- /dev/null +++ b/products/idn/api/v3/delete-non-employee-source-schema-attributes.api.mdx @@ -0,0 +1,75 @@ +--- +id: delete-non-employee-source-schema-attributes +sidebar_label: Delete all custom schema attributes for Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteNonEmployeeSourceSchemaAttributes","tags":["Non-Employee Lifecycle Management"],"description":"This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete`","parameters":[{"in":"path","name":"sourceId","schema":{"type":"string"},"required":true,"description":"The Source id","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/non-employee-sources/{sourceId}/schema-attributes","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete all custom schema attributes for Non-Employee Source","description":{"content":"This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete`","type":"text/plain"},"url":{"path":["non-employee-sources",":sourceId","schema-attributes"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete all custom schema attributes for Non-Employee Source' (delete-non-employee-source-schema-attributes)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete all custom schema attributes for Non-Employee Source + + + +This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` + +
    Path Parameters
    + +No content - indicates the request was successful but there is no content to be returned in the response. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-non-employee-source.api.mdx b/products/idn/api/v3/delete-non-employee-source.api.mdx new file mode 100644 index 000000000..6037b5d38 --- /dev/null +++ b/products/idn/api/v3/delete-non-employee-source.api.mdx @@ -0,0 +1,75 @@ +--- +id: delete-non-employee-source +sidebar_label: Delete Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteNonEmployeeSource","tags":["Non-Employee Lifecycle Management"],"description":"This request will delete a non-employee source. Requires role context of `idn:nesr:delete`.","parameters":[{"in":"path","name":"sourceId","description":"Source Id","required":true,"schema":{"type":"string"},"example":"e136567de87e4d029e60b3c3c55db56d"}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/non-employee-sources/{sourceId}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete Non-Employee Source","description":{"content":"This request will delete a non-employee source. Requires role context of `idn:nesr:delete`.","type":"text/plain"},"url":{"path":["non-employee-sources",":sourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Source Id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Non-Employee Source' (delete-non-employee-source)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Non-Employee Source + + + +This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. + +
    Path Parameters
    + +No content - indicates the request was successful but there is no content to be returned in the response. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-oauth-client.api.mdx b/products/idn/api/v3/delete-oauth-client.api.mdx new file mode 100644 index 000000000..25b768561 --- /dev/null +++ b/products/idn/api/v3/delete-oauth-client.api.mdx @@ -0,0 +1,87 @@ +--- +id: delete-oauth-client +sidebar_label: Delete OAuth Client +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteOauthClient","security":[{"oauth2":["sp:oauth-client:manage"]}],"tags":["OAuth Clients"],"description":"This deletes an OAuth client.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The OAuth client id","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"204":{"description":"No content."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/oauth-clients/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete OAuth Client","description":{"content":"This deletes an OAuth client.","type":"text/plain"},"url":{"path":["oauth-clients",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The OAuth client id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete OAuth Client' (delete-oauth-client)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete OAuth Client + + + +This deletes an OAuth client. + +
    Path Parameters
    + +No content. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-password-sync-group.api.mdx b/products/idn/api/v3/delete-password-sync-group.api.mdx new file mode 100644 index 000000000..a116e39a3 --- /dev/null +++ b/products/idn/api/v3/delete-password-sync-group.api.mdx @@ -0,0 +1,75 @@ +--- +id: delete-password-sync-group +sidebar_label: Delete Password Sync Group by ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deletePasswordSyncGroup","tags":["Password Sync Groups"],"description":"This API deletes the specified password sync group. A token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:password-sync-group-management:write"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of password sync group to delete.","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/password-sync-groups/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete Password Sync Group by ID","description":{"content":"This API deletes the specified password sync group. A token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["password-sync-groups",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of password sync group to delete.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Password Sync Group by ID' (delete-password-sync-group)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Password Sync Group by ID + + + +This API deletes the specified password sync group. A token with ORG_ADMIN authority is required to call this API. + +
    Path Parameters
    + +No content - indicates the request was successful but there is no content to be returned in the response. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-personal-access-token.api.mdx b/products/idn/api/v3/delete-personal-access-token.api.mdx new file mode 100644 index 000000000..2cc2ab41a --- /dev/null +++ b/products/idn/api/v3/delete-personal-access-token.api.mdx @@ -0,0 +1,87 @@ +--- +id: delete-personal-access-token +sidebar_label: Delete Personal Access Token +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deletePersonalAccessToken","security":[{"oauth2":["sp:my-personal-access-tokens:manage","sp:all-personal-access-tokens:manage"]}],"tags":["Personal Access Tokens"],"description":"This deletes a personal access token.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The personal access token id","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"204":{"description":"No content."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/personal-access-tokens/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete Personal Access Token","description":{"content":"This deletes a personal access token.","type":"text/plain"},"url":{"path":["personal-access-tokens",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The personal access token id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Personal Access Token' (delete-personal-access-token)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Personal Access Token + + + +This deletes a personal access token. + +
    Path Parameters
    + +No content. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-provisioning-policy.api.mdx b/products/idn/api/v3/delete-provisioning-policy.api.mdx new file mode 100644 index 000000000..5a471a413 --- /dev/null +++ b/products/idn/api/v3/delete-provisioning-policy.api.mdx @@ -0,0 +1,88 @@ +--- +id: delete-provisioning-policy +sidebar_label: Delete Provisioning Policy by UsageType +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteProvisioningPolicy","tags":["Sources"],"description":"Deletes the provisioning policy with the specified usage on an application.\nA token with API, or ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:provisioning-policy:manage"]}],"parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source ID.","example":"2c9180835d191a86015d28455b4a2329"},{"in":"path","name":"usageType","required":true,"schema":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"description":"The type of ProvisioningPolicy usage."}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/sources/{sourceId}/provisioning-policies/{usageType}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete Provisioning Policy by UsageType","description":{"content":"Deletes the provisioning policy with the specified usage on an application.\nA token with API, or ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":sourceId","provisioning-policies",":usageType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source ID.","type":"text/plain"},"type":"any","value":"","key":"sourceId"},{"disabled":false,"description":{"content":"(Required) The type of ProvisioningPolicy usage.","type":"text/plain"},"type":"any","value":"","key":"usageType"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Provisioning Policy by UsageType' (delete-provisioning-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Provisioning Policy by UsageType + + + +Deletes the provisioning policy with the specified usage on an application. +A token with API, or ORG_ADMIN authority is required to call this API. + +
    Path Parameters
    + +No content - indicates the request was successful but there is no content to be returned in the response. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-saved-search.api.mdx b/products/idn/api/v3/delete-saved-search.api.mdx new file mode 100644 index 000000000..56a030de6 --- /dev/null +++ b/products/idn/api/v3/delete-saved-search.api.mdx @@ -0,0 +1,88 @@ +--- +id: delete-saved-search +sidebar_label: Delete document by ID +hide_title: true +hide_table_of_contents: true +api: {"tags":["Saved Search"],"description":"Deletes the specified saved search.\n","operationId":"deleteSavedSearch","parameters":[{"in":"path","name":"id","description":"ID of the requested document.","schema":{"type":"string"},"required":true,"example":"2c91808568c529c60168cca6f90c1313"}],"responses":{"204":{"description":"No Content - Indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/saved-searches/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete document by ID","description":{"content":"Deletes the specified saved search.\n","type":"text/plain"},"url":{"path":["saved-searches",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the requested document.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete document by ID' (delete-saved-search)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete document by ID + + + +Deletes the specified saved search. + + +
    Path Parameters
    + +No Content - Indicates the request was successful but there is no content to be returned in the response. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-scheduled-search.api.mdx b/products/idn/api/v3/delete-scheduled-search.api.mdx new file mode 100644 index 000000000..f408dd422 --- /dev/null +++ b/products/idn/api/v3/delete-scheduled-search.api.mdx @@ -0,0 +1,88 @@ +--- +id: delete-scheduled-search +sidebar_label: Delete a Scheduled Search +hide_title: true +hide_table_of_contents: true +api: {"tags":["Scheduled Search"],"description":"Deletes the specified scheduled search.\n","operationId":"deleteScheduledSearch","parameters":[{"in":"path","name":"id","description":"ID of the requested document.","schema":{"type":"string"},"required":true,"example":"2c91808568c529c60168cca6f90c1313"}],"responses":{"204":{"description":"No Content - Indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/scheduled-searches/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete a Scheduled Search","description":{"content":"Deletes the specified scheduled search.\n","type":"text/plain"},"url":{"path":["scheduled-searches",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the requested document.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete a Scheduled Search' (delete-scheduled-search)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete a Scheduled Search + + + +Deletes the specified scheduled search. + + +
    Path Parameters
    + +No Content - Indicates the request was successful but there is no content to be returned in the response. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-segment.api.mdx b/products/idn/api/v3/delete-segment.api.mdx new file mode 100644 index 000000000..48d3fb6e0 --- /dev/null +++ b/products/idn/api/v3/delete-segment.api.mdx @@ -0,0 +1,91 @@ +--- +id: delete-segment +sidebar_label: Delete Segment by ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteSegment","security":[{"oauth2":["idn:segment:manage"]}],"tags":["Segments"],"description":"This API deletes the segment specified by the given ID.\n\nNote that segment deletion may take some time to become effective.\n\nA token with ORG_ADMIN or API authority is required to call this API.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the Segment to delete.","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"204":{"description":"No content."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/segments/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete Segment by ID","description":{"content":"This API deletes the segment specified by the given ID.\n\nNote that segment deletion may take some time to become effective.\n\nA token with ORG_ADMIN or API authority is required to call this API.","type":"text/plain"},"url":{"path":["segments",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the Segment to delete.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Segment by ID' (delete-segment)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Segment by ID + + + +This API deletes the segment specified by the given ID. + +Note that segment deletion may take some time to become effective. + +A token with ORG_ADMIN or API authority is required to call this API. + +
    Path Parameters
    + +No content. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-service-desk-integration.api.mdx b/products/idn/api/v3/delete-service-desk-integration.api.mdx new file mode 100644 index 000000000..0f8762b8b --- /dev/null +++ b/products/idn/api/v3/delete-service-desk-integration.api.mdx @@ -0,0 +1,87 @@ +--- +id: delete-service-desk-integration +sidebar_label: Delete a Service Desk integration +hide_title: true +hide_table_of_contents: true +api: {"tags":["Service Desk Integration"],"description":"Delete an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","operationId":"deleteServiceDeskIntegration","parameters":[{"name":"id","in":"path","description":"ID of Service Desk integration to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"anId"}}],"responses":{"204":{"description":"Service Desk integration with the given ID successfully deleted"},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:service-desk-admin:manage","idn:service-desk-integration:manage"]}],"method":"delete","path":"/service-desk-integrations/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete a Service Desk integration","description":{"content":"Delete an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","type":"text/plain"},"url":{"path":["service-desk-integrations",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of Service Desk integration to delete","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete a Service Desk integration' (delete-service-desk-integration)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete a Service Desk integration + + + +Delete an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +
    Path Parameters
    + +Service Desk integration with the given ID successfully deleted + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-sod-policy-schedule.api.mdx b/products/idn/api/v3/delete-sod-policy-schedule.api.mdx new file mode 100644 index 000000000..45ea59f28 --- /dev/null +++ b/products/idn/api/v3/delete-sod-policy-schedule.api.mdx @@ -0,0 +1,87 @@ +--- +id: delete-sod-policy-schedule +sidebar_label: Delete SOD policy schedule +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:sod-policy:write"]}],"operationId":"deleteSodPolicySchedule","tags":["SOD Policy"],"description":"This deletes schedule for a specified SOD policy by ID.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the SOD policy the schedule must be deleted for.","example":"ef38f943-47e9-4562-b5bb-8424a56397d8"}],"responses":{"204":{"description":"No content response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/sod-policies/{id}/schedule","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete SOD policy schedule","description":{"content":"This deletes schedule for a specified SOD policy by ID.","type":"text/plain"},"url":{"path":["sod-policies",":id","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the SOD policy the schedule must be deleted for.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete SOD policy schedule' (delete-sod-policy-schedule)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete SOD policy schedule + + + +This deletes schedule for a specified SOD policy by ID. + +
    Path Parameters
    + +No content response. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-sod-policy.api.mdx b/products/idn/api/v3/delete-sod-policy.api.mdx new file mode 100644 index 000000000..7ab9a69f8 --- /dev/null +++ b/products/idn/api/v3/delete-sod-policy.api.mdx @@ -0,0 +1,88 @@ +--- +id: delete-sod-policy +sidebar_label: Delete SOD policy by ID +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:sod-policy:write"]}],"operationId":"deleteSodPolicy","tags":["SOD Policy"],"description":"This deletes a specified SOD policy.\nRequires role of ORG_ADMIN.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the SOD Policy to delete.","example":"ef38f943-47e9-4562-b5bb-8424a56397d8"},{"in":"query","name":"logical","schema":{"type":"boolean","default":true},"description":"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.","example":true,"required":false}],"responses":{"204":{"description":"No content."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/sod-policies/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete SOD policy by ID","description":{"content":"This deletes a specified SOD policy.\nRequires role of ORG_ADMIN.","type":"text/plain"},"url":{"path":["sod-policies",":id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"logical","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the SOD Policy to delete.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete SOD policy by ID' (delete-sod-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete SOD policy by ID + + + +This deletes a specified SOD policy. +Requires role of ORG_ADMIN. + +
    Path Parameters
    Query Parameters
    + +No content. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-source-schema.api.mdx b/products/idn/api/v3/delete-source-schema.api.mdx new file mode 100644 index 000000000..ab43d351d --- /dev/null +++ b/products/idn/api/v3/delete-source-schema.api.mdx @@ -0,0 +1,87 @@ +--- +id: delete-source-schema +sidebar_label: Delete Source Schema by ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteSourceSchema","tags":["Sources"],"parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source id.","example":"2c9180835d191a86015d28455b4a2329"},{"in":"path","name":"schemaId","schema":{"type":"string"},"required":true,"description":"The Schema id.","example":"2c9180835d191a86015d28455b4a2329"}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"description":"Delete Source Schema by ID","method":"delete","path":"/sources/{sourceId}/schemas/{schemaId}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete Source Schema by ID","description":{"type":"text/plain"},"url":{"path":["sources",":sourceId","schemas",":schemaId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id.","type":"text/plain"},"type":"any","value":"","key":"sourceId"},{"disabled":false,"description":{"content":"(Required) The Schema id.","type":"text/plain"},"type":"any","value":"","key":"schemaId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Source Schema by ID' (delete-source-schema)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Source Schema by ID + + + +Delete Source Schema by ID + +
    Path Parameters
    + +No content - indicates the request was successful but there is no content to be returned in the response. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-source.api.mdx b/products/idn/api/v3/delete-source.api.mdx new file mode 100644 index 000000000..32969c493 --- /dev/null +++ b/products/idn/api/v3/delete-source.api.mdx @@ -0,0 +1,89 @@ +--- +id: delete-source +sidebar_label: Delete Source by ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteSource","security":[{"oauth2":["idn:sources:manage"]}],"tags":["Sources"],"description":"This end-point deletes a specific source in IdentityNow.\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.\nAll of accounts on the source will be removed first, then the source will be deleted. Actual status of task execution can be retrieved via method GET `/task-status/{id}`","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Source id","example":"2c9180835d191a86015d28455b4a2329"}],"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["TASK_RESULT"],"example":"TASK_RESULT"},"id":{"type":"string","description":"ID of the task result","example":"2c91808779ecf55b0179f720942f181a"},"name":{"type":"string","description":"Human-readable display name of the task result (should be null/empty)","example":null}}},"examples":{"deleteSource":{"summary":"Response returned when deleting a source","value":{"type":"TASK_RESULT","id":"2c91808779ecf55b0179f720942f181a","name":null}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/sources/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete Source by ID","description":{"content":"This end-point deletes a specific source in IdentityNow.\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.\nAll of accounts on the source will be removed first, then the source will be deleted. Actual status of task execution can be retrieved via method GET `/task-status/{id}`","type":"text/plain"},"url":{"path":["sources",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Source by ID' (delete-source)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Source by ID + + + +This end-point deletes a specific source in IdentityNow. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. +All of accounts on the source will be removed first, then the source will be deleted. Actual status of task execution can be retrieved via method GET `/task-status/{id}` + +
    Path Parameters
    + +Accepted - Returned if the request was successfully accepted into the system. + +
    Schema

    Response returned when deleting a source

    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-tagged-object.api.mdx b/products/idn/api/v3/delete-tagged-object.api.mdx new file mode 100644 index 000000000..a89c8f225 --- /dev/null +++ b/products/idn/api/v3/delete-tagged-object.api.mdx @@ -0,0 +1,75 @@ +--- +id: delete-tagged-object +sidebar_label: Delete Tagged Object +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteTaggedObject","security":[{"oauth2":["idn:tag:manage"]}],"tags":["Tagged Objects"],"description":"This deletes a tagged object for the specified type.","parameters":[{"in":"path","name":"type","schema":{"type":"string","enum":["ROLE","IDENTITY","SOD_POLICY"]},"required":true,"description":"The type of tagged object to delete.","example":"ROLE"},{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the object reference to delete.","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"204":{"description":"No content."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"delete","path":"/tagged-objects/{type}/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete Tagged Object","description":{"content":"This deletes a tagged object for the specified type.","type":"text/plain"},"url":{"path":["tagged-objects",":type",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The type of tagged object to delete.","type":"text/plain"},"type":"any","value":"","key":"type"},{"disabled":false,"description":{"content":"(Required) The ID of the object reference to delete.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Tagged Object' (delete-tagged-object)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete Tagged Object + + + +This deletes a tagged object for the specified type. + +
    Path Parameters
    + +No content. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-tags-to-many-object.api.mdx b/products/idn/api/v3/delete-tags-to-many-object.api.mdx new file mode 100644 index 000000000..c5d48e975 --- /dev/null +++ b/products/idn/api/v3/delete-tags-to-many-object.api.mdx @@ -0,0 +1,81 @@ +--- +id: delete-tags-to-many-object +sidebar_label: Remove Tags from Multiple Objects +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteTagsToManyObject","security":[{"oauth2":["idn:tag:manage"]}],"tags":["Tagged Objects"],"description":"This API removes tags from multiple objects.\n\nA token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","requestBody":{"description":"Supported object types are ROLE, IDENTITY and SOD_POLICY.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"objectRefs":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","nullable":true,"description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}},"tags":{"type":"array","items":{"type":"string"},"description":"Label to be applied to an Object","example":["BU_FINANCE","PCI"]},"operation":{"type":"string","enum":["APPEND","MERGE"],"default":"APPEND","description":"If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object.\n\nIf MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored.","example":"MERGE"}}}}}},"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/tagged-objects/bulk-remove","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"objectRefs":[{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"}],"tags":["BU_FINANCE","PCI"],"operation":"MERGE"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Remove Tags from Multiple Objects","description":{"content":"This API removes tags from multiple objects.\n\nA token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["tagged-objects","bulk-remove"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Remove Tags from Multiple Objects' (delete-tags-to-many-object)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Remove Tags from Multiple Objects + + + +This API removes tags from multiple objects. + +A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +
    Request Body required
    + +Supported object types are ROLE, IDENTITY and SOD_POLICY. + +
      objectRefs object[]
    + +No content - indicates the request was successful but there is no content to be returned in the response. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/delete-transform.api.mdx b/products/idn/api/v3/delete-transform.api.mdx new file mode 100644 index 000000000..8ef68fe66 --- /dev/null +++ b/products/idn/api/v3/delete-transform.api.mdx @@ -0,0 +1,88 @@ +--- +id: delete-transform +sidebar_label: Delete a transform +hide_title: true +hide_table_of_contents: true +api: {"tags":["Transforms"],"description":"Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform.\nA token with transform delete authority is required to call this API.","operationId":"deleteTransform","parameters":[{"name":"id","in":"path","description":"ID of the transform to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"2cd78adghjkja34jh2b1hkjhasuecd"}],"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:transform:manage"]}],"method":"delete","path":"/transforms/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Delete a transform","description":{"content":"Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform.\nA token with transform delete authority is required to call this API.","type":"text/plain"},"url":{"path":["transforms",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the transform to delete","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "delete api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete a transform' (delete-transform)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Delete a transform + + + +Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. +A token with transform delete authority is required to call this API. + +
    Path Parameters
    + +No content - indicates the request was successful but there is no content to be returned in the response. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/disable-account.api.mdx b/products/idn/api/v3/disable-account.api.mdx new file mode 100644 index 000000000..fc9e5bb41 --- /dev/null +++ b/products/idn/api/v3/disable-account.api.mdx @@ -0,0 +1,88 @@ +--- +id: disable-account +sidebar_label: Disable Account +hide_title: true +hide_table_of_contents: true +api: {"operationId":"disableAccount","tags":["Accounts"],"description":"This API submits a task to disable the account and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:accounts-state:manage"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The account id","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"Request used for account enable/disable","type":"object","properties":{"externalVerificationId":{"description":"If set, an external process validates that the user wants to proceed with this request.","type":"string","example":"3f9180835d2e5168015d32f890ca1581"},"forceProvisioning":{"description":"If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. Providing 'true' for an unlocked account will add and process 'Unlock' operation by the workflow.","type":"boolean","example":false}}}}}},"responses":{"202":{"description":"Async task details","content":{"application/json":{"schema":{"description":"Accounts async response containing details on started async process","required":["id"],"type":"object","properties":{"id":{"description":"id of the task","type":"string","example":"2c91808474683da6017468693c260195"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/accounts/{id}/disable","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"externalVerificationId":"3f9180835d2e5168015d32f890ca1581","forceProvisioning":false},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Disable Account","description":{"content":"This API submits a task to disable the account and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts",":id","disable"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The account id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Disable Account' (disable-account)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Disable Account + + + +This API submits a task to disable the account and returns the task ID. +A token with ORG_ADMIN authority is required to call this API. + +
    Path Parameters
    Request Body required
    + +Async task details + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/enable-account.api.mdx b/products/idn/api/v3/enable-account.api.mdx new file mode 100644 index 000000000..e817ddc8c --- /dev/null +++ b/products/idn/api/v3/enable-account.api.mdx @@ -0,0 +1,88 @@ +--- +id: enable-account +sidebar_label: Enable Account +hide_title: true +hide_table_of_contents: true +api: {"operationId":"enableAccount","tags":["Accounts"],"description":"This API submits a task to enable account and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:accounts-state:manage"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The account id","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"Request used for account enable/disable","type":"object","properties":{"externalVerificationId":{"description":"If set, an external process validates that the user wants to proceed with this request.","type":"string","example":"3f9180835d2e5168015d32f890ca1581"},"forceProvisioning":{"description":"If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. Providing 'true' for an unlocked account will add and process 'Unlock' operation by the workflow.","type":"boolean","example":false}}}}}},"responses":{"202":{"description":"Async task details","content":{"application/json":{"schema":{"description":"Accounts async response containing details on started async process","required":["id"],"type":"object","properties":{"id":{"description":"id of the task","type":"string","example":"2c91808474683da6017468693c260195"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/accounts/{id}/enable","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"externalVerificationId":"3f9180835d2e5168015d32f890ca1581","forceProvisioning":false},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Enable Account","description":{"content":"This API submits a task to enable account and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts",":id","enable"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The account id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Enable Account' (enable-account)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Enable Account + + + +This API submits a task to enable account and returns the task ID. +A token with ORG_ADMIN authority is required to call this API. + +
    Path Parameters
    Request Body required
    + +Async task details + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/execute-saved-search.api.mdx b/products/idn/api/v3/execute-saved-search.api.mdx new file mode 100644 index 000000000..822e2130c --- /dev/null +++ b/products/idn/api/v3/execute-saved-search.api.mdx @@ -0,0 +1,105 @@ +--- +id: execute-saved-search +sidebar_label: Execute a saved search by ID +hide_title: true +hide_table_of_contents: true +api: {"tags":["Saved Search"],"description":"Executes the specified saved search.\n","operationId":"executeSavedSearch","parameters":[{"in":"path","name":"id","description":"ID of the requested document.","schema":{"type":"string"},"required":true,"example":"2c91808568c529c60168cca6f90c1313"}],"requestBody":{"description":"When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search.\n\nIf *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided.\n","content":{"application/json":{"schema":{"type":"object","properties":{"scheduleId":{"description":"The ID of the scheduled search that triggered the saved search execution.\n","type":"string","example":"7a724640-0c17-4ce9-a8c3-4a89738459c8"},"owner":{"description":"The owner of the scheduled search being tested.\n","allOf":[{"type":"object","description":"A typed reference to the object.\n","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"description":"The id of the object.\n","type":"string","example":"2c91808568c529c60168cca6f90c1313"}},"required":["type","id"]}]},"recipients":{"description":"The email recipients of the scheduled search being tested.\n","type":"array","items":{"type":"object","description":"A typed reference to the object.\n","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"description":"The id of the object.\n","type":"string","example":"2c91808568c529c60168cca6f90c1313"}},"required":["type","id"]}}}},"examples":{"scheduled":{"summary":"Triggered by Scheduled Search","value":{"scheduleId":"7a724640-0c17-4ce9-a8c3-4a89738459c8"}},"test":{"summary":"Triggered by UI Test","value":{"owner":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313"},"recipients":[{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313"}]}}}}},"required":true},"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/saved-searches/{id}/execute","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"scheduleId":"7a724640-0c17-4ce9-a8c3-4a89738459c8","owner":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313"},"recipients":[{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313"}]},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Execute a saved search by ID","description":{"content":"Executes the specified saved search.\n","type":"text/plain"},"url":{"path":["saved-searches",":id","execute"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the requested document.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Execute a saved search by ID' (execute-saved-search)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Execute a saved search by ID + + + +Executes the specified saved search. + + +
    Path Parameters
    Request Body required
    + +When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. + +If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. + + +
      owner object
      + +A typed reference to the object. + + +
      recipients object[]
      + +The email recipients of the scheduled search being tested. + + +
    + +Accepted - Returned if the request was successfully accepted into the system. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/export-identity-profiles.api.mdx b/products/idn/api/v3/export-identity-profiles.api.mdx new file mode 100644 index 000000000..9b94f42cf --- /dev/null +++ b/products/idn/api/v3/export-identity-profiles.api.mdx @@ -0,0 +1,91 @@ +--- +id: export-identity-profiles +sidebar_label: Export Identity Profiles +hide_title: true +hide_table_of_contents: true +api: {"operationId":"exportIdentityProfiles","tags":["Identity Profiles"],"description":"This exports existing identity profiles in the format specified by the sp-config service.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"example":"id eq \"ef38f94347e94562b5bb8424a56397d8\"","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, ne*\n\n**name**: *eq, ne*\n\n**priority**: *eq, ne*"},{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"example":"id,name","description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **id**, **name**, **priority**"}],"responses":{"200":{"description":"List of export objects with identity profiles.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Identity Profile exported object","properties":{"version":{"type":"integer","example":1,"description":"Version or object from the target service.","format":"int32"},"self":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"object":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true},"modified":{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}},{"type":"object","required":["authoritativeSource"],"properties":{"description":{"type":"string","description":"The description of the Identity Profile.","example":"My custom flat file profile","nullable":true},"owner":{"type":"object","description":"The owner of the Identity Profile.","nullable":true,"properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Type of the object to which this reference applies","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"priority":{"type":"integer","format":"int64","description":"The priority for an Identity Profile.","example":10},"authoritativeSource":{"type":"object","properties":{"type":{"type":"string","enum":["SOURCE"],"description":"Type of the object to which this reference applies","example":"SOURCE"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"HR Active Directory"}}},"identityRefreshRequired":{"type":"boolean","default":false,"description":"True if a identity refresh is needed. Typically triggered when a change on the source has been made.","example":true},"identityCount":{"type":"integer","description":"The number of identities that belong to the Identity Profile.","format":"int32","example":8},"identityAttributeConfig":{"type":"object","description":"Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process.","properties":{"enabled":{"description":"The backend will only promote values if the profile/mapping is enabled.","type":"boolean","default":false,"example":true},"attributeTransforms":{"type":"array","items":{"type":"object","description":"Defines a transformation definition for an identity attribute.","properties":{"identityAttributeName":{"type":"string","description":"Name of the identity attribute.","example":"email"},"transformDefinition":{"description":"The seaspray transformation definition.","type":"object","properties":{"type":{"type":"string","description":"The type of the transform definition.","example":"accountAttribute"},"attributes":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"object"}]},"description":"Arbitrary key-value pairs to store any metadata for the object","example":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}}}}}}}}},"identityExceptionReportReference":{"type":"object","nullable":true,"properties":{"taskResultId":{"type":"string","format":"uuid","description":"The id of the task result.","example":"2b838de9-db9b-abcf-e646-d4f274ad4238"},"reportName":{"type":"string","example":"My annual report","description":"The name of the report."}}},"hasTimeBasedAttr":{"description":"Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile.","type":"boolean","default":false,"example":true}}}]}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:identity-profile:read"]}],"method":"get","path":"/identity-profiles/export","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Export Identity Profiles","description":{"content":"This exports existing identity profiles in the format specified by the sp-config service.","type":"text/plain"},"url":{"path":["identity-profiles","export"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, ne*\n\n**name**: *eq, ne*\n\n**priority**: *eq, ne*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **id**, **name**, **priority**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Export Identity Profiles' (export-identity-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Export Identity Profiles + + + +This exports existing identity profiles in the format specified by the sp-config service. + +
    Query Parameters
    + +List of export objects with identity profiles. + +
    Schema array
      self object
      object object
      owner object
      + +The owner of the Identity Profile. + +
      authoritativeSource object
      identityAttributeConfig object
      + +Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. + +
      attributeTransforms object[]
      transformDefinition object
      + +The seaspray transformation definition. + +
      attributes object
      + +Arbitrary key-value pairs to store any metadata for the object + +
      identityExceptionReportReference object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/export-non-employee-records.api.mdx b/products/idn/api/v3/export-non-employee-records.api.mdx new file mode 100644 index 000000000..45d8ef72a --- /dev/null +++ b/products/idn/api/v3/export-non-employee-records.api.mdx @@ -0,0 +1,87 @@ +--- +id: export-non-employee-records +sidebar_label: Exports Non-Employee Records to CSV +hide_title: true +hide_table_of_contents: true +api: {"operationId":"exportNonEmployeeRecords","tags":["Non-Employee Lifecycle Management"],"description":"This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read`","parameters":[{"in":"path","name":"id","description":"Source Id (UUID)","required":true,"schema":{"type":"string"},"example":"e136567de87e4d029e60b3c3c55db56d"}],"responses":{"200":{"description":"Exported CSV","content":{"text/csv":{"example":"accountName,firstName,lastName,phone,email,manager,startDate,endDate\nJon.Smith, Jon, Smith, 555-555-5555, jon@jon.doe.nope.com, Jim Smith, 2020-04-05T08:00:00-10:00,2020-08-07T19:00:00-10:00\nWilliam.Chaffin, William, Chaffin, 555-555-5555, william@chaffins.nope.com, Bertram Chaffin, 2020-04-05T08:00:00-10:00,2020-08-07T19:00:00-10:00\n"}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-sources/{id}/non-employees/download","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Exports Non-Employee Records to CSV","description":{"content":"This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read`","type":"text/plain"},"url":{"path":["non-employee-sources",":id","non-employees","download"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Source Id (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"text/csv"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Exports Non-Employee Records to CSV' (export-non-employee-records)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Exports Non-Employee Records to CSV + + + +This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` + +
    Path Parameters
    + +Exported CSV + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/export-non-employee-source-schema-template.api.mdx b/products/idn/api/v3/export-non-employee-source-schema-template.api.mdx new file mode 100644 index 000000000..ce07b794b --- /dev/null +++ b/products/idn/api/v3/export-non-employee-source-schema-template.api.mdx @@ -0,0 +1,87 @@ +--- +id: export-non-employee-source-schema-template +sidebar_label: Exports Source Schema Template +hide_title: true +hide_table_of_contents: true +api: {"operationId":"exportNonEmployeeSourceSchemaTemplate","tags":["Non-Employee Lifecycle Management"],"description":"This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read`","parameters":[{"in":"path","name":"id","description":"Source Id (UUID)","required":true,"example":"ef38f94347e94562b5bb8424a56397d8","schema":{"type":"string"}}],"responses":{"200":{"description":"Exported Source Schema Template","content":{"text/csv":{"example":"accountName,firstName,lastName,phone,email,manager,startDate,endDate\n"}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-sources/{id}/schema-attributes-template/download","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Exports Source Schema Template","description":{"content":"This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read`","type":"text/plain"},"url":{"path":["non-employee-sources",":id","schema-attributes-template","download"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Source Id (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"text/csv"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Exports Source Schema Template' (export-non-employee-source-schema-template)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Exports Source Schema Template + + + +This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` + +
    Path Parameters
    + +Exported Source Schema Template + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/forward-access-request.api.mdx b/products/idn/api/v3/forward-access-request.api.mdx new file mode 100644 index 000000000..9972cc46d --- /dev/null +++ b/products/idn/api/v3/forward-access-request.api.mdx @@ -0,0 +1,91 @@ +--- +id: forward-access-request +sidebar_label: Forwards an access request approval. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"forwardAccessRequest","tags":["Access Request Approvals"],"description":"This endpoint forwards an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.","parameters":[{"in":"path","name":"approvalId","schema":{"type":"string"},"required":true,"description":"The id of the approval.","example":"2c91808b7294bea301729568c68c002e"}],"requestBody":{"description":"Information about the forwarded approval.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["newOwnerId","comment"],"properties":{"newOwnerId":{"type":"string","description":"The Id of the new owner","example":"2c91808568c529c60168cca6f90c1314","minLength":1,"maxLength":255},"comment":{"type":"string","description":"The comment provided by the forwarder","example":"2c91808568c529c60168cca6f90c1313","minLength":1,"maxLength":255}}}}}},"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/access-request-approvals/{approvalId}/forward","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"newOwnerId":"2c91808568c529c60168cca6f90c1314","comment":"2c91808568c529c60168cca6f90c1313"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Forwards an access request approval.","description":{"content":"This endpoint forwards an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.","type":"text/plain"},"url":{"path":["access-request-approvals",":approvalId","forward"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The id of the approval.","type":"text/plain"},"type":"any","value":"","key":"approvalId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Forwards an access request approval.' (forward-access-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Forwards an access request approval. + + + +This endpoint forwards an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +
    Path Parameters
    Request Body required
    + +Information about the forwarded approval. + +
    + +Accepted - Returned if the request was successfully accepted into the system. + +
    Schema
    • object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-access-profile-entitlements.api.mdx b/products/idn/api/v3/get-access-profile-entitlements.api.mdx new file mode 100644 index 000000000..f01cc6659 --- /dev/null +++ b/products/idn/api/v3/get-access-profile-entitlements.api.mdx @@ -0,0 +1,81 @@ +--- +id: get-access-profile-entitlements +sidebar_label: List Access Profile's Entitlements +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAccessProfileEntitlements","tags":["Access Profiles"],"description":"This API lists the Entitlements associated with a given Access Profile\n\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a token with SOURCE_SUBADMIN authority must have access to the Source associated with the given Access Profile","parameters":[{"name":"id","in":"path","description":"ID of the containing Access Profile","required":true,"schema":{"type":"string","example":"2c91808a7813090a017814121919ecca"}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following Entitlement fields and operators:\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**attribute**: *eq, sw*\n\n**value**: *eq, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**source.id**: *eq, in*","example":"attribute eq \"memberOf\"","required":false},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name, attribute, value, created, modified**","example":"name,-modified","required":false}],"responses":{"200":{"description":"List of Entitlements","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The entitlement id","example":"2c91808874ff91550175097daaec161c"},"name":{"type":"string","description":"The entitlement name","example":"LauncherTest2"},"attribute":{"type":"string","description":"The entitlement attribute name","example":"memberOf"},"value":{"type":"string","description":"The value of the entitlement","example":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local"},"sourceSchemaObjectType":{"type":"string","description":"The object type of the entitlement from the source schema","example":"group"},"description":{"type":"string","description":"The description of the entitlement","example":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local"},"privileged":{"type":"boolean","description":"True if the entitlement is privileged","example":true},"cloudGoverned":{"type":"boolean","description":"True if the entitlement is cloud governed","example":true},"created":{"type":"string","description":"Time when the entitlement was created","format":"date-time","example":"2020-10-08T18:33:52.029Z"},"modified":{"type":"string","description":"Time when the entitlement was last modified","format":"date-time","example":"2020-10-08T18:33:52.029Z"},"source":{"type":"object","properties":{"id":{"type":"string","description":"The source ID","example":"2c9180827ca885d7017ca8ce28a000eb"},"type":{"type":"string","description":"The source type, will always be \"SOURCE\"","example":"SOURCE"},"name":{"type":"string","description":"The source name","example":"ODS-AD-Source"}}},"attributes":{"type":"object","description":"A map of free-form key-value pairs from the source system","example":{"fieldName":"fieldValue"},"additionalProperties":true},"segments":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of IDs of segments, if any, to which this Entitlement is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]},"directPermissions":{"type":"array","items":{"type":"object","description":"Simplified DTO for the Permission objects stored in SailPoint's database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers.","properties":{"rights":{"type":"array","description":"All the rights (e.g. actions) that this permission allows on the target","readOnly":true,"items":{"type":"string","example":"SELECT"}},"target":{"type":"string","description":"The target the permission would grants rights on.","readOnly":true,"example":"SYS.GV_$TRANSACTION"}}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:access-profile:read"]}],"method":"get","path":"/access-profiles/{id}/entitlements","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List Access Profile's Entitlements","description":{"content":"This API lists the Entitlements associated with a given Access Profile\n\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a token with SOURCE_SUBADMIN authority must have access to the Source associated with the given Access Profile","type":"text/plain"},"url":{"path":["access-profiles",":id","entitlements"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following Entitlement fields and operators:\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**attribute**: *eq, sw*\n\n**value**: *eq, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**source.id**: *eq, in*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name, attribute, value, created, modified**","type":"text/plain"},"key":"sorters","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the containing Access Profile","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Access Profile's Entitlements' (get-access-profile-entitlements)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Access Profile's Entitlements + + + +This API lists the Entitlements associated with a given Access Profile + +A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a token with SOURCE_SUBADMIN authority must have access to the Source associated with the given Access Profile + +
    Path Parameters
    Query Parameters
    + +List of Entitlements + +
    Schema array
      source object
      attributes object
      + +A map of free-form key-value pairs from the source system + +
      directPermissions object[]
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-access-profile.api.mdx b/products/idn/api/v3/get-access-profile.api.mdx new file mode 100644 index 000000000..a5e8340cf --- /dev/null +++ b/products/idn/api/v3/get-access-profile.api.mdx @@ -0,0 +1,113 @@ +--- +id: get-access-profile +sidebar_label: Get an Access Profile +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAccessProfile","tags":["Access Profiles"],"description":"This API returns an Access Profile by its ID.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"ID of the Access Profile","example":"2c9180837ca6693d017ca8d097500149"}],"responses":{"200":{"description":"An AccessProfile","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Access Profile","example":"2c91808a7190d06e01719938fcd20792","readOnly":true},"name":{"type":"string","description":"Name of the Access Profile","example":"Employee-database-read-write"},"description":{"type":"string","nullable":true,"description":"Information about the Access Profile","example":"Collection of entitlements to read/write the employee database"},"created":{"type":"string","description":"Date the Access Profile was created","format":"date-time","example":"2021-03-01T22:32:58.104Z","readOnly":true},"modified":{"type":"string","description":"Date the Access Profile was last modified.","format":"date-time","example":"2021-03-02T20:22:28.104Z","readOnly":true},"enabled":{"type":"boolean","description":"Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement.","example":true},"owner":{"description":"Owner of the Access Profile","type":"object","nullable":true,"properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"source":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Source with with which the Access Profile is associated","example":"2c91809773dee3610173fdb0b6061ef4"},"type":{"type":"string","enum":["SOURCE"],"description":"The type of the Source, will always be SOURCE","example":"SOURCE"},"name":{"type":"string","description":"The display name of the associated Source","example":"ODS-AD-SOURCE"}}},"entitlements":{"type":"array","description":"A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement.","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Entitlement","example":"2c91809773dee32014e13e122092014e"},"type":{"type":"string","enum":["ENTITLEMENT"],"description":"The type of the Entitlement, will always be ENTITLEMENT","example":"ENTITLEMENT"},"name":{"type":"string","description":"The display name of the Entitlement","example":"CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"}}}},"requestable":{"type":"boolean","description":"Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error.","example":true},"accessRequestConfig":{"nullable":true,"description":"Access request configuration for this object","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":true},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":true},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"revocationRequestConfig":{"nullable":true,"description":"Revocation request configuration for this object.","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":false,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":false,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the revocation request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"segments":{"type":"array","nullable":true,"items":{"type":"string"},"description":"List of IDs of segments, if any, to which this Access Profile is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]},"provisioningCriteria":{"description":"When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression is evaluated against those Accounts to choose one to provision with the Access Profile.","nullable":true,"example":{"operation":"OR","children":[{"operation":"AND","children":[{"attribute":"dn","operation":"CONTAINS","value":"useast"},{"attribute":"manager","operation":"CONTAINS","value":"Scott.Clark"}]},{"operation":"AND","children":[{"attribute":"dn","operation":"EQUALS","value":"Gibson"},{"attribute":"telephoneNumber","operation":"CONTAINS","value":"512"}]}]},"type":"object","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","nullable":true,"description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines matching criteria for an Account to be provisioned with a specific Access Profile","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","nullable":true,"description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines matching criteria for an Account to be provisioned with a specific Access Profile","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.","example":null}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.","example":null}}}},"required":["owner","name","source"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:access-profile:read"]}],"method":"get","path":"/access-profiles/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get an Access Profile","description":{"content":"This API returns an Access Profile by its ID.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["access-profiles",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Access Profile","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get an Access Profile' (get-access-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get an Access Profile + + + +This API returns an Access Profile by its ID. + +A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +
    Path Parameters
    + +An AccessProfile + +
    Schema
      owner object
      + +Owner of the Access Profile + +
      source object
      entitlements object[]
      + +A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. + +
      accessRequestConfig object
      + +Access request configuration for this object + +
      approvalSchemes object[]
      + +List describing the steps in approving the request + +
      revocationRequestConfig object
      + +Revocation request configuration for this object. + +
      approvalSchemes object[]
      + +List describing the steps in approving the revocation request + +
      provisioningCriteria object
      + +When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression is evaluated against those Accounts to choose one to provision with the Access Profile. + +
      children object[]
      + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + +
      children object[]
      + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-access-request-approval-summary.api.mdx b/products/idn/api/v3/get-access-request-approval-summary.api.mdx new file mode 100644 index 000000000..7996f8266 --- /dev/null +++ b/products/idn/api/v3/get-access-request-approval-summary.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-access-request-approval-summary +sidebar_label: Get the number of access-requests-approvals +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAccessRequestApprovalSummary","tags":["Access Request Approvals"],"description":"This endpoint returns the number of pending, approved and rejected access requests approvals. See \"owner-id\" query parameter below for authorization info.","parameters":[{"in":"query","name":"owner-id","schema":{"type":"string"},"description":"The id of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity.\n * ORG_ADMIN users can call this with any identity ID value.\n * ORG_ADMIN user can also fetch all the approvals in the org, when\nowner-id is not used.\n * Non ORG_ADMIN users can only specify *me* or pass their own\nidentity ID value.","example":"2c91808568c529c60168cca6f90c1313","required":false},{"in":"query","name":"from-date","schema":{"type":"string"},"description":"From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format","example":"from-date=2020-03-19T19:59:11Z","required":false}],"responses":{"200":{"description":"Number of pending, approved, rejected access request approvals.","content":{"application/json":{"schema":{"type":"object","properties":{"pending":{"type":"integer","description":"The number of pending access requests approvals.","format":"int32","example":0},"approved":{"type":"integer","description":"The number of approved access requests approvals.","format":"int32","example":0},"rejected":{"type":"integer","description":"The number of rejected access requests approvals.","format":"int32","example":0}}}}}},"400":{"description":"Client Error - Returned if the query parameter is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/access-request-approvals/approval-summary","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get the number of access-requests-approvals","description":{"content":"This endpoint returns the number of pending, approved and rejected access requests approvals. See \"owner-id\" query parameter below for authorization info.","type":"text/plain"},"url":{"path":["access-request-approvals","approval-summary"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The id of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity.\n * ORG_ADMIN users can call this with any identity ID value.\n * ORG_ADMIN user can also fetch all the approvals in the org, when\nowner-id is not used.\n * Non ORG_ADMIN users can only specify *me* or pass their own\nidentity ID value.","type":"text/plain"},"key":"owner-id","value":""},{"disabled":false,"description":{"content":"From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format","type":"text/plain"},"key":"from-date","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get the number of access-requests-approvals' (get-access-request-approval-summary)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get the number of access-requests-approvals + + + +This endpoint returns the number of pending, approved and rejected access requests approvals. See "owner-id" query parameter below for authorization info. + +
    Query Parameters
    + +Number of pending, approved, rejected access request approvals. + +
    Schema
    + +Client Error - Returned if the query parameter is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-access-request-config.api.mdx b/products/idn/api/v3/get-access-request-config.api.mdx new file mode 100644 index 000000000..728cfbf0a --- /dev/null +++ b/products/idn/api/v3/get-access-request-config.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-access-request-config +sidebar_label: Get Access Request Configuration +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAccessRequestConfig","tags":["Access Requests"],"description":"This endpoint returns the current access-request configuration.","responses":{"200":{"description":"Access Request Configuration Details.","content":{"application/json":{"schema":{"type":"object","properties":{"approvalsMustBeExternal":{"type":"boolean","description":"If true, then approvals must be processed by external system.","example":true},"autoApprovalEnabled":{"type":"boolean","description":"If true and requester and reviewer are the same, then automatically approve the approval.","example":true},"requestOnBehalfOfConfig":{"description":"Request On Behalf Of Configuration.","type":"object","properties":{"allowRequestOnBehalfOfAnyoneByAnyone":{"type":"boolean","description":"If anyone can request access for anyone.","example":true},"allowRequestOnBehalfOfEmployeeByManager":{"type":"boolean","description":"If a manager can request access for his/her direct reports.","example":true}}},"approvalReminderAndEscalationConfig":{"description":"Approval Reminder and Escalation Configuration.","type":"object","properties":{"daysUntilEscalation":{"type":"integer","description":"Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation.","format":"int32","example":0},"daysBetweenReminders":{"type":"integer","description":"Number of days to wait between reminder notifications.","format":"int32","example":0},"maxReminders":{"type":"integer","description":"Maximum number of reminder notification to send to the reviewer before approval escalation.","format":"int32","example":0},"fallbackApproverRef":{"type":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"},"id":{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"},"name":{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"},"email":{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}}}},"entitlementRequestConfig":{"description":"Entitlement Request Configuration.","type":"object","properties":{"allowEntitlementRequest":{"type":"boolean","description":"Flag for allowing entitlement request.","example":true},"requestCommentsRequired":{"type":"boolean","description":"Flag for requiring comments while submitting an entitlement request.","default":false,"example":false},"deniedCommentsRequired":{"type":"boolean","description":"Flag for requiring comments while rejecting an entitlement request.","default":false,"example":false},"grantRequestApprovalSchemes":{"type":"string","description":"Approval schemes for granting entitlement request. This can be empty if no approval is needed.\nMultiple schemes must be comma-separated. The valid schemes are \"entitlementOwner\", \"sourceOwner\", \"manager\" and \"workgroup:{id}\".\nMultiple workgroups (governance groups) can be used.\n","default":"sourceOwner","example":"entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584"}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/access-request-config","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get Access Request Configuration","description":{"content":"This endpoint returns the current access-request configuration.","type":"text/plain"},"url":{"path":["access-request-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Access Request Configuration' (get-access-request-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Access Request Configuration + + + +This endpoint returns the current access-request configuration. + +
    + +Access Request Configuration Details. + +
    Schema
      requestOnBehalfOfConfig object
      + +Request On Behalf Of Configuration. + +
      approvalReminderAndEscalationConfig object
      + +Approval Reminder and Escalation Configuration. + +
      fallbackApproverRef object
      entitlementRequestConfig object
      + +Entitlement Request Configuration. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-account-activity.api.mdx b/products/idn/api/v3/get-account-activity.api.mdx new file mode 100644 index 000000000..409395b2f --- /dev/null +++ b/products/idn/api/v3/get-account-activity.api.mdx @@ -0,0 +1,103 @@ +--- +id: get-account-activity +sidebar_label: Get an Account Activity +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAccountActivity","tags":["Account Activities"],"description":"This gets a single account activity by its id.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The account activity id","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"An account activity object","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Id of the account activity","example":"2c9180835d2e5168015d32f890ca1581"},"name":{"type":"string","description":"The name of the activity","example":"2c9180835d2e5168015d32f890ca1581"},"created":{"description":"When the activity was first created","type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"},"modified":{"description":"When the activity was last modified","type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z","nullable":true},"completed":{"description":"When the activity was completed","type":"string","format":"date-time","nullable":true,"example":"2018-10-19T13:49:37.385Z"},"completionStatus":{"nullable":true,"type":"string","description":"The status after completion.","enum":["SUCCESS","FAILURE","INCOMPLETE","PENDING"],"example":"SUCCESS"},"type":{"nullable":true,"type":"string","example":"appRequest","description":"The type of action the activity performed. Please see the following list of types. This list may grow over time.\n\n- CloudAutomated\n- IdentityAttributeUpdate\n- appRequest\n- LifecycleStateChange\n- AccountStateUpdate\n- AccountAttributeUpdate\n- CloudPasswordRequest\n- Attribute Synchronization Refresh\n- Certification\n- Identity Refresh\n- Lifecycle Change Refresh\n\n\n[Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data).\n"},"requesterIdentitySummary":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"ID of this identity summary","example":"ff80818155fe8c080155fe8d925b0316"},"name":{"type":"string","description":"Human-readable display name of identity","example":"SailPoint Services"},"identityId":{"type":"string","description":"ID of the identity that this summary represents","example":"c15b9f5cca5a4e9599eaa0e64fa921bd"},"completed":{"type":"boolean","description":"Indicates if all access items for this summary have been decided on","example":true}}},"targetIdentitySummary":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"ID of this identity summary","example":"ff80818155fe8c080155fe8d925b0316"},"name":{"type":"string","description":"Human-readable display name of identity","example":"SailPoint Services"},"identityId":{"type":"string","description":"ID of the identity that this summary represents","example":"c15b9f5cca5a4e9599eaa0e64fa921bd"},"completed":{"type":"boolean","description":"Indicates if all access items for this summary have been decided on","example":true}}},"errors":{"nullable":true,"description":"A list of error messages, if any, that were encountered.","type":"array","items":{"type":"string"},"example":["sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds."]},"warnings":{"nullable":true,"description":"A list of warning messages, if any, that were encountered.","type":"array","items":{"type":"string"},"example":["Some warning, another warning"]},"items":{"type":"array","description":"Individual actions performed as part of this account activity","items":{"type":"object","properties":{"id":{"type":"string","description":"Item id","example":"48c545831b264409a81befcabb0e3c5a"},"name":{"type":"string","description":"Human-readable display name of item","example":"48c545831b264409a81befcabb0e3c5a"},"requested":{"type":"string","format":"date-time","description":"Date and time item was requested","example":"2017-07-11T18:45:37.098Z"},"approvalStatus":{"nullable":true,"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"},"provisioningStatus":{"type":"string","enum":["PENDING","FINISHED","UNVERIFIABLE","COMMITED","FAILED","RETRY"],"description":"Provisioning state of an account activity item","example":"PENDING"},"requesterComment":{"type":"object","nullable":true,"properties":{"commenterId":{"type":"string","description":"Id of the identity making the comment","example":"2c918084660f45d6016617daa9210584"},"commenterName":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"},"body":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat."},"date":{"type":"string","format":"date-time","description":"Date and time comment was made","example":"2017-07-11T18:45:37.098Z"}}},"reviewerIdentitySummary":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"ID of this identity summary","example":"ff80818155fe8c080155fe8d925b0316"},"name":{"type":"string","description":"Human-readable display name of identity","example":"SailPoint Services"},"identityId":{"type":"string","description":"ID of the identity that this summary represents","example":"c15b9f5cca5a4e9599eaa0e64fa921bd"},"completed":{"type":"boolean","description":"Indicates if all access items for this summary have been decided on","example":true}}},"reviewerComment":{"type":"object","nullable":true,"properties":{"commenterId":{"type":"string","description":"Id of the identity making the comment","example":"2c918084660f45d6016617daa9210584"},"commenterName":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"},"body":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat."},"date":{"type":"string","format":"date-time","description":"Date and time comment was made","example":"2017-07-11T18:45:37.098Z"}}},"operation":{"nullable":true,"type":"string","enum":["ADD","CREATE","MODIFY","DELETE","DISABLE","ENABLE","UNLOCK","LOCK","REMOVE"],"description":"Represents an operation in an account activity item","example":"ADD"},"attribute":{"type":"string","description":"Attribute to which account activity applies","nullable":true,"example":"detectedRoles"},"value":{"type":"string","description":"Value of attribute","nullable":true,"example":"Treasury Analyst [AccessProfile-1529010191212]"},"nativeIdentity":{"nullable":true,"type":"string","description":"Native identity in the target system to which the account activity applies","example":"Sandie.Camero"},"sourceId":{"type":"string","description":"Id of Source to which account activity applies","example":"2c91808363ef85290164000587130c0c"},"accountRequestInfo":{"type":"object","nullable":true,"properties":{"requestedObjectId":{"type":"string","description":"Id of requested object","example":"2c91808563ef85690164001c31140c0c"},"requestedObjectName":{"type":"string","description":"Human-readable name of requested object","example":"Treasury Analyst"},"requestedObjectType":{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"Enum represented the currently supported requestable object types. Additional values may be added in the future without notice.","example":"ACCESS_PROFILE"}},"description":"If an account activity item is associated with an access request, captures details of that request."},"clientMetadata":{"nullable":true,"type":"object","additionalProperties":{"type":"string"},"description":"Arbitrary key-value pairs, if any were included in the corresponding access request item","example":{"customKey1":"custom value 1","customKey2":"custom value 2"}},"removeDate":{"nullable":true,"type":"string","description":"The date the role or access profile is no longer assigned to the specified identity.","format":"date-time","example":"2020-07-11T00:00:00Z"}}}},"executionStatus":{"type":"string","description":"The current state of execution.","enum":["EXECUTING","VERIFYING","TERMINATED","COMPLETED"],"example":"COMPLETED"},"clientMetadata":{"nullable":true,"type":"object","additionalProperties":{"type":"string"},"description":"Arbitrary key-value pairs, if any were included in the corresponding access request","example":{"customKey1":"custom value 1","customKey2":"custom value 2"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/account-activities/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get an Account Activity","description":{"content":"This gets a single account activity by its id.","type":"text/plain"},"url":{"path":["account-activities",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The account activity id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get an Account Activity' (get-account-activity)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get an Account Activity + + + +This gets a single account activity by its id. + +
    Path Parameters
    + +An account activity object + +
    Schema
      requesterIdentitySummary object
      targetIdentitySummary object
      items object[]
      + +Individual actions performed as part of this account activity + +
      requesterComment object
      reviewerIdentitySummary object
      reviewerComment object
      accountRequestInfo object
      + +If an account activity item is associated with an access request, captures details of that request. + +
      clientMetadata object
      + +Arbitrary key-value pairs, if any were included in the corresponding access request item + +
    • property name* string
      • clientMetadata object
      + +Arbitrary key-value pairs, if any were included in the corresponding access request + +
    • property name* string
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-account-entitlements.api.mdx b/products/idn/api/v3/get-account-entitlements.api.mdx new file mode 100644 index 000000000..6e566432d --- /dev/null +++ b/products/idn/api/v3/get-account-entitlements.api.mdx @@ -0,0 +1,96 @@ +--- +id: get-account-entitlements +sidebar_label: Account Entitlements +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAccountEntitlements","tags":["Accounts"],"description":"This API returns entitlements of the account. \nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:accounts:read"]}],"parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The account id","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"An array of account entitlements","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true},"modified":{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}},{"type":"object","description":"Entitlement object that represents entitlement","properties":{"attribute":{"description":"Name of the entitlement attribute","type":"string","example":"authorizationType"},"value":{"description":"Raw value of the entitlement","type":"string","example":"CN=Users,dc=sailpoint,dc=com"},"description":{"description":"Entitlment description","type":"string","example":"Active Directory DC"},"attributes":{"description":"Entitlement attributes","type":"object","additionalProperties":true,"example":{"GroupType":"Security","sAMAccountName":"Buyer"}},"sourceSchemaObjectType":{"description":"Schema objectType on the given application that maps to an Account Group","type":"string","example":"group"},"privileged":{"description":"Determines if this Entitlement is privileged.","type":"boolean","example":false},"cloudGoverned":{"description":"Determines if this Entitlement is goverened in the cloud.","type":"boolean","example":false},"source":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Reference to the source this entitlment belongs to.","example":[{"type":"SOURCE","id":"2c9180835d191a86015d28455b4b232a","name":"HR Active Directory"}]}}}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/accounts/{id}/entitlements","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Account Entitlements","description":{"content":"This API returns entitlements of the account. \nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts",":id","entitlements"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The account id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Account Entitlements' (get-account-entitlements)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Account Entitlements + + + +This API returns entitlements of the account. +A token with ORG_ADMIN authority is required to call this API. + +
    Path Parameters
    Query Parameters
    + +An array of account entitlements + +
    Schema array
      attributes object
      + +Entitlement attributes + +
      source object
      + +Reference to the source this entitlment belongs to. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-account.api.mdx b/products/idn/api/v3/get-account.api.mdx new file mode 100644 index 000000000..f7af67494 --- /dev/null +++ b/products/idn/api/v3/get-account.api.mdx @@ -0,0 +1,92 @@ +--- +id: get-account +sidebar_label: Account Details +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAccount","tags":["Accounts"],"description":"This API returns the details for a single account based on the ID. \nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:accounts:read"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The account ID","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"An account object","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true},"modified":{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}},{"type":"object","required":["sourceId","sourceName","attributes","authoritative","disabled","locked","nativeIdentity","systemAccount","uncorrelated","manuallyCorrelated","hasEntitlements"],"properties":{"sourceId":{"type":"string","example":"2c9180835d2e5168015d32f890ca1581","description":"The unique ID of the source this account belongs to"},"sourceName":{"type":"string","example":"Employees","description":"The display name of the source this account belongs to"},"identityId":{"type":"string","example":"2c9180835d2e5168015d32f890ca1581","description":"The unique ID of the identity this account is correlated to"},"attributes":{"type":"object","additionalProperties":true,"description":"The account attributes that are aggregated","example":{"firstName":"SailPoint","lastName":"Support","displayName":"SailPoint Support"}},"authoritative":{"type":"boolean","description":"Indicates if this account is from an authoritative source","example":false},"description":{"type":"string","description":"A description of the account","nullable":true,"example":null},"disabled":{"type":"boolean","description":"Indicates if the account is currently disabled","example":false},"locked":{"type":"boolean","description":"Indicates if the account is currently locked","example":false},"nativeIdentity":{"type":"string","description":"The unique ID of the account generated by the source system","example":"552775"},"systemAccount":{"type":"boolean","example":false,"description":"If true, this is a user account within IdentityNow. If false, this is an account from a source system."},"uncorrelated":{"type":"boolean","description":"Indicates if this account is not correlated to an identity","example":false},"uuid":{"type":"string","description":"The unique ID of the account as determined by the account schema","example":"slpt.support","nullable":true},"manuallyCorrelated":{"type":"boolean","description":"Indicates if the account has been manually correlated to an identity","example":false},"hasEntitlements":{"type":"boolean","description":"Indicates if the account has entitlements","example":true}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/accounts/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Account Details","description":{"content":"This API returns the details for a single account based on the ID. \nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The account ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Account Details' (get-account)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Account Details + + + +This API returns the details for a single account based on the ID. +A token with ORG_ADMIN authority is required to call this API. + +
    Path Parameters
    + +An account object + +
    Schema
      attributes object
      + +The account attributes that are aggregated + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-accounts-schema.api.mdx b/products/idn/api/v3/get-accounts-schema.api.mdx new file mode 100644 index 000000000..1fdb2f717 --- /dev/null +++ b/products/idn/api/v3/get-accounts-schema.api.mdx @@ -0,0 +1,88 @@ +--- +id: get-accounts-schema +sidebar_label: Downloads source accounts schema template +hide_title: true +hide_table_of_contents: true +api: {"tags":["Sources"],"description":"This API downloads the CSV schema that defines the account attributes on a source.\n>**NOTE: This API is designated only for Delimited File sources.**","operationId":"getAccountsSchema","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"The Source id","example":"8c190e6787aa4ed9a90bd9d5344523fb"}],"responses":{"200":{"description":"Successfully downloaded the file","content":{"text/csv":{"example":"id,name,givenName,familyName,e-mail,location,manager,groups,startDate,endDate"}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:source-schema:read"]}],"method":"get","path":"/sources/{id}/schemas/accounts","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Downloads source accounts schema template","description":{"content":"This API downloads the CSV schema that defines the account attributes on a source.\n>**NOTE: This API is designated only for Delimited File sources.**","type":"text/plain"},"url":{"path":["sources",":id","schemas","accounts"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"text/csv"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Downloads source accounts schema template' (get-accounts-schema)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Downloads source accounts schema template + + + +This API downloads the CSV schema that defines the account attributes on a source. +>**NOTE: This API is designated only for Delimited File sources.** + +
    Path Parameters
    + +Successfully downloaded the file + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-active-campaigns.api.mdx b/products/idn/api/v3/get-active-campaigns.api.mdx new file mode 100644 index 000000000..3e66f453d --- /dev/null +++ b/products/idn/api/v3/get-active-campaigns.api.mdx @@ -0,0 +1,119 @@ +--- +id: get-active-campaigns +sidebar_label: List Campaigns +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getActiveCampaigns","tags":["Certification Campaigns"],"description":"Gets campaigns and returns them in a list. Can provide increased level of detail for each campaign if provided the correct query.","security":[{"oauth2":["idn:campaign-list:read"]}],"parameters":[{"in":"query","name":"detail","schema":{"type":"string","enum":["SLIM","FULL"]},"required":false,"description":"Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.","example":"FULL"},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"required":false,"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**status**: *eq, in*","example":"name eq \"Manager Campaign\""},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"required":false,"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**, **created**","example":"name"}],"responses":{"200":{"description":"A list of campaign objects.","content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"type":"object","title":"Slim Campaign","required":["name","description","type"],"properties":{"id":{"type":"string","readOnly":true,"description":"Id of the campaign","example":"2c9079b270a266a60170a2779fcb0007"},"name":{"description":"The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","type":"string","example":"Manager Campaign"},"description":{"type":"string","description":"The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","example":"Everyone needs to be reviewed by their manager"},"deadline":{"type":"string","format":"date-time","description":"The campaign's completion deadline.","example":"2020-03-15T10:00:01.456Z"},"type":{"type":"string","description":"The type of campaign. Could be extended in the future.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"},"emailNotificationEnabled":{"type":"boolean","description":"Enables email notification for this campaign","default":false,"example":false},"autoRevokeAllowed":{"type":"boolean","description":"Allows auto revoke for this campaign","default":false,"example":false},"recommendationsEnabled":{"type":"boolean","description":"Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.","default":false,"example":true},"status":{"type":"string","description":"The campaign's current status.","readOnly":true,"enum":["PENDING","STAGED","CANCELING","ACTIVATING","ACTIVE","COMPLETING","COMPLETED","ERROR","ARCHIVED"],"example":"ACTIVE"},"correlatedStatus":{"type":"string","description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"}}},{"type":"object","title":"Campaign","allOf":[{"type":"object","title":"Slim Campaign","required":["name","description","type"],"properties":{"id":{"type":"string","readOnly":true,"description":"Id of the campaign","example":"2c9079b270a266a60170a2779fcb0007"},"name":{"description":"The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","type":"string","example":"Manager Campaign"},"description":{"type":"string","description":"The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","example":"Everyone needs to be reviewed by their manager"},"deadline":{"type":"string","format":"date-time","description":"The campaign's completion deadline.","example":"2020-03-15T10:00:01.456Z"},"type":{"type":"string","description":"The type of campaign. Could be extended in the future.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"},"emailNotificationEnabled":{"type":"boolean","description":"Enables email notification for this campaign","default":false,"example":false},"autoRevokeAllowed":{"type":"boolean","description":"Allows auto revoke for this campaign","default":false,"example":false},"recommendationsEnabled":{"type":"boolean","description":"Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.","default":false,"example":true},"status":{"type":"string","description":"The campaign's current status.","readOnly":true,"enum":["PENDING","STAGED","CANCELING","ACTIVATING","ACTIVE","COMPLETING","COMPLETED","ERROR","ARCHIVED"],"example":"ACTIVE"},"correlatedStatus":{"type":"string","description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"}}},{"type":"object","properties":{"created":{"type":"string","readOnly":true,"format":"date-time","description":"Created time of the campaign","example":"2020-03-03T22:15:13.611Z"},"modified":{"type":"string","readOnly":true,"format":"date-time","description":"Modified time of the campaign","example":"2020-03-03T22:20:12.674Z"},"correlatedStatus":{"description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"},"filter":{"type":"object","description":"Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank.","properties":{"id":{"type":"string","description":"The ID of whatever type of filter is being used.","example":"0fbe863c063c4c88a35fd7f17e8a3df5"},"type":{"type":"string","description":"Type of the filter","enum":["CAMPAIGN_FILTER","RULE"],"example":"CAMPAIGN_FILTER"},"name":{"type":"string","description":"Name of the filter","example":"Test Filter"}}},"sunsetCommentsRequired":{"type":"boolean","description":"Determines if comments on sunset date changes are required.","default":true,"example":true},"sourceOwnerCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SOURCE_OWNER.","properties":{"sourceIds":{"type":"array","description":"The list of sources to be included in the campaign.","items":{"type":"string"},"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]}}},"searchCampaignInfo":{"type":"object","description":"Must be set only if the campaign type is SEARCH.","properties":{"type":{"type":"string","description":"The type of search campaign represented.","enum":["IDENTITY","ACCESS"],"example":"ACCESS"},"description":{"type":"string","description":"Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available.","example":"Search Campaign description"},"reviewer":{"description":"If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"query":{"type":"string","description":"The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set.","example":"Search Campaign query description"},"identityIds":{"type":"array","description":"A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set.","items":{"type":"string"},"maxItems":1000,"example":["0fbe863c063c4c88a35fd7f17e8a3df5"]},"accessConstraints":{"type":"array","description":"Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access.","items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT","ACCESS_PROFILE","ROLE"],"description":"Type of Access","example":"ENTITLEMENT"},"ids":{"description":"Must be set only if operator is SELECTED.","type":"array","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"operator":{"type":"string","enum":["ALL","SELECTED"],"description":"Used to determine whether the scope of the campaign should be reduced for selected ids or all.","example":"SELECTED"}},"required":["type","operator"]},"maxItems":1000}},"required":["type"]},"roleCompositionCampaignInfo":{"type":"object","description":"Optional configuration options for role composition campaigns.","properties":{"reviewer":{"description":"If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP","allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object"}]},"roleIds":{"type":"array","description":"Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]},"remediatorRef":{"type":"object","description":"This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin.","properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Legal Remediator Type","example":"IDENTITY"},"id":{"type":"string","description":"The ID of the remediator.","example":"2c90ad2a70ace7d50170acf22ca90010"},"name":{"type":"string","description":"The name of the remediator.","readOnly":true,"example":"Role Admin"}},"required":["type","id"]},"query":{"type":"string","description":"Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","example":"Search Query"},"description":{"type":"string","description":"Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available.","example":"Role Composition Description"}},"required":["remediatorRef"]},"alerts":{"type":"array","description":"A list of errors and warnings that have accumulated.","readOnly":true,"items":{"type":"object","properties":{"level":{"type":"string","enum":["ERROR","WARN","INFO"],"description":"Denotes the level of the message","example":"ERROR"},"localizations":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}},"totalCertifications":{"type":"integer","description":"The total number of certifications in this campaign.","readOnly":true,"example":100},"completedCertifications":{"type":"integer","description":"The number of completed certifications in this campaign.","readOnly":true,"example":10},"sourcesWithOrphanEntitlements":{"type":"array","description":"A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented).","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the source","example":"2c90ad2a70ace7d50170acf22ca90010"},"type":{"type":"string","enum":["SOURCE"],"description":"Type","example":"SOURCE"},"name":{"type":"string","description":"Name of the source","example":"Source with orphan entitlements"}}}},"mandatoryCommentRequirement":{"type":"string","description":"Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.","enum":["ALL_DECISIONS","REVOKE_ONLY_DECISIONS","NO_DECISIONS"],"example":"NO_DECISIONS"}}}]}]}},"examples":{"Slim Campaign":{"description":"List of Slim Campaigns that would result from not specifying *detail* or specifying SLIM","value":[{"id":"2c918086719eec070171a7e3355a360a","name":"Manager Review","description":"A review of everyone's access by their manager.","deadline":"2020-12-25T06:00:00.123Z","type":"MANAGER","status":"ACTIVE","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false},{"id":"7e1a731e3fb845cfbe58112ba4673ee4","name":"Search Campaign","description":"Search Campaign Info","deadline":"2022-07-26T15:42:44Z","type":"SEARCH","status":"ACTIVE","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false},{"id":"2c918086719eec070171a7e3355a412b","name":"AD Source Review","description":"A review of our AD source.","deadline":"2020-12-25T06:00:00.123Z","type":"SOURCE_OWNER","status":"STAGED","emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"correlatedStatus":"CORRELATED"},{"id":"3b2e2e5821e84127b6d693d41c40623b","name":"Role Composition Campaign","description":"A review done by a role owner.","deadline":"2020-12-25T06:00:00.468Z","type":"ROLE_COMPOSITION","status":"ACTIVE","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false}]},"Full Campaign":{"description":"List of Campaigns that would result from specifying *detail* as FULL","value":[{"id":"078696a575e045c68d6722ccdb9f101d","name":"Role Composition Campaign","description":"A review done by a role owner.","deadline":"2020-12-25T06:00:00.468Z","type":"ROLE_COMPOSITION","status":"ERROR","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"created":"2022-08-02T20:29:51.065Z","modified":"2022-08-02T20:29:51.331Z","filter":{"type":"CAMPAIGN_FILTER","id":"0fbe863c063c4c88a35fd7f17e8a3df5","name":"Test Role Composition Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":null,"roleCompositionCampaignInfo":{"remediatorRef":{"type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":"SailPoint Support"},"reviewerId":null,"reviewer":null,"roleIds":["b15d609fc5c8434b865fe552315fda8f"],"query":null,"description":null},"alerts":[{"level":"ERROR","localizations":[{"locale":"en","localeOrigin":"DEFAULT","text":"Composite criterion must have children non-composite criterion must not."}]}],"totalCertifications":0,"completedCertifications":0,"sourcesWithOrphanEntitlements":null,"mandatoryCommentRequirement":"NO_DECISIONS"},{"id":"1be8fc1103914bf0a4e14e316b6a7b7c","name":"Manager Review","description":"A review of everyone's access by their manager.","deadline":"2020-12-25T06:00:00.468Z","type":"MANAGER","status":"STAGED","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"created":"2022-08-02T19:00:27.731Z","modified":"2022-08-02T19:00:34.391Z","filter":{"type":"CAMPAIGN_FILTER","id":"0fbe863c063c4c88a35fd7f17e8a3df5","name":"Test Manager Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":null,"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":5,"completedCertifications":0,"sourcesWithOrphanEntitlements":[],"mandatoryCommentRequirement":"NO_DECISIONS"},{"id":"7e1a731e3fb845cfbe58112ba4673ee4","name":"Search Campaign","description":"Search Campaign for Identities","deadline":"2022-07-26T15:42:44Z","type":"SEARCH","status":"ACTIVE","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false,"created":"2022-07-25T15:42:18.276Z","modified":"2022-07-25T15:42:53.718Z","filter":{"type":"CAMPAIGN_FILTER","id":"0fbe863c063c4c88a35fd7f17e8a3df5","name":"Test Search Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":null,"searchCampaignInfo":{"type":"IDENTITY","description":"Example of Search Campaign","reviewer":{"type":"IDENTITY","id":"7ec252acbd4245548bc25df22348cb75","name":null},"query":"user","identityIds":null,"accessConstraints":[]},"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":6,"completedCertifications":0,"sourcesWithOrphanEntitlements":[],"mandatoryCommentRequirement":"NO_DECISIONS"},{"id":"ad3cf3dd50394b1bad646de4bc51b999","name":"Source Owner Campaign","description":"Example for Source Owner Campaign","deadline":"2022-08-10T17:09:02Z","type":"SOURCE_OWNER","status":"ACTIVE","emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"created":"2022-07-27T17:04:19.027Z","modified":"2022-07-27T17:09:13.925Z","filter":{"type":"CAMPAIGN_FILTER","id":"0fbe863c063c4c88a35fd7f17e8a3df5","name":"Test Source Owner Filter"},"sunsetCommentsRequired":true,"sourceOwnerCampaignInfo":{"sourceIds":["2c91808781fd5aea01821200dc88318e"]},"searchCampaignInfo":null,"roleCompositionCampaignInfo":null,"alerts":null,"totalCertifications":2,"completedCertifications":0,"sourcesWithOrphanEntitlements":[],"correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/campaigns","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List Campaigns","description":{"content":"Gets campaigns and returns them in a list. Can provide increased level of detail for each campaign if provided the correct query.","type":"text/plain"},"url":{"path":["campaigns"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.","type":"text/plain"},"key":"detail","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**status**: *eq, in*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**, **created**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Campaigns' (get-active-campaigns)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Campaigns + + + +Gets campaigns and returns them in a list. Can provide increased level of detail for each campaign if provided the correct query. + +
    Query Parameters
    + +A list of campaign objects. + +
    Schema array
      oneOf
      filter object
      + +Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank. + +
      sourceOwnerCampaignInfo object
      + +Must be set only if the campaign type is SOURCE_OWNER. + +
      searchCampaignInfo object
      + +Must be set only if the campaign type is SEARCH. + +
      reviewer object
      + +If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP + +
      accessConstraints object[]
      + +**Possible values:** `<= 1000` + +
      + +Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. + +
      roleCompositionCampaignInfo object
      + +Optional configuration options for role composition campaigns. + +
      reviewer object
      + +If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP + +
      remediatorRef object
      + +This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin. + +
      alerts object[]
      + +A list of errors and warnings that have accumulated. + +
      localizations object[]
      sourcesWithOrphanEntitlements object[]
      + +A list of sources in the campaign that contain \"orphan entitlements\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-campaign.api.mdx b/products/idn/api/v3/get-campaign.api.mdx new file mode 100644 index 000000000..ba13e21a0 --- /dev/null +++ b/products/idn/api/v3/get-campaign.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-campaign +sidebar_label: Get a campaign +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getCampaign","tags":["Certification Campaigns"],"description":"Retrieves information for an existing campaign using the campaign's ID. Authorized callers must be a reviewer for this campaign, an ORG_ADMIN, or a CERT_ADMIN.","security":[{"oauth2":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the campaign to be retrieved","example":"2c91808571bcfcf80171c23e4b4221fc"}],"responses":{"200":{"description":"A campaign object","content":{"application/json":{"schema":{"type":"object","title":"Slim Campaign","required":["name","description","type"],"properties":{"id":{"type":"string","readOnly":true,"description":"Id of the campaign","example":"2c9079b270a266a60170a2779fcb0007"},"name":{"description":"The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","type":"string","example":"Manager Campaign"},"description":{"type":"string","description":"The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","example":"Everyone needs to be reviewed by their manager"},"deadline":{"type":"string","format":"date-time","description":"The campaign's completion deadline.","example":"2020-03-15T10:00:01.456Z"},"type":{"type":"string","description":"The type of campaign. Could be extended in the future.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"},"emailNotificationEnabled":{"type":"boolean","description":"Enables email notification for this campaign","default":false,"example":false},"autoRevokeAllowed":{"type":"boolean","description":"Allows auto revoke for this campaign","default":false,"example":false},"recommendationsEnabled":{"type":"boolean","description":"Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.","default":false,"example":true},"status":{"type":"string","description":"The campaign's current status.","readOnly":true,"enum":["PENDING","STAGED","CANCELING","ACTIVATING","ACTIVE","COMPLETING","COMPLETED","ERROR","ARCHIVED"],"example":"ACTIVE"},"correlatedStatus":{"type":"string","description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"}}},"examples":{"Manager":{"value":{"id":"2c918086719eec070171a7e3355a360a","name":"Manager Review","description":"A review of everyone's access by their manager.","deadline":"2020-12-25T06:00:00.123Z","type":"MANAGER","status":"ACTIVE","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false}},"Search":{"value":{"id":"7e1a731e3fb845cfbe58112ba4673ee4","name":"Search Campaign","description":"Search Campaign Info","deadline":"2022-07-26T15:42:44Z","type":"SEARCH","status":"ACTIVE","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false}},"Source Owner":{"value":{"id":"2c918086719eec070171a7e3355a412b","name":"AD Source Review","description":"A review of our AD source.","deadline":"2020-12-25T06:00:00.123Z","type":"SOURCE_OWNER","status":"STAGED","emailNotificationEnabled":true,"autoRevokeAllowed":false,"recommendationsEnabled":false,"correlatedStatus":"CORRELATED"}},"RoleComposition":{"value":{"id":"3b2e2e5821e84127b6d693d41c40623b","name":"Role Composition Campaign","description":"A review done by a role owner.","deadline":"2020-12-25T06:00:00.468Z","type":"ROLE_COMPOSITION","status":"ACTIVE","emailNotificationEnabled":false,"autoRevokeAllowed":false,"recommendationsEnabled":false}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/campaigns/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get a campaign","description":{"content":"Retrieves information for an existing campaign using the campaign's ID. Authorized callers must be a reviewer for this campaign, an ORG_ADMIN, or a CERT_ADMIN.","type":"text/plain"},"url":{"path":["campaigns",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the campaign to be retrieved","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a campaign' (get-campaign)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a campaign + + + +Retrieves information for an existing campaign using the campaign's ID. Authorized callers must be a reviewer for this campaign, an ORG_ADMIN, or a CERT_ADMIN. + +
    Path Parameters
    + +A campaign object + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-completed-work-items.api.mdx b/products/idn/api/v3/get-completed-work-items.api.mdx new file mode 100644 index 000000000..65b9b8f01 --- /dev/null +++ b/products/idn/api/v3/get-completed-work-items.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-completed-work-items +sidebar_label: Completed Work Items +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getCompletedWorkItems","tags":["Work Items"],"description":"This gets a collection of completed work items belonging to either the specified user(admin required), or the current user.","parameters":[{"in":"query","name":"ownerId","schema":{"type":"string"},"description":"The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request.","required":false,"example":"1211bcaa32112bcef6122adb21cef1ac"},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"List of completed work items.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the work item","example":"2c9180835d2e5168015d32f890ca1581"},"requesterId":{"type":"string","description":"ID of the requester","example":"2c9180835d2e5168015d32f890ca1581"},"requesterDisplayName":{"type":"string","description":"The displayname of the requester","example":"John Smith"},"ownerId":{"type":"string","description":"The ID of the owner","example":"2c9180835d2e5168015d32f890ca1581"},"ownerName":{"type":"string","description":"The name of the owner","example":"Jason Smith"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z","description":"Time when the work item was created"},"modified":{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"Time when the work item was last updated"},"description":{"type":"string","description":"The description of the work item","example":"Create account on source 'AD'"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"},"type":{"type":"string","enum":["UNKNOWN","GENERIC","CERTIFICATION","REMEDIATION","DELEGATION","APPROVAL","VIOLATIONREVIEW","FORM","POLICYVIOLATION","CHALLENGE","IMPACTANALYSIS","SIGNOFF","EVENT","MANUALACTION","TEST"],"example":"GENERIC","description":"The type of the work item"},"remediationItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the certification","example":"2c9180835d2e5168015d32f890ca1581"},"targetId":{"type":"string","description":"The ID of the certification target","example":"2c9180835d2e5168015d32f890ca1581"},"targetName":{"type":"string","description":"The name of the certification target","example":"john.smith"},"targetDisplayName":{"type":"string","description":"The display name of the certification target","example":"emailAddress"},"applicationName":{"type":"string","description":"The name of the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute being certified","example":"phoneNumber"},"attributeOperation":{"type":"string","description":"The operation of the certification on the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute being certified","example":"512-555-1212"},"nativeIdentity":{"type":"string","description":"The native identity of the target","example":"jason.smith2"}}},"approvalItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the approval item","example":"2c9180835d2e5168015d32f890ca1581"},"account":{"type":"string","description":"The account referenced by the approval item","example":"john.smith"},"application":{"type":"string","description":"The name the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute","example":"emailAddress"},"attributeOperation":{"type":"string","description":"The operation of the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute","example":"a@b.com"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"}}},"name":{"type":"string","description":"The work item name","example":"Account Create"},"completed":{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z","description":"The time at which the work item completed"},"numItems":{"type":"integer","format":"int32","description":"The number of items in the work item","example":19},"form":{"type":"object","properties":{"id":{"type":"string","description":"ID of the form","example":"2c9180835d2e5168015d32f890ca1581"},"name":{"type":"string","description":"Name of the form","example":"AccountSelection Form"},"title":{"type":"string","description":"The form title","example":"Account Selection for John.Doe"},"subtitle":{"type":"string","description":"The form subtitle.","example":"Please select from the following"},"targetUser":{"type":"string","description":"The name of the user that should be shown this form","example":"Jane.Doe"},"sections":{"type":"object","allOf":[{"type":"object","properties":{"name":{"type":"string","description":"Name of the FormItem","example":"Field1"}}},{"type":"object","properties":{"label":{"type":"string","description":"Label of the section","example":"Section 1"},"formItems":{"type":"array","items":{"type":"object"},"description":"List of FormItems. FormItems can be SectionDetails and/or FieldDetails","example":[]}}}]}}},"errors":{"type":"array","items":{"type":"string"},"example":["The work item ID that was specified was not found."],"description":"An array of errors that ocurred during the work item"}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/work-items/completed","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Completed Work Items","description":{"content":"This gets a collection of completed work items belonging to either the specified user(admin required), or the current user.","type":"text/plain"},"url":{"path":["work-items","completed"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request.","type":"text/plain"},"key":"ownerId","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Completed Work Items' (get-completed-work-items)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Completed Work Items + + + +This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. + +
    Query Parameters
    + +List of completed work items. + +
    Schema array
      remediationItems object
      approvalItems object
      form object
      sections object
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-count-completed-work-items.api.mdx b/products/idn/api/v3/get-count-completed-work-items.api.mdx new file mode 100644 index 000000000..ca0787290 --- /dev/null +++ b/products/idn/api/v3/get-count-completed-work-items.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-count-completed-work-items +sidebar_label: Count Completed Work Items +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getCountCompletedWorkItems","tags":["Work Items"],"description":"This gets a count of completed work items belonging to either the specified user(admin required), or the current user.","parameters":[{"in":"query","name":"ownerId","schema":{"type":"string"},"description":"ID of the work item owner.","required":false,"example":"1211bcaa32112bcef6122adb21cef1ac"}],"responses":{"200":{"description":"List of work items","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"The count of work items","example":29}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/work-items/completed/count","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Count Completed Work Items","description":{"content":"This gets a count of completed work items belonging to either the specified user(admin required), or the current user.","type":"text/plain"},"url":{"path":["work-items","completed","count"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"ID of the work item owner.","type":"text/plain"},"key":"ownerId","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Count Completed Work Items' (get-count-completed-work-items)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Count Completed Work Items + + + +This gets a count of completed work items belonging to either the specified user(admin required), or the current user. + +
    Query Parameters
    + +List of work items + +
    Schema
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-count-work-items.api.mdx b/products/idn/api/v3/get-count-work-items.api.mdx new file mode 100644 index 000000000..a616cb76b --- /dev/null +++ b/products/idn/api/v3/get-count-work-items.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-count-work-items +sidebar_label: Count Work Items +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getCountWorkItems","tags":["Work Items"],"description":"This gets a count of work items belonging to either the specified user(admin required), or the current user.","parameters":[{"in":"query","name":"ownerId","schema":{"type":"string"},"description":"ID of the work item owner.","required":false,"example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"List of work items","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"The count of work items","example":29}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/work-items/count","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Count Work Items","description":{"content":"This gets a count of work items belonging to either the specified user(admin required), or the current user.","type":"text/plain"},"url":{"path":["work-items","count"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"ID of the work item owner.","type":"text/plain"},"key":"ownerId","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Count Work Items' (get-count-work-items)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Count Work Items + + + +This gets a count of work items belonging to either the specified user(admin required), or the current user. + +
    Query Parameters
    + +List of work items + +
    Schema
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-custom-violation-report.api.mdx b/products/idn/api/v3/get-custom-violation-report.api.mdx new file mode 100644 index 000000000..040abd84a --- /dev/null +++ b/products/idn/api/v3/get-custom-violation-report.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-custom-violation-report +sidebar_label: Download custom violation report +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:sod-violation:read"]}],"operationId":"getCustomViolationReport","tags":["SOD Policy"],"description":"This allows to download a specified named violation report for a given report reference.","parameters":[{"in":"path","name":"reportResultId","schema":{"type":"string"},"required":true,"description":"The ID of the report reference to download.","example":"ef38f94347e94562b5bb8424a56397d8"},{"in":"path","name":"fileName","schema":{"type":"string"},"required":true,"description":"Custom Name for the file.","example":"custom-name"}],"responses":{"200":{"description":"Returns the zip file with given custom name that contains the violation report file.","content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sod-violation-report/{reportResultId}/download/{fileName}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Download custom violation report","description":{"content":"This allows to download a specified named violation report for a given report reference.","type":"text/plain"},"url":{"path":["sod-violation-report",":reportResultId","download",":fileName"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the report reference to download.","type":"text/plain"},"type":"any","value":"","key":"reportResultId"},{"disabled":false,"description":{"content":"(Required) Custom Name for the file.","type":"text/plain"},"type":"any","value":"","key":"fileName"}]},"header":[{"key":"Accept","value":"application/zip"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Download custom violation report' (get-custom-violation-report)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Download custom violation report + + + +This allows to download a specified named violation report for a given report reference. + +
    Path Parameters
    + +Returns the zip file with given custom name that contains the violation report file. + +
    Schema
    • string binary
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-default-identity-attribute-config.api.mdx b/products/idn/api/v3/get-default-identity-attribute-config.api.mdx new file mode 100644 index 000000000..0a6bcdde6 --- /dev/null +++ b/products/idn/api/v3/get-default-identity-attribute-config.api.mdx @@ -0,0 +1,96 @@ +--- +id: get-default-identity-attribute-config +sidebar_label: Get default Identity Attribute Config +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getDefaultIdentityAttributeConfig","tags":["Identity Profiles"],"description":"This returns the default identity attribute config.\nA token with ORG_ADMIN authority is required to call this API to get the default identity attribute config.","parameters":[{"in":"path","name":"identity-profile-id","schema":{"type":"string","format":"uuid"},"required":true,"description":"The Identity Profile ID.","example":"2b838de9-db9b-abcf-e646-d4f274ad4238"}],"responses":{"200":{"description":"An Identity Attribute Config object.","content":{"application/json":{"schema":{"type":"object","description":"Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process.","properties":{"enabled":{"description":"The backend will only promote values if the profile/mapping is enabled.","type":"boolean","default":false,"example":true},"attributeTransforms":{"type":"array","items":{"type":"object","description":"Defines a transformation definition for an identity attribute.","properties":{"identityAttributeName":{"type":"string","description":"Name of the identity attribute.","example":"email"},"transformDefinition":{"description":"The seaspray transformation definition.","type":"object","properties":{"type":{"type":"string","description":"The type of the transform definition.","example":"accountAttribute"},"attributes":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"object"}]},"description":"Arbitrary key-value pairs to store any metadata for the object","example":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}}}}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:identity-profile:manage"]}],"method":"get","path":"/identity-profiles/{identity-profile-id}/default-identity-attribute-config","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get default Identity Attribute Config","description":{"content":"This returns the default identity attribute config.\nA token with ORG_ADMIN authority is required to call this API to get the default identity attribute config.","type":"text/plain"},"url":{"path":["identity-profiles",":identity-profile-id","default-identity-attribute-config"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Identity Profile ID.","type":"text/plain"},"type":"any","value":"","key":"identity-profile-id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get default Identity Attribute Config' (get-default-identity-attribute-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get default Identity Attribute Config + + + +This returns the default identity attribute config. +A token with ORG_ADMIN authority is required to call this API to get the default identity attribute config. + +
    Path Parameters
    + +An Identity Attribute Config object. + +
    Schema
      attributeTransforms object[]
      transformDefinition object
      + +The seaspray transformation definition. + +
      attributes object
      + +Arbitrary key-value pairs to store any metadata for the object + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-default-violation-report.api.mdx b/products/idn/api/v3/get-default-violation-report.api.mdx new file mode 100644 index 000000000..8f9cddfb7 --- /dev/null +++ b/products/idn/api/v3/get-default-violation-report.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-default-violation-report +sidebar_label: Download violation report +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:sod-violation:read"]}],"operationId":"getDefaultViolationReport","tags":["SOD Policy"],"description":"This allows to download a violation report for a given report reference.","parameters":[{"in":"path","name":"reportResultId","schema":{"type":"string"},"required":true,"description":"The ID of the report reference to download.","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"Returns the PolicyReport.zip that contains the violation report file.","content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sod-violation-report/{reportResultId}/download","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Download violation report","description":{"content":"This allows to download a violation report for a given report reference.","type":"text/plain"},"url":{"path":["sod-violation-report",":reportResultId","download"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the report reference to download.","type":"text/plain"},"type":"any","value":"","key":"reportResultId"}]},"header":[{"key":"Accept","value":"application/zip"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Download violation report' (get-default-violation-report)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Download violation report + + + +This allows to download a violation report for a given report reference. + +
    Path Parameters
    + +Returns the PolicyReport.zip that contains the violation report file. + +
    Schema
    • string binary
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-entitlements-schema.api.mdx b/products/idn/api/v3/get-entitlements-schema.api.mdx new file mode 100644 index 000000000..4fb8a94ba --- /dev/null +++ b/products/idn/api/v3/get-entitlements-schema.api.mdx @@ -0,0 +1,89 @@ +--- +id: get-entitlements-schema +sidebar_label: Downloads source entitlements schema template +hide_title: true +hide_table_of_contents: true +api: {"tags":["Sources"],"description":"This API downloads the CSV schema that defines the entitlement attributes on a source.\n\n>**NOTE: This API is designated only for Delimited File sources.**","operationId":"getEntitlementsSchema","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"The Source id","example":"8c190e6787aa4ed9a90bd9d5344523fb"},{"in":"query","name":"schemaName","schema":{"type":"string"},"description":"Name of entitlement schema","example":"?schemaName=group"}],"responses":{"200":{"description":"Successfully downloaded the file","content":{"text/csv":{"example":"id,name,displayName,created,description,modified,entitlements,groups,permissions"}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:source-schema:read"]}],"method":"get","path":"/sources/{id}/schemas/entitlements","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Downloads source entitlements schema template","description":{"content":"This API downloads the CSV schema that defines the entitlement attributes on a source.\n\n>**NOTE: This API is designated only for Delimited File sources.**","type":"text/plain"},"url":{"path":["sources",":id","schemas","entitlements"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Name of entitlement schema","type":"text/plain"},"key":"schemaName","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"text/csv"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Downloads source entitlements schema template' (get-entitlements-schema)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Downloads source entitlements schema template + + + +This API downloads the CSV schema that defines the entitlement attributes on a source. + +>**NOTE: This API is designated only for Delimited File sources.** + +
    Path Parameters
    Query Parameters
    + +Successfully downloaded the file + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-identity-access-summaries.api.mdx b/products/idn/api/v3/get-identity-access-summaries.api.mdx new file mode 100644 index 000000000..b484fca0f --- /dev/null +++ b/products/idn/api/v3/get-identity-access-summaries.api.mdx @@ -0,0 +1,119 @@ +--- +id: get-identity-access-summaries +sidebar_label: Access Summaries +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getIdentityAccessSummaries","tags":["Certification Summaries"],"description":"This API returns a list of access summaries for the specified identity campaign certification and type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity campaign certification ID","example":"ef38f94347e94562b5bb8424a56397d8"},{"in":"path","name":"type","schema":{"type":"string","enum":["ROLE","ACCESS_PROFILE","ENTITLEMENT"]},"required":true,"description":"The type of access review item to retrieve summaries for","example":"ACCESS_PROFILE"},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"example":"access.id eq \"ef38f94347e94562b5bb8424a56397d8\"","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**completed**: *eq, ne*\n\n**access.id**: *eq, in*\n\n**access.name**: *eq, sw*\n\n**entitlement.sourceName**: *eq, sw*\n\n**accessProfile.sourceName**: *eq, sw*"},{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"example":"access.name","description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **access.name**"}],"responses":{"200":{"description":"List of access summaries","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"An object holding the access that is being reviewed","properties":{"access":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"The ID of the item being certified","example":"2c9180867160846801719932c5153fb7"},"name":{"type":"string","description":"The name of the item being certified","example":"Entitlement for Company Database"}}},"entitlement":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"The id for the entitlement","example":"2c918085718230600171993742c63558"},"name":{"type":"string","description":"The name of the entitlement","example":"CN=entitlement.bbb7c650"},"description":{"nullable":true,"type":"string","description":"Information about the entitlement","example":"Gives read/write access to the company database"},"privileged":{"type":"boolean","example":false,"description":"Indicates if the entitlement is a privileged entitlement"},"owner":{"type":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"},"id":{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"},"name":{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"},"email":{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}},"attributeName":{"type":"string","description":"The name of the attribute on the source","example":"memberOf"},"attributeValue":{"type":"string","description":"The value of the attribute on the source","example":"CN=entitlement.bbb7c650"},"sourceSchemaObjectType":{"type":"string","description":"The schema object type on the source used to represent the entitlement and its attributes","example":"groups"},"sourceName":{"type":"string","description":"The name of the source for which this entitlement belongs","example":"ODS-AD-Source"},"sourceType":{"type":"string","description":"The type of the source for which the entitlement belongs","example":"Active Directory - Direct"},"hasPermissions":{"type":"boolean","description":"Indicates if the entitlement has permissions","example":false},"isPermission":{"type":"boolean","description":"Indicates if the entitlement is a representation of an account permission","example":false},"revocable":{"type":"boolean","description":"Indicates whether the entitlement can be revoked","example":true},"cloudGoverned":{"type":"boolean","description":"True if the entitlement is cloud governed","example":false},"account":{"type":"object","nullable":true,"description":"Information about the status of the entitlement","properties":{"nativeIdentity":{"type":"string","description":"The native identity for this account","example":"CN=Alison Ferguso"},"disabled":{"type":"boolean","example":false,"description":"Indicates whether this account is currently disabled"},"locked":{"type":"boolean","example":false,"description":"Indicates whether this account is currently locked"},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"nullable":true,"type":"string","description":"The id associated with the account","example":"2c9180857182305e0171993737eb29e6"},"name":{"nullable":true,"type":"string","description":"The account name","example":"Alison Ferguso"},"created":{"nullable":true,"type":"string","format":"date-time","description":"When the account was created","example":"2020-04-20T20:11:05.067Z"},"modified":{"nullable":true,"type":"string","format":"date-time","description":"When the account was last modified","example":"2020-05-20T18:57:16.987Z"}}}}},"accessProfile":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Access Profile","example":"2c91808a7190d06e01719938fcd20792"},"name":{"type":"string","description":"Name of the Access Profile","example":"Employee-database-read-write"},"description":{"type":"string","description":"Information about the Access Profile","example":"Collection of entitlements to read/write the employee database"},"privileged":{"type":"boolean","description":"Indicates if the entitlement is a privileged entitlement","example":false},"cloudGoverned":{"type":"boolean","description":"True if the entitlement is cloud governed","example":false},"endDate":{"nullable":true,"type":"string","format":"date-time","description":"The date at which a user's access expires","example":"2021-12-25T00:00:00.000Z"},"owner":{"type":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"},"id":{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"},"name":{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"},"email":{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}},"description":"Owner of the Access Profile"},"entitlements":{"type":"array","description":"A list of entitlements associated with this Access Profile","items":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"The id for the entitlement","example":"2c918085718230600171993742c63558"},"name":{"type":"string","description":"The name of the entitlement","example":"CN=entitlement.bbb7c650"},"description":{"nullable":true,"type":"string","description":"Information about the entitlement","example":"Gives read/write access to the company database"},"privileged":{"type":"boolean","example":false,"description":"Indicates if the entitlement is a privileged entitlement"},"owner":{"type":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"},"id":{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"},"name":{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"},"email":{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}},"attributeName":{"type":"string","description":"The name of the attribute on the source","example":"memberOf"},"attributeValue":{"type":"string","description":"The value of the attribute on the source","example":"CN=entitlement.bbb7c650"},"sourceSchemaObjectType":{"type":"string","description":"The schema object type on the source used to represent the entitlement and its attributes","example":"groups"},"sourceName":{"type":"string","description":"The name of the source for which this entitlement belongs","example":"ODS-AD-Source"},"sourceType":{"type":"string","description":"The type of the source for which the entitlement belongs","example":"Active Directory - Direct"},"hasPermissions":{"type":"boolean","description":"Indicates if the entitlement has permissions","example":false},"isPermission":{"type":"boolean","description":"Indicates if the entitlement is a representation of an account permission","example":false},"revocable":{"type":"boolean","description":"Indicates whether the entitlement can be revoked","example":true},"cloudGoverned":{"type":"boolean","description":"True if the entitlement is cloud governed","example":false},"account":{"type":"object","nullable":true,"description":"Information about the status of the entitlement","properties":{"nativeIdentity":{"type":"string","description":"The native identity for this account","example":"CN=Alison Ferguso"},"disabled":{"type":"boolean","example":false,"description":"Indicates whether this account is currently disabled"},"locked":{"type":"boolean","example":false,"description":"Indicates whether this account is currently locked"},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"nullable":true,"type":"string","description":"The id associated with the account","example":"2c9180857182305e0171993737eb29e6"},"name":{"nullable":true,"type":"string","description":"The account name","example":"Alison Ferguso"},"created":{"nullable":true,"type":"string","format":"date-time","description":"When the account was created","example":"2020-04-20T20:11:05.067Z"},"modified":{"nullable":true,"type":"string","format":"date-time","description":"When the account was last modified","example":"2020-05-20T18:57:16.987Z"}}}}}},"created":{"type":"string","description":"Date the Access Profile was created.","format":"date-time","example":"2021-01-01T22:32:58.104Z"},"modified":{"type":"string","description":"Date the Access Profile was last modified.","format":"date-time","example":"2021-02-01T22:32:58.104Z"}}},"role":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"The id for the Role","example":"2c91808a7190d06e0171993907fd0794"},"name":{"type":"string","description":"The name of the Role","example":"Accounting-Employees"},"description":{"type":"string","description":"Information about the Role","example":"Role for members of the accounting department with the necessary Access Profiles"},"privileged":{"type":"boolean","description":"Indicates if the entitlement is a privileged entitlement","example":false},"owner":{"type":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"},"id":{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"},"name":{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"},"email":{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}},"revocable":{"type":"boolean","description":"Indicates whether the Role can be revoked or requested","example":false},"endDate":{"type":"string","format":"date-time","description":"The date when a user's access expires.","example":"2021-12-25T00:00:00.000Z"},"accessProfiles":{"type":"array","description":"The list of Access Profiles associated with this Role","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Access Profile","example":"2c91808a7190d06e01719938fcd20792"},"name":{"type":"string","description":"Name of the Access Profile","example":"Employee-database-read-write"},"description":{"type":"string","description":"Information about the Access Profile","example":"Collection of entitlements to read/write the employee database"},"privileged":{"type":"boolean","description":"Indicates if the entitlement is a privileged entitlement","example":false},"cloudGoverned":{"type":"boolean","description":"True if the entitlement is cloud governed","example":false},"endDate":{"nullable":true,"type":"string","format":"date-time","description":"The date at which a user's access expires","example":"2021-12-25T00:00:00.000Z"},"owner":{"type":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"},"id":{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"},"name":{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"},"email":{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}},"description":"Owner of the Access Profile"},"entitlements":{"type":"array","description":"A list of entitlements associated with this Access Profile","items":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"The id for the entitlement","example":"2c918085718230600171993742c63558"},"name":{"type":"string","description":"The name of the entitlement","example":"CN=entitlement.bbb7c650"},"description":{"nullable":true,"type":"string","description":"Information about the entitlement","example":"Gives read/write access to the company database"},"privileged":{"type":"boolean","example":false,"description":"Indicates if the entitlement is a privileged entitlement"},"owner":{"type":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"},"id":{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"},"name":{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"},"email":{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}},"attributeName":{"type":"string","description":"The name of the attribute on the source","example":"memberOf"},"attributeValue":{"type":"string","description":"The value of the attribute on the source","example":"CN=entitlement.bbb7c650"},"sourceSchemaObjectType":{"type":"string","description":"The schema object type on the source used to represent the entitlement and its attributes","example":"groups"},"sourceName":{"type":"string","description":"The name of the source for which this entitlement belongs","example":"ODS-AD-Source"},"sourceType":{"type":"string","description":"The type of the source for which the entitlement belongs","example":"Active Directory - Direct"},"hasPermissions":{"type":"boolean","description":"Indicates if the entitlement has permissions","example":false},"isPermission":{"type":"boolean","description":"Indicates if the entitlement is a representation of an account permission","example":false},"revocable":{"type":"boolean","description":"Indicates whether the entitlement can be revoked","example":true},"cloudGoverned":{"type":"boolean","description":"True if the entitlement is cloud governed","example":false},"account":{"type":"object","nullable":true,"description":"Information about the status of the entitlement","properties":{"nativeIdentity":{"type":"string","description":"The native identity for this account","example":"CN=Alison Ferguso"},"disabled":{"type":"boolean","example":false,"description":"Indicates whether this account is currently disabled"},"locked":{"type":"boolean","example":false,"description":"Indicates whether this account is currently locked"},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"nullable":true,"type":"string","description":"The id associated with the account","example":"2c9180857182305e0171993737eb29e6"},"name":{"nullable":true,"type":"string","description":"The account name","example":"Alison Ferguso"},"created":{"nullable":true,"type":"string","format":"date-time","description":"When the account was created","example":"2020-04-20T20:11:05.067Z"},"modified":{"nullable":true,"type":"string","format":"date-time","description":"When the account was last modified","example":"2020-05-20T18:57:16.987Z"}}}}}},"created":{"type":"string","description":"Date the Access Profile was created.","format":"date-time","example":"2021-01-01T22:32:58.104Z"},"modified":{"type":"string","description":"Date the Access Profile was last modified.","format":"date-time","example":"2021-02-01T22:32:58.104Z"}}}}}}}}},"example":[{"access":{"type":"ENTITLEMENT","id":"2c9180857182305e01719937429e2bad","name":"CN=Engineering"},"entitlement":{"id":"2c9180857182305e01719937429e2bad","name":"CN=Engineering","description":"Access to the engineering database","privileged":false,"owner":{"email":"brandon.gray@acme-solar.com","type":"IDENTITY","id":"2c9180867160846801719932c5153fb7","name":"Brandon Gray"},"attributeName":"memberOf","attributeValue":"CN=Engineering","sourceName":"ODS-AD-Source","hasPermissions":true,"revocable":true}}]}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/certifications/{id}/access-summaries/{type}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Access Summaries","description":{"content":"This API returns a list of access summaries for the specified identity campaign certification and type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.","type":"text/plain"},"url":{"path":["certifications",":id","access-summaries",":type"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**completed**: *eq, ne*\n\n**access.id**: *eq, in*\n\n**access.name**: *eq, sw*\n\n**entitlement.sourceName**: *eq, sw*\n\n**accessProfile.sourceName**: *eq, sw*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **access.name**","type":"text/plain"},"key":"sorters","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identity campaign certification ID","type":"text/plain"},"type":"any","value":"","key":"id"},{"disabled":false,"description":{"content":"(Required) The type of access review item to retrieve summaries for","type":"text/plain"},"type":"any","value":"","key":"type"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Access Summaries' (get-identity-access-summaries)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Access Summaries + + + +This API returns a list of access summaries for the specified identity campaign certification and type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +
    Path Parameters
    Query Parameters
    + +List of access summaries + +
    Schema array
      access object
      entitlement object
      owner object
      account object
      + +Information about the status of the entitlement + +
      accessProfile object
      owner object
      + +Owner of the Access Profile + +
      entitlements object[]
      + +A list of entitlements associated with this Access Profile + +
      owner object
      account object
      + +Information about the status of the entitlement + +
      role object
      owner object
      accessProfiles object[]
      + +The list of Access Profiles associated with this Role + +
      owner object
      + +Owner of the Access Profile + +
      entitlements object[]
      + +A list of entitlements associated with this Access Profile + +
      owner object
      account object
      + +Information about the status of the entitlement + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-identity-certification.api.mdx b/products/idn/api/v3/get-identity-certification.api.mdx new file mode 100644 index 000000000..a2bf22f2d --- /dev/null +++ b/products/idn/api/v3/get-identity-certification.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-identity-certification +sidebar_label: Identity Certification by ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getIdentityCertification","tags":["Certifications"],"description":"This API returns a single identity campaign certification by its ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The certification id","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"An identity campaign certification object","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"example":"2c9180835d2e5168015d32f890ca1581","type":"string","description":"id of the certification"},"name":{"example":"Source Owner Access Review for Employees [source]","type":"string","description":"name of the certification"},"campaign":{"type":"object","required":["id","name","type","campaignType","description","correlatedStatus","mandatoryCommentRequirement"],"properties":{"id":{"type":"string","description":"The unique ID of the campaign.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the campaign.","example":"Campaign Name"},"type":{"type":"string","enum":["CAMPAIGN"],"description":"The type of object that is being referenced.","example":"CAMPAIGN"},"campaignType":{"type":"string","enum":["MANAGER","SOURCE_OWNER","SEARCH"],"description":"The type of the campaign.","example":"MANAGER"},"description":{"type":"string","description":"The description of the campaign set by the admin who created it.","nullable":true,"example":"A description of the campaign"},"correlatedStatus":{"description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"},"mandatoryCommentRequirement":{"type":"string","description":"Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.","enum":["ALL_DECISIONS","REVOKE_ONLY_DECISIONS","NO_DECISIONS"],"example":"NO_DECISIONS"}}},"completed":{"type":"boolean","description":"Have all decisions been made?","example":true},"identitiesCompleted":{"type":"integer","description":"The number of identities for whom all decisions have been made and are complete.","example":5,"format":"int32"},"identitiesTotal":{"type":"integer","description":"The total number of identities in the Certification, both complete and incomplete.","example":10,"format":"int32"},"created":{"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"created date"},"modified":{"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"modified date"},"decisionsMade":{"type":"integer","description":"The number of approve/revoke/acknowledge decisions that have been made.","example":20,"format":"int32"},"decisionsTotal":{"type":"integer","description":"The total number of approve/revoke/acknowledge decisions.","example":40,"format":"int32"},"due":{"type":"string","format":"date-time","description":"The due date of the certification.","example":"2018-10-19T13:49:37.385Z"},"signed":{"type":"string","format":"date-time","nullable":true,"description":"The date the reviewer signed off on the Certification.","example":"2018-10-19T13:49:37.385Z"},"reviewer":{"type":"object","properties":{"id":{"type":"string","description":"The id of the reviewer.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the reviewer.","example":"Reviewer Name"},"email":{"type":"string","description":"The email of the reviewing identity.","example":"reviewer@test.com"},"type":{"type":"string","enum":["IDENTITY"],"description":"The type of the reviewing identity.","example":"IDENTITY"},"created":{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The created date of the reviewing identity."},"modified":{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The modified date of the reviewing identity."}}},"reassignment":{"type":"object","nullable":true,"properties":{"from":{"type":"object","properties":{"id":{"type":"string","description":"The id of the certification.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the certification.","example":"Certification Name"},"type":{"type":"string","enum":["CERTIFICATION"],"example":"CERTIFICATION"},"reviewer":{"type":"object","properties":{"id":{"type":"string","description":"The id of the reviewer.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the reviewer.","example":"Reviewer Name"},"email":{"type":"string","description":"The email of the reviewing identity.","example":"reviewer@test.com"},"type":{"type":"string","enum":["IDENTITY"],"description":"The type of the reviewing identity.","example":"IDENTITY"},"created":{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The created date of the reviewing identity."},"modified":{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The modified date of the reviewing identity."}}}}},"comment":{"type":"string","description":"The comment entered when the Certification was reassigned","example":"Reassigned for a reason"}}},"hasErrors":{"description":"Identifies if the certification has an error","type":"boolean","example":false},"errorMessage":{"description":"Description of the certification error","nullable":true,"type":"string","example":"The certification has an error"},"phase":{"type":"string","description":"The current phase of the campaign.\n* `STAGED`: The campaign is waiting to be activated.\n* `ACTIVE`: The campaign is active.\n* `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete.\n","enum":["STAGED","ACTIVE","SIGNED"],"example":"ACTIVE"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/certifications/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Identity Certification by ID","description":{"content":"This API returns a single identity campaign certification by its ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.","type":"text/plain"},"url":{"path":["certifications",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The certification id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Identity Certification by ID' (get-identity-certification)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Identity Certification by ID + + + +This API returns a single identity campaign certification by its ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +
    Path Parameters
    + +An identity campaign certification object + +
    Schema
      campaign object
      reviewer object
      reassignment object
      from object
      reviewer object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-identity-decision-summary.api.mdx b/products/idn/api/v3/get-identity-decision-summary.api.mdx new file mode 100644 index 000000000..07488fd09 --- /dev/null +++ b/products/idn/api/v3/get-identity-decision-summary.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-identity-decision-summary +sidebar_label: Summary of Certification Decisions +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getIdentityDecisionSummary","tags":["Certification Summaries"],"description":"This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The certification ID","example":"ef38f94347e94562b5bb8424a56397d8"},{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"example":"identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**identitySummary.id**: *eq, in*"}],"responses":{"200":{"description":"Summary of the decisions made","content":{"application/json":{"schema":{"type":"object","properties":{"entitlementDecisionsMade":{"type":"integer","description":"Number of entitlement decisions that have been made","example":3,"format":"int32"},"accessProfileDecisionsMade":{"type":"integer","description":"Number of access profile decisions that have been made","example":5,"format":"int32"},"roleDecisionsMade":{"type":"integer","description":"Number of role decisions that have been made","example":2,"format":"int32"},"accountDecisionsMade":{"type":"integer","description":"Number of account decisions that have been made","example":4,"format":"int32"},"entitlementDecisionsTotal":{"type":"integer","description":"The total number of entitlement decisions on the certification, both complete and incomplete","example":6,"format":"int32"},"accessProfileDecisionsTotal":{"type":"integer","description":"The total number of access profile decisions on the certification, both complete and incomplete","example":10,"format":"int32"},"roleDecisionsTotal":{"type":"integer","description":"The total number of role decisions on the certification, both complete and incomplete","example":4,"format":"int32"},"accountDecisionsTotal":{"type":"integer","description":"The total number of account decisions on the certification, both complete and incomplete","example":8,"format":"int32"},"entitlementsApproved":{"type":"integer","description":"The number of entitlement decisions that have been made which were approved","example":2,"format":"int32"},"entitlementsRevoked":{"type":"integer","description":"The number of entitlement decisions that have been made which were revoked","example":1,"format":"int32"},"accessProfilesApproved":{"type":"integer","description":"The number of access profile decisions that have been made which were approved","example":3,"format":"int32"},"accessProfilesRevoked":{"type":"integer","description":"The number of access profile decisions that have been made which were revoked","example":2,"format":"int32"},"rolesApproved":{"type":"integer","description":"The number of role decisions that have been made which were approved","example":2,"format":"int32"},"rolesRevoked":{"type":"integer","description":"The number of role decisions that have been made which were revoked","example":0,"format":"int32"},"accountsApproved":{"type":"integer","description":"The number of account decisions that have been made which were approved","example":1,"format":"int32"},"accountsRevoked":{"type":"integer","description":"The number of account decisions that have been made which were revoked","example":3,"format":"int32"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/certifications/{id}/decision-summary","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Summary of Certification Decisions","description":{"content":"This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.","type":"text/plain"},"url":{"path":["certifications",":id","decision-summary"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**identitySummary.id**: *eq, in*","type":"text/plain"},"key":"filters","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The certification ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Summary of Certification Decisions' (get-identity-decision-summary)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Summary of Certification Decisions + + + +This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +
    Path Parameters
    Query Parameters
    + +Summary of the decisions made + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-identity-profile.api.mdx b/products/idn/api/v3/get-identity-profile.api.mdx new file mode 100644 index 000000000..cc74b3763 --- /dev/null +++ b/products/idn/api/v3/get-identity-profile.api.mdx @@ -0,0 +1,104 @@ +--- +id: get-identity-profile +sidebar_label: Get single Identity Profile +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getIdentityProfile","tags":["Identity Profiles"],"description":"This returns a single Identity Profile based on ID.\nA token with ORG_ADMIN or API authority is required to call this API.","parameters":[{"in":"path","name":"identity-profile-id","schema":{"type":"string","format":"uuid"},"required":true,"description":"The Identity Profile ID.","example":"2b838de9-db9b-abcf-e646-d4f274ad4238"}],"responses":{"200":{"description":"An Identity Profile object.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true},"modified":{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}},{"type":"object","required":["authoritativeSource"],"properties":{"description":{"type":"string","description":"The description of the Identity Profile.","example":"My custom flat file profile","nullable":true},"owner":{"type":"object","description":"The owner of the Identity Profile.","nullable":true,"properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Type of the object to which this reference applies","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"priority":{"type":"integer","format":"int64","description":"The priority for an Identity Profile.","example":10},"authoritativeSource":{"type":"object","properties":{"type":{"type":"string","enum":["SOURCE"],"description":"Type of the object to which this reference applies","example":"SOURCE"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"HR Active Directory"}}},"identityRefreshRequired":{"type":"boolean","default":false,"description":"True if a identity refresh is needed. Typically triggered when a change on the source has been made.","example":true},"identityCount":{"type":"integer","description":"The number of identities that belong to the Identity Profile.","format":"int32","example":8},"identityAttributeConfig":{"type":"object","description":"Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process.","properties":{"enabled":{"description":"The backend will only promote values if the profile/mapping is enabled.","type":"boolean","default":false,"example":true},"attributeTransforms":{"type":"array","items":{"type":"object","description":"Defines a transformation definition for an identity attribute.","properties":{"identityAttributeName":{"type":"string","description":"Name of the identity attribute.","example":"email"},"transformDefinition":{"description":"The seaspray transformation definition.","type":"object","properties":{"type":{"type":"string","description":"The type of the transform definition.","example":"accountAttribute"},"attributes":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"object"}]},"description":"Arbitrary key-value pairs to store any metadata for the object","example":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}}}}}}}}},"identityExceptionReportReference":{"type":"object","nullable":true,"properties":{"taskResultId":{"type":"string","format":"uuid","description":"The id of the task result.","example":"2b838de9-db9b-abcf-e646-d4f274ad4238"},"reportName":{"type":"string","example":"My annual report","description":"The name of the report."}}},"hasTimeBasedAttr":{"description":"Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile.","type":"boolean","default":false,"example":true}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:identity-profile:read"]}],"method":"get","path":"/identity-profiles/{identity-profile-id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get single Identity Profile","description":{"content":"This returns a single Identity Profile based on ID.\nA token with ORG_ADMIN or API authority is required to call this API.","type":"text/plain"},"url":{"path":["identity-profiles",":identity-profile-id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Identity Profile ID.","type":"text/plain"},"type":"any","value":"","key":"identity-profile-id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get single Identity Profile' (get-identity-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get single Identity Profile + + + +This returns a single Identity Profile based on ID. +A token with ORG_ADMIN or API authority is required to call this API. + +
    Path Parameters
    + +An Identity Profile object. + +
    Schema
      owner object
      + +The owner of the Identity Profile. + +
      authoritativeSource object
      identityAttributeConfig object
      + +Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. + +
      attributeTransforms object[]
      transformDefinition object
      + +The seaspray transformation definition. + +
      attributes object
      + +Arbitrary key-value pairs to store any metadata for the object + +
      identityExceptionReportReference object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-identity-summaries.api.mdx b/products/idn/api/v3/get-identity-summaries.api.mdx new file mode 100644 index 000000000..a3877c5e6 --- /dev/null +++ b/products/idn/api/v3/get-identity-summaries.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-identity-summaries +sidebar_label: Identity Summaries for Campaign Certification +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getIdentitySummaries","tags":["Certification Summaries"],"description":"This API returns a list of the identity summaries for a specific identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity campaign certification ID","example":"ef38f94347e94562b5bb8424a56397d8"},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"example":"id eq \"ef38f94347e94562b5bb8424a56397d8\"","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**completed**: *eq, ne*\n\n**name**: *eq, sw*"},{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"example":"name","description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**"}],"responses":{"200":{"description":"List of identity summaries","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the identity summary","example":"2c91808772a504f50172a9540e501ba7"},"name":{"type":"string","description":"Name of the linked identity","example":"Alison Ferguso"},"identityId":{"type":"string","description":"The ID of the identity being certified","example":"2c9180857182306001719937377a33de"},"completed":{"type":"boolean","description":"Indicates whether the review items for the linked identity's certification have been completed","example":true}}}},"example":[{"id":"2c91808772a504f50172a9540e501ba7","name":"Aaron Grey","identityId":"2c9180857182306001719937379633e4","completed":false},{"id":"2c91808772a504f50172a9540e501ba8","name":"Aglae Wilson","identityId":"2c9180857182306001719937377a33de","completed":true}]}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/certifications/{id}/identity-summaries","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Identity Summaries for Campaign Certification","description":{"content":"This API returns a list of the identity summaries for a specific identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.","type":"text/plain"},"url":{"path":["certifications",":id","identity-summaries"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**completed**: *eq, ne*\n\n**name**: *eq, sw*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**","type":"text/plain"},"key":"sorters","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identity campaign certification ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Identity Summaries for Campaign Certification' (get-identity-summaries)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Identity Summaries for Campaign Certification + + + +This API returns a list of the identity summaries for a specific identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +
    Path Parameters
    Query Parameters
    + +List of identity summaries + +
    Schema array
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-identity-summary.api.mdx b/products/idn/api/v3/get-identity-summary.api.mdx new file mode 100644 index 000000000..e2641f776 --- /dev/null +++ b/products/idn/api/v3/get-identity-summary.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-identity-summary +sidebar_label: Summary for Identity +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getIdentitySummary","tags":["Certification Summaries"],"description":"This API returns the summary for an identity on a specified identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity campaign certification ID","example":"ef38f94347e94562b5bb8424a56397d8"},{"in":"path","name":"identitySummaryId","schema":{"type":"string"},"required":true,"description":"The identity summary ID","example":"2c91808772a504f50172a9540e501ba8"}],"responses":{"200":{"description":"An identity summary","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the identity summary","example":"2c91808772a504f50172a9540e501ba7"},"name":{"type":"string","description":"Name of the linked identity","example":"Alison Ferguso"},"identityId":{"type":"string","description":"The ID of the identity being certified","example":"2c9180857182306001719937377a33de"},"completed":{"type":"boolean","description":"Indicates whether the review items for the linked identity's certification have been completed","example":true}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/certifications/{id}/identity-summaries/{identitySummaryId}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Summary for Identity","description":{"content":"This API returns the summary for an identity on a specified identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.","type":"text/plain"},"url":{"path":["certifications",":id","identity-summaries",":identitySummaryId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identity campaign certification ID","type":"text/plain"},"type":"any","value":"","key":"id"},{"disabled":false,"description":{"content":"(Required) The identity summary ID","type":"text/plain"},"type":"any","value":"","key":"identitySummaryId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Summary for Identity' (get-identity-summary)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Summary for Identity + + + +This API returns the summary for an identity on a specified identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +
    Path Parameters
    + +An identity summary + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-lifecycle-state.api.mdx b/products/idn/api/v3/get-lifecycle-state.api.mdx new file mode 100644 index 000000000..660224e44 --- /dev/null +++ b/products/idn/api/v3/get-lifecycle-state.api.mdx @@ -0,0 +1,92 @@ +--- +id: get-lifecycle-state +sidebar_label: Retrieves Lifecycle State +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getLifecycleState","tags":["Lifecycle States"],"description":"This endpoint retrieves a Lifecycle State.\nA token with ORG_ADMIN or API authority is required to call this API.","security":[{"oauth2":["idn:identity-profile-lifecycle-state:read"]}],"parameters":[{"in":"path","name":"identity-profile-id","description":"Identity Profile ID","required":true,"schema":{"type":"string"},"example":"2b838de9-db9b-abcf-e646-d4f274ad4238"},{"in":"path","name":"lifecycle-state-id","description":"Lifecycle State ID","required":true,"schema":{"type":"string"},"example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"The requested LifecycleState was successfully retrieved.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true},"modified":{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}},{"type":"object","required":["technicalName"],"properties":{"enabled":{"type":"boolean","example":true,"description":"Whether the lifecycle state is enabled or disabled."},"technicalName":{"type":"string","example":"Technical Name","description":"The technical name for lifecycle state. This is for internal use."},"description":{"type":"string","example":"Lifecycle description","description":"Lifecycle state description."},"identityCount":{"type":"integer","format":"int32","example":42,"readOnly":true,"description":"Number of identities that have the lifecycle state."},"emailNotificationOption":{"type":"object","description":"This is used for representing email configuration for a lifecycle state","properties":{"notifyManagers":{"type":"boolean","example":true,"description":"If true, then the manager is notified of the lifecycle state change."},"notifyAllAdmins":{"type":"boolean","example":true,"description":"If true, then all the admins are notified of the lifecycle state change."},"notifySpecificUsers":{"type":"boolean","example":true,"description":"If true, then the users specified in \"emailAddressList\" below are notified of lifecycle state change."},"emailAddressList":{"type":"array","example":["test@test.com","test2@test.com"],"items":{"type":"string"},"description":"List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change."}}},"accountActions":{"type":"array","items":{"type":"object","description":"Object for specifying Actions to be performed on a specified list of sources' account.","properties":{"action":{"example":"ENABLE","type":"string","description":"Describes if action will be enabled or disabled","enum":["ENABLE","DISABLE"]},"sourceIds":{"type":"array","items":{"type":"string"},"uniqueItems":true,"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"],"description":"List of unique source IDs. The sources must have the ENABLE feature or flat file source. See \"/sources\" endpoint for source features."}}}},"accessProfileIds":{"type":"array","items":{"type":"string"},"uniqueItems":true,"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"],"description":"List of unique access-profile IDs that are associated with the lifecycle state."}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Retrieves Lifecycle State","description":{"content":"This endpoint retrieves a Lifecycle State.\nA token with ORG_ADMIN or API authority is required to call this API.","type":"text/plain"},"url":{"path":["identity-profiles",":identity-profile-id","lifecycle-states",":lifecycle-state-id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Identity Profile ID","type":"text/plain"},"type":"any","value":"","key":"identity-profile-id"},{"disabled":false,"description":{"content":"(Required) Lifecycle State ID","type":"text/plain"},"type":"any","value":"","key":"lifecycle-state-id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Retrieves Lifecycle State' (get-lifecycle-state)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Retrieves Lifecycle State + + + +This endpoint retrieves a Lifecycle State. +A token with ORG_ADMIN or API authority is required to call this API. + +
    Path Parameters
    + +The requested LifecycleState was successfully retrieved. + +
    Schema
      emailNotificationOption object
      + +This is used for representing email configuration for a lifecycle state + +
      accountActions object[]
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-non-employee-approval-summary.api.mdx b/products/idn/api/v3/get-non-employee-approval-summary.api.mdx new file mode 100644 index 000000000..f8884a404 --- /dev/null +++ b/products/idn/api/v3/get-non-employee-approval-summary.api.mdx @@ -0,0 +1,79 @@ +--- +id: get-non-employee-approval-summary +sidebar_label: Get Summary of Non-Employee Approval Requests +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getNonEmployeeApprovalSummary","security":[{"oauth2":[]}],"tags":["Non-Employee Lifecycle Management"],"description":"This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter:\n 1. The user has the role context of `idn:nesr:read`, in which case he or\nshe may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id.\n 2. The current user is an approver, in which case \"me\" should be provided\nas the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her.","parameters":[{"in":"path","name":"requested-for","schema":{"type":"string"},"description":"The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user.","required":true,"example":"2c91808280430dfb0180431a59440460"}],"responses":{"200":{"description":"summary of non-employee approval requests","content":{"application/json":{"schema":{"type":"object","properties":{"approved":{"type":"integer","description":"The number of approved non-employee approval requests.","format":"int32","example":2},"pending":{"type":"integer","description":"The number of pending non-employee approval requests.","format":"int32","example":2},"rejected":{"type":"integer","description":"The number of rejected non-employee approval requests.","format":"int32","example":2}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-approvals/summary/{requested-for}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get Summary of Non-Employee Approval Requests","description":{"content":"This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter:\n 1. The user has the role context of `idn:nesr:read`, in which case he or\nshe may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id.\n 2. The current user is an approver, in which case \"me\" should be provided\nas the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her.","type":"text/plain"},"url":{"path":["non-employee-approvals","summary",":requested-for"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user.","type":"text/plain"},"type":"any","value":"","key":"requested-for"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Summary of Non-Employee Approval Requests' (get-non-employee-approval-summary)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Summary of Non-Employee Approval Requests + + + +This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. + 2. The current user is an approver, in which case "me" should be provided +as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. + +
    Path Parameters
    + +summary of non-employee approval requests + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-non-employee-approval.api.mdx b/products/idn/api/v3/get-non-employee-approval.api.mdx new file mode 100644 index 000000000..a3c2b1249 --- /dev/null +++ b/products/idn/api/v3/get-non-employee-approval.api.mdx @@ -0,0 +1,94 @@ +--- +id: get-non-employee-approval +sidebar_label: Get a non-employee approval item detail +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getNonEmployeeApproval","security":[{"oauth2":[]}],"tags":["Non-Employee Lifecycle Management"],"description":"Gets a non-employee approval item detail. There are two contextual uses for this endpoint:\n 1. The user has the role context of `idn:nesr:read`, in which case they\ncan get any approval.\n 2. The user owns the requested approval.","parameters":[{"in":"path","name":"id","description":"Non-Employee approval item id (UUID)","required":true,"schema":{"type":"string"},"example":"e136567de87e4d029e60b3c3c55db56d"},{"in":"query","name":"include-detail","description":"The object nonEmployeeRequest will not be included detail when set to false. *Default value is true*","required":false,"schema":{"type":"boolean"},"example":true}],"responses":{"200":{"description":"Non-Employee approval item object.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee approval item id","example":"2c1e388b-1e55-4b0a-ab5c-897f1204159c"},"approver":{"description":"Reference to the associated Identity","type":"object","properties":{"type":{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}},"accountName":{"type":"string","description":"Requested identity account name","example":"test.account"},"approvalStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status","example":"APPROVED"},"approvalOrder":{"type":"number","description":"Approval order","example":1,"format":"float"},"comment":{"type":"string","description":"comment of approver","example":"I approve"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}},{"type":"object","properties":{"nonEmployeeRequest":{"description":"Non-Employee request associated to this approval","allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee request id.","example":"ac110005-7156-1150-8171-5b292e3e0084"},"requester":{"type":"object","properties":{"type":{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}},"example":{"type":"IDENTITY","id":"2c9180866166b5b0016167c32ef31a66","name":"William Smith"}}}},{"type":"object","properties":{"accountName":{"type":"string","description":"Requested identity account name.","example":"william.smith"},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"nonEmployeeSource":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"},"sourceId":{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"},"description":{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}},{"type":"object","properties":{"schemaAttributes":{"description":"List of schema attributes associated with this non-employee source.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"UUID","example":"ac110005-7156-1150-8171-5b292e3e0084","description":"Schema Attribute Id"},"system":{"type":"boolean","description":"True if this schema attribute is mandatory on all non-employees sources.","example":true},"modified":{"type":"string","format":"date-time","description":"When the schema attribute was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the schema attribute was created.","example":"2019-08-23T18:40:35.772Z"},"type":{"type":"string","enum":["TEXT","DATE","IDENTITY"],"description":"Enum representing the type of data a schema attribute accepts.","example":"TEXT"},"label":{"type":"string","description":"Label displayed on the UI for this schema attribute.","example":"Account Name"},"technicalName":{"type":"string","description":"The technical name of the attribute. Must be unique per source.","example":"account.name"},"helpText":{"type":"string","description":"help text displayed by UI.","example":"The unique identifier for the account"},"placeholder":{"type":"string","description":"Hint text that fills UI box.","example":"Enter a unique user name for this account."},"required":{"type":"boolean","description":"If true, the schema attribute is required for all non-employees in the source","example":true}},"required":["type","technicalName","label"]}}}}]},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee.","example":{"description":"Auditing"}},"approvalStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status","example":"APPROVED"},"comment":{"type":"string","description":"comment of requester","example":"approved"},"completionDate":{"type":"string","format":"date-time","description":"When the request was completely approved.","example":"2020-03-24T11:11:41.139-05:00"},"startDate":{"type":"string","format":"date","description":"Non-Employee employment start date.","example":"2020-03-24"},"endDate":{"type":"string","format":"date","description":"Non-Employee employment end date.","example":"2021-03-25"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2020-03-24T11:11:41.139-05:00"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2020-03-24T11:11:41.139-05:00"}}}]}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-approvals/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get a non-employee approval item detail","description":{"content":"Gets a non-employee approval item detail. There are two contextual uses for this endpoint:\n 1. The user has the role context of `idn:nesr:read`, in which case they\ncan get any approval.\n 2. The user owns the requested approval.","type":"text/plain"},"url":{"path":["non-employee-approvals",":id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The object nonEmployeeRequest will not be included detail when set to false. *Default value is true*","type":"text/plain"},"key":"include-detail","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Non-Employee approval item id (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a non-employee approval item detail' (get-non-employee-approval)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a non-employee approval item detail + + + +Gets a non-employee approval item detail. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they +can get any approval. + 2. The user owns the requested approval. + +
    Path Parameters
    Query Parameters
    + +Non-Employee approval item object. + +
    Schema
      approver object
      + +Reference to the associated Identity + +
      nonEmployeeRequest object
      + +Non-Employee request associated to this approval + +
      requester object
      nonEmployeeSource object
      schemaAttributes object[]
      + +List of schema attributes associated with this non-employee source. + +
      data object
      + +Attribute blob/bag for a non-employee. + +
    • property name* string
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-non-employee-bulk-upload-status.api.mdx b/products/idn/api/v3/get-non-employee-bulk-upload-status.api.mdx new file mode 100644 index 000000000..018ccacb2 --- /dev/null +++ b/products/idn/api/v3/get-non-employee-bulk-upload-status.api.mdx @@ -0,0 +1,77 @@ +--- +id: get-non-employee-bulk-upload-status +sidebar_label: Obtain the status of bulk upload on the source +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getNonEmployeeBulkUploadStatus","tags":["Non-Employee Lifecycle Management"],"description":"The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source.\nRequires role context of `idn:nesr:read`\n","parameters":[{"in":"path","name":"id","description":"Source ID (UUID)","required":true,"schema":{"type":"string"},"example":"e136567de87e4d029e60b3c3c55db56d"}],"responses":{"200":{"description":"Status of the newest bulk-upload job, if any.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["PENDING","IN_PROGRESS","COMPLETED","ERROR"],"description":"Returns the following values indicating the progress or result of the bulk upload job.\n\"PENDING\" means the job is queued and waiting to be processed.\n\"IN_PROGRESS\" means the job is currently being processed.\n\"COMPLETED\" means the job has been completed without any errors.\n\"ERROR\" means the job failed to process with errors.\nnull means job has been submitted to the source.\n","example":"PENDING"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-sources/{id}/non-employee-bulk-upload/status","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Obtain the status of bulk upload on the source","description":{"content":"The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source.\nRequires role context of `idn:nesr:read`\n","type":"text/plain"},"url":{"path":["non-employee-sources",":id","non-employee-bulk-upload","status"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Source ID (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Obtain the status of bulk upload on the source' (get-non-employee-bulk-upload-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Obtain the status of bulk upload on the source + + + +The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. +Requires role context of `idn:nesr:read` + + +
    Path Parameters
    + +Status of the newest bulk-upload job, if any. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-non-employee-record.api.mdx b/products/idn/api/v3/get-non-employee-record.api.mdx new file mode 100644 index 000000000..d16f44b88 --- /dev/null +++ b/products/idn/api/v3/get-non-employee-record.api.mdx @@ -0,0 +1,80 @@ +--- +id: get-non-employee-record +sidebar_label: Get a Non-Employee Record +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getNonEmployeeRecord","tags":["Non-Employee Lifecycle Management"],"description":"This gets a non-employee record.\nRequires role context of `idn:nesr:read`","parameters":[{"in":"path","name":"id","description":"Non-Employee record id (UUID)","required":true,"example":"ef38f94347e94562b5bb8424a56397d8","schema":{"type":"string"}}],"responses":{"200":{"description":"Non-Employee record object","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee record id.","example":"ef38f94347e94562b5bb8424a56397d8"},"accountName":{"type":"string","description":"Requested identity account name.","example":"Abby.Smith"},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"sourceId":{"type":"string","description":"Non-Employee's source id.","example":"2c91808568c529c60168cca6f90c1313"},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee.","example":{"description":"Auditing"}},"startDate":{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2019-08-23T18:52:59.162Z"},"endDate":{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2020-08-23T18:52:59.162Z"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-records/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get a Non-Employee Record","description":{"content":"This gets a non-employee record.\nRequires role context of `idn:nesr:read`","type":"text/plain"},"url":{"path":["non-employee-records",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Non-Employee record id (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a Non-Employee Record' (get-non-employee-record)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a Non-Employee Record + + + +This gets a non-employee record. +Requires role context of `idn:nesr:read` + +
    Path Parameters
    + +Non-Employee record object + +
    Schema
      data object
      + +Attribute blob/bag for a non-employee. + +
    • property name* string
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-non-employee-request-summary.api.mdx b/products/idn/api/v3/get-non-employee-request-summary.api.mdx new file mode 100644 index 000000000..eb427637e --- /dev/null +++ b/products/idn/api/v3/get-non-employee-request-summary.api.mdx @@ -0,0 +1,79 @@ +--- +id: get-non-employee-request-summary +sidebar_label: Get Summary of Non-Employee Requests +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getNonEmployeeRequestSummary","security":[{"oauth2":[]}],"tags":["Non-Employee Lifecycle Management"],"description":"This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter:\n 1. The user has the role context of `idn:nesr:read`, in which case he or\nshe may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id.\n 2. The current user is an account manager, in which case \"me\" should be\nprovided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages.","parameters":[{"in":"path","name":"requested-for","description":"The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user.","required":true,"schema":{"type":"string","format":"uuid (if user is Org Admin)"},"example":"2c91808280430dfb0180431a59440460"}],"responses":{"200":{"description":"Non-Employee request summary object.","content":{"application/json":{"schema":{"type":"object","properties":{"approved":{"type":"integer","description":"The number of approved non-employee requests on all sources that *requested-for* user manages.","example":2,"format":"int32"},"rejected":{"type":"integer","description":"The number of rejected non-employee requests on all sources that *requested-for* user manages.","example":2,"format":"int32"},"pending":{"type":"integer","description":"The number of pending non-employee requests on all sources that *requested-for* user manages.","example":2,"format":"int32"},"nonEmployeeCount":{"type":"integer","description":"The number of non-employee records on all sources that *requested-for* user manages.","example":2,"format":"int32"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-requests/summary/{requested-for}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get Summary of Non-Employee Requests","description":{"content":"This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter:\n 1. The user has the role context of `idn:nesr:read`, in which case he or\nshe may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id.\n 2. The current user is an account manager, in which case \"me\" should be\nprovided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages.","type":"text/plain"},"url":{"path":["non-employee-requests","summary",":requested-for"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user.","type":"text/plain"},"type":"any","value":"","key":"requested-for"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Summary of Non-Employee Requests' (get-non-employee-request-summary)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Summary of Non-Employee Requests + + + +This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. + 2. The current user is an account manager, in which case "me" should be +provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. + +
    Path Parameters
    + +Non-Employee request summary object. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-non-employee-request.api.mdx b/products/idn/api/v3/get-non-employee-request.api.mdx new file mode 100644 index 000000000..d70573cea --- /dev/null +++ b/products/idn/api/v3/get-non-employee-request.api.mdx @@ -0,0 +1,103 @@ +--- +id: get-non-employee-request +sidebar_label: Get a Non-Employee Request +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getNonEmployeeRequest","security":[{"oauth2":[]}],"tags":["Non-Employee Lifecycle Management"],"description":"This gets a non-employee request.\nThere are two contextual uses for this endpoint:\n 1. The user has the role context of `idn:nesr:read`, in this case the user\ncan get the non-employee request for any user.\n 2. The user must be the owner of the non-employee request.","parameters":[{"in":"path","name":"id","description":"Non-Employee request id (UUID)","example":"ac110005-7156-1150-8171-5b292e3e0084","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Non-Employee request object.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"},"sourceId":{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"},"description":{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}},{"type":"object","properties":{"accountName":{"type":"string","description":"Requested identity account name.","example":"william.smith"},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"nonEmployeeSource":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"},"sourceId":{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"},"description":{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee.","example":{"description":"Auditing"}},"approvalItems":{"description":"List of approval item for the request","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee approval item id","example":"2c1e388b-1e55-4b0a-ab5c-897f1204159c"},"approver":{"description":"Reference to the associated Identity","type":"object","properties":{"type":{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}},"accountName":{"type":"string","description":"Requested identity account name","example":"test.account"},"approvalStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status","example":"APPROVED"},"approvalOrder":{"type":"number","description":"Approval order","example":1,"format":"float"},"comment":{"type":"string","description":"comment of approver","example":"I approve"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}}},"approvalStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status","example":"APPROVED"},"comment":{"type":"string","description":"comment of requester","example":"approved"},"completionDate":{"type":"string","format":"date-time","description":"When the request was completely approved.","example":"2020-03-24T11:11:41.139-05:00"},"startDate":{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2020-03-24T00:00:00-05:00"},"endDate":{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2021-03-25T00:00:00-05:00"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2020-03-24T11:11:41.139-05:00"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2020-03-24T11:11:41.139-05:00"}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-requests/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get a Non-Employee Request","description":{"content":"This gets a non-employee request.\nThere are two contextual uses for this endpoint:\n 1. The user has the role context of `idn:nesr:read`, in this case the user\ncan get the non-employee request for any user.\n 2. The user must be the owner of the non-employee request.","type":"text/plain"},"url":{"path":["non-employee-requests",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Non-Employee request id (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a Non-Employee Request' (get-non-employee-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a Non-Employee Request + + + +This gets a non-employee request. +There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in this case the user +can get the non-employee request for any user. + 2. The user must be the owner of the non-employee request. + +
    Path Parameters
    + +Non-Employee request object. + +
    Schema
      nonEmployeeSource object
      data object
      + +Attribute blob/bag for a non-employee. + +
    • property name* string
      • approvalItems object[]
      + +List of approval item for the request + +
      approver object
      + +Reference to the associated Identity + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-non-employee-schema-attribute.api.mdx b/products/idn/api/v3/get-non-employee-schema-attribute.api.mdx new file mode 100644 index 000000000..8060acabb --- /dev/null +++ b/products/idn/api/v3/get-non-employee-schema-attribute.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-non-employee-schema-attribute +sidebar_label: Get Schema Attribute Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getNonEmployeeSchemaAttribute","security":[{"oauth2":[]}],"tags":["Non-Employee Lifecycle Management"],"description":"This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source.","parameters":[{"in":"path","name":"attributeId","schema":{"type":"string"},"required":true,"example":"ef38f94347e94562b5bb8424a56397d8","description":"The Schema Attribute Id (UUID)"},{"in":"path","name":"sourceId","schema":{"type":"string"},"required":true,"example":"ef38f94347e94562b5bb8424a56397d8","description":"The Source id"}],"responses":{"200":{"description":"The Schema Attribute","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"UUID","example":"ac110005-7156-1150-8171-5b292e3e0084","description":"Schema Attribute Id"},"system":{"type":"boolean","description":"True if this schema attribute is mandatory on all non-employees sources.","example":true},"modified":{"type":"string","format":"date-time","description":"When the schema attribute was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the schema attribute was created.","example":"2019-08-23T18:40:35.772Z"},"type":{"type":"string","enum":["TEXT","DATE","IDENTITY"],"description":"Enum representing the type of data a schema attribute accepts.","example":"TEXT"},"label":{"type":"string","description":"Label displayed on the UI for this schema attribute.","example":"Account Name"},"technicalName":{"type":"string","description":"The technical name of the attribute. Must be unique per source.","example":"account.name"},"helpText":{"type":"string","description":"help text displayed by UI.","example":"The unique identifier for the account"},"placeholder":{"type":"string","description":"Hint text that fills UI box.","example":"Enter a unique user name for this account."},"required":{"type":"boolean","description":"If true, the schema attribute is required for all non-employees in the source","example":true}},"required":["type","technicalName","label"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-sources/{sourceId}/schema-attributes/{attributeId}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get Schema Attribute Non-Employee Source","description":{"content":"This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source.","type":"text/plain"},"url":{"path":["non-employee-sources",":sourceId","schema-attributes",":attributeId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Schema Attribute Id (UUID)","type":"text/plain"},"type":"any","value":"","key":"attributeId"},{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Schema Attribute Non-Employee Source' (get-non-employee-schema-attribute)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Schema Attribute Non-Employee Source + + + +This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + +
    Path Parameters
    + +The Schema Attribute + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-non-employee-source-schema-attributes.api.mdx b/products/idn/api/v3/get-non-employee-source-schema-attributes.api.mdx new file mode 100644 index 000000000..b19d38da6 --- /dev/null +++ b/products/idn/api/v3/get-non-employee-source-schema-attributes.api.mdx @@ -0,0 +1,88 @@ +--- +id: get-non-employee-source-schema-attributes +sidebar_label: List Schema Attributes Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getNonEmployeeSourceSchemaAttributes","security":[{"oauth2":[]}],"tags":["Non-Employee Lifecycle Management"],"description":"This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned.\nRequires role context of `idn:nesr:read` or the user must be an account manager of the source.","parameters":[{"in":"path","name":"sourceId","schema":{"type":"string"},"required":true,"example":"ef38f94347e94562b5bb8424a56397d8","description":"The Source id"}],"responses":{"200":{"description":"A list of Schema Attributes","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"UUID","example":"ac110005-7156-1150-8171-5b292e3e0084","description":"Schema Attribute Id"},"system":{"type":"boolean","description":"True if this schema attribute is mandatory on all non-employees sources.","example":true},"modified":{"type":"string","format":"date-time","description":"When the schema attribute was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the schema attribute was created.","example":"2019-08-23T18:40:35.772Z"},"type":{"type":"string","enum":["TEXT","DATE","IDENTITY"],"description":"Enum representing the type of data a schema attribute accepts.","example":"TEXT"},"label":{"type":"string","description":"Label displayed on the UI for this schema attribute.","example":"Account Name"},"technicalName":{"type":"string","description":"The technical name of the attribute. Must be unique per source.","example":"account.name"},"helpText":{"type":"string","description":"help text displayed by UI.","example":"The unique identifier for the account"},"placeholder":{"type":"string","description":"Hint text that fills UI box.","example":"Enter a unique user name for this account."},"required":{"type":"boolean","description":"If true, the schema attribute is required for all non-employees in the source","example":true}},"required":["type","technicalName","label"]},"maxItems":18}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-sources/{sourceId}/schema-attributes","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List Schema Attributes Non-Employee Source","description":{"content":"This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned.\nRequires role context of `idn:nesr:read` or the user must be an account manager of the source.","type":"text/plain"},"url":{"path":["non-employee-sources",":sourceId","schema-attributes"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Schema Attributes Non-Employee Source' (get-non-employee-source-schema-attributes)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Schema Attributes Non-Employee Source + + + +This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. +Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + +
    Path Parameters
    + +A list of Schema Attributes + +
    Schema array
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-non-employee-source.api.mdx b/products/idn/api/v3/get-non-employee-source.api.mdx new file mode 100644 index 000000000..ec88d2ee6 --- /dev/null +++ b/products/idn/api/v3/get-non-employee-source.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-non-employee-source +sidebar_label: Get a Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getNonEmployeeSource","security":[{"oauth2":[]}],"tags":["Non-Employee Lifecycle Management"],"description":"This gets a non-employee source. There are two contextual uses for the requested-for path parameter: \n 1. The user has the role context of `idn:nesr:read`, in which case he or\nshe may request any source.\n 2. The current user is an account manager, in which case the user can only\nrequest sources that they own.","parameters":[{"in":"path","name":"sourceId","description":"Source Id","example":"2c91808b7c28b350017c2a2ec5790aa1","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Non-Employee source object.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"},"sourceId":{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"},"description":{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}},{"type":"object","properties":{"approvers":{"description":"List of approvers","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}}},"accountManagers":{"description":"List of account managers","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}}},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-sources/{sourceId}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get a Non-Employee Source","description":{"content":"This gets a non-employee source. There are two contextual uses for the requested-for path parameter: \n 1. The user has the role context of `idn:nesr:read`, in which case he or\nshe may request any source.\n 2. The current user is an account manager, in which case the user can only\nrequest sources that they own.","type":"text/plain"},"url":{"path":["non-employee-sources",":sourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Source Id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a Non-Employee Source' (get-non-employee-source)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a Non-Employee Source + + + +This gets a non-employee source. There are two contextual uses for the requested-for path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request any source. + 2. The current user is an account manager, in which case the user can only +request sources that they own. + +
    Path Parameters
    + +Non-Employee source object. + +
    Schema
      approvers object[]
      + +List of approvers + +
      accountManagers object[]
      + +List of account managers + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-oauth-client.api.mdx b/products/idn/api/v3/get-oauth-client.api.mdx new file mode 100644 index 000000000..f43c1a4f1 --- /dev/null +++ b/products/idn/api/v3/get-oauth-client.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-oauth-client +sidebar_label: Get OAuth Client +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getOauthClient","security":[{"oauth2":["sp:oauth-client:manage","sp:oauth-client:read"]}],"tags":["OAuth Clients"],"description":"This gets details of an OAuth client.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The OAuth client id","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"Request succeeded.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the OAuth client","example":"2c9180835d2e5168015d32f890ca1581"},"businessName":{"type":"string","nullable":true,"description":"The name of the business the API Client should belong to","example":"Acme-Solar"},"homepageUrl":{"type":"string","nullable":true,"description":"The homepage URL associated with the owner of the API Client","example":"http://localhost:12345"},"name":{"type":"string","description":"A human-readable name for the API Client","example":"Demo API Client"},"description":{"type":"string","nullable":true,"description":"A description of the API Client","example":"An API client used for the authorization_code, refresh_token, and client_credentials flows"},"accessTokenValiditySeconds":{"type":"integer","format":"int32","description":"The number of seconds an access token generated for this API Client is valid for","example":750},"refreshTokenValiditySeconds":{"type":"integer","format":"int32","description":"The number of seconds a refresh token generated for this API Client is valid for","example":86400},"redirectUris":{"type":"array","nullable":true,"items":{"type":"string"},"description":"A list of the approved redirect URIs used with the authorization_code flow","example":["http://localhost:12345"]},"grantTypes":{"type":"array","items":{"description":"OAuth2 Grant Type","type":"string","example":"CLIENT_CREDENTIALS","enum":["CLIENT_CREDENTIALS","AUTHORIZATION_CODE","REFRESH_TOKEN"]},"description":"A list of OAuth 2.0 grant types this API Client can be used with","example":["AUTHORIZATION_CODE","CLIENT_CREDENTIALS","REFRESH_TOKEN"]},"accessType":{"description":"The access type (online or offline) of this API Client","example":"OFFLINE","type":"string","enum":["ONLINE","OFFLINE"]},"type":{"description":"The type of the API Client (public or confidential)","example":"CONFIDENTIAL","type":"string","enum":["CONFIDENTIAL","PUBLIC"]},"internal":{"type":"boolean","description":"An indicator of whether the API Client can be used for requests internal to IDN","example":false},"enabled":{"type":"boolean","description":"An indicator of whether the API Client is enabled for use","example":true},"strongAuthSupported":{"type":"boolean","description":"An indicator of whether the API Client supports strong authentication","example":false},"claimsSupported":{"type":"boolean","description":"An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow","example":false},"created":{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when the API Client was created","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when the API Client was last updated","example":"2018-06-25T20:22:28.104Z"},"lastUsed":{"type":"string","nullable":true,"format":"date-time","description":"The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed.","example":"2017-07-11T18:45:37.098Z"},"scope":{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the API Client.","example":["demo:api-client-scope:first","demo:api-client-scope:second"]}},"required":["id","businessName","homepageUrl","name","description","accessTokenValiditySeconds","refreshTokenValiditySeconds","redirectUris","grantTypes","accessType","type","internal","enabled","strongAuthSupported","claimsSupported","created","modified","scope"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/oauth-clients/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get OAuth Client","description":{"content":"This gets details of an OAuth client.","type":"text/plain"},"url":{"path":["oauth-clients",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The OAuth client id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get OAuth Client' (get-oauth-client)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get OAuth Client + + + +This gets details of an OAuth client. + +
    Path Parameters
    + +Request succeeded. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-password-change-status.api.mdx b/products/idn/api/v3/get-password-change-status.api.mdx new file mode 100644 index 000000000..568a197a6 --- /dev/null +++ b/products/idn/api/v3/get-password-change-status.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-password-change-status +sidebar_label: Get Password Change Request Status +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getPasswordChangeStatus","tags":["Password Management"],"description":"This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"example":"089899f13a8f4da7824996191587bab9","description":"Password change request ID"}],"responses":{"200":{"description":"Status of the password change request","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","nullable":true,"description":"The password change request ID","example":"089899f13a8f4da7824996191587bab9"},"state":{"type":"string","enum":["IN_PROGRESS","FINISHED","FAILED"],"description":"Password change state","example":"IN_PROGRESS"},"errors":{"type":"array","items":{"type":"string"},"description":"The errors during the password change request","example":["The password change payload is invalid"]},"sourceIds":{"type":"array","items":{"type":"string"},"description":"List of source IDs in the password change request","example":["2c918083746f642c01746f990884012a"]}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/password-change-status/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get Password Change Request Status","description":{"content":"This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API.","type":"text/plain"},"url":{"path":["password-change-status",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Password change request ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Password Change Request Status' (get-password-change-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Password Change Request Status + + + +This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API. + +
    Path Parameters
    + +Status of the password change request + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-password-dictionary.api.mdx b/products/idn/api/v3/get-password-dictionary.api.mdx new file mode 100644 index 000000000..309f26a34 --- /dev/null +++ b/products/idn/api/v3/get-password-dictionary.api.mdx @@ -0,0 +1,116 @@ +--- +id: get-password-dictionary +sidebar_label: Get Password Dictionary +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getPasswordDictionary","tags":["Password Dictionary"],"description":"This gets password dictionary for the organization.\nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:password-dictionary-management:read"]}],"responses":{"200":{"description":"\nThe password dictionary file can contain lines that are:\n1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing\n2. empty lines\n3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines\n4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed;\n maximum length of the line is 128 Unicode codepoints\n\n\nPassword dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line).\n Password dict file must contain UTF-8 characters only.\n\n# Sample password text file\n\n```\n\n# Password dictionary small test file\n\nlocale=en_US\n\n# Password dictionary prohibited words\n\nqwerty\nabcd\naaaaa\npassword\nqazxsws\n\n```","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/password-dictionary","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get Password Dictionary","description":{"content":"This gets password dictionary for the organization.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["password-dictionary"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"text/plain"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Password Dictionary' (get-password-dictionary)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Password Dictionary + + + +This gets password dictionary for the organization. +A token with ORG_ADMIN authority is required to call this API. + +
    + + +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +
    Schema
    • string
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-password-org-config.api.mdx b/products/idn/api/v3/get-password-org-config.api.mdx new file mode 100644 index 000000000..05f132b8c --- /dev/null +++ b/products/idn/api/v3/get-password-org-config.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-password-org-config +sidebar_label: Get Password Org Config +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getPasswordOrgConfig","tags":["Password Configuration"],"description":"This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read'","security":[{"oauth2":["idn:password-org-config:read"]}],"responses":{"200":{"description":"Reference to the password org config.","content":{"application/json":{"schema":{"type":"object","properties":{"customInstructionsEnabled":{"type":"boolean","description":"Indicator whether custom password instructions feature is enabled. The default value is false.","default":false,"example":true},"digitTokenEnabled":{"type":"boolean","description":"Indicator whether \"digit token\" feature is enabled. The default value is false.","default":false,"example":true},"digitTokenDurationMinutes":{"type":"integer","format":"int32","description":"The duration of \"digit token\" in minutes. The default value is 5.","minimum":1,"maximum":60,"default":5,"example":10},"digitTokenLength":{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}},"example":{"customInstructionsEnabled":true,"digitTokenDurationMinutes":9,"digitTokenEnabled":false,"digitTokenLength":6}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/password-org-config","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get Password Org Config","description":{"content":"This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read'","type":"text/plain"},"url":{"path":["password-org-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Password Org Config' (get-password-org-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Password Org Config + + + +This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read' + +
    + +Reference to the password org config. + +
    Schema
      = 1` and `<= 60`"} defaultValue={5}>= 6` and `<= 18`"} defaultValue={6}>
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-password-sync-group.api.mdx b/products/idn/api/v3/get-password-sync-group.api.mdx new file mode 100644 index 000000000..dd74e24d1 --- /dev/null +++ b/products/idn/api/v3/get-password-sync-group.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-password-sync-group +sidebar_label: Get Password Sync Group by ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getPasswordSyncGroup","tags":["Password Sync Groups"],"description":"This API returns the sync group for the specified ID. A token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:password-sync-group-management:read"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of password sync group to retrieve.","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"}],"responses":{"200":{"description":"Reference to the password sync group.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the sync group","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"},"name":{"description":"Name of the sync group","type":"string","example":"Password Sync Group 1"},"passwordPolicyId":{"type":"string","description":"ID of the password policy","example":"2c91808d744ba0ce01746f93b6204501"},"sourceIds":{"type":"array","description":"List of password managed sources IDs","items":{"type":"string"},"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}},"example":{"id":"6881f631-3bd5-4213-9c75-8e05cc3e35dd","name":"Password Sync Group 1","passwordPolicyId":"2c91808d744ba0ce01746f93b6204501","sourceIds":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/password-sync-groups/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get Password Sync Group by ID","description":{"content":"This API returns the sync group for the specified ID. A token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["password-sync-groups",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of password sync group to retrieve.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Password Sync Group by ID' (get-password-sync-group)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Password Sync Group by ID + + + +This API returns the sync group for the specified ID. A token with ORG_ADMIN authority is required to call this API. + +
    Path Parameters
    + +Reference to the password sync group. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-password-sync-groups.api.mdx b/products/idn/api/v3/get-password-sync-groups.api.mdx new file mode 100644 index 000000000..4f947562a --- /dev/null +++ b/products/idn/api/v3/get-password-sync-groups.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-password-sync-groups +sidebar_label: Get Password Sync Group List +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getPasswordSyncGroups","tags":["Password Sync Groups"],"description":"This API returns a list of password sync groups. A token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:password-sync-group-management:read"]}],"parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"A list of password sync groups.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the sync group","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"},"name":{"description":"Name of the sync group","type":"string","example":"Password Sync Group 1"},"passwordPolicyId":{"type":"string","description":"ID of the password policy","example":"2c91808d744ba0ce01746f93b6204501"},"sourceIds":{"type":"array","description":"List of password managed sources IDs","items":{"type":"string"},"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/password-sync-groups","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get Password Sync Group List","description":{"content":"This API returns a list of password sync groups. A token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["password-sync-groups"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Password Sync Group List' (get-password-sync-groups)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Password Sync Group List + + + +This API returns a list of password sync groups. A token with ORG_ADMIN authority is required to call this API. + +
    Query Parameters
    + +A list of password sync groups. + +
    Schema array
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-provisioning-policy.api.mdx b/products/idn/api/v3/get-provisioning-policy.api.mdx new file mode 100644 index 000000000..0fb798357 --- /dev/null +++ b/products/idn/api/v3/get-provisioning-policy.api.mdx @@ -0,0 +1,88 @@ +--- +id: get-provisioning-policy +sidebar_label: Get Provisioning Policy by UsageType +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getProvisioningPolicy","tags":["Sources"],"description":"This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow.\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","security":[{"oauth2":["idn:provisioning-policy:read","idn:provisioning-policy-source:read","idn:provisioning-policy:manage","idn:provisioning-policy-source-admin-operations:manage"]}],"parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source ID.","example":"2c9180835d191a86015d28455b4a2329"},{"in":"path","name":"usageType","required":true,"schema":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"description":"The type of ProvisioningPolicy usage.","example":"REGISTER"}],"responses":{"200":{"description":"The requested ProvisioningPolicyDto was successfully retrieved.","content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"the provisioning policy name","example":"example provisioning policy for inactive identities"},"description":{"type":"string","description":"the description of the provisioning policy","example":"this provisioning policy creates access based on an identity going inactive"},"usageType":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"userName"},"transform":{"type":"object","description":"The transform to apply to the field","example":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"default":{}},"attributes":{"type":"object","description":"Attributes required for the transform","example":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"}},"isRequired":{"type":"boolean","readOnly":true,"description":"Flag indicating whether or not the attribute is required.","default":false,"example":false},"type":{"type":"string","description":"The type of the attribute.","example":"string"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","default":false,"example":false}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sources/{sourceId}/provisioning-policies/{usageType}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get Provisioning Policy by UsageType","description":{"content":"This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow.\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":sourceId","provisioning-policies",":usageType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source ID.","type":"text/plain"},"type":"any","value":"","key":"sourceId"},{"disabled":false,"description":{"content":"(Required) The type of ProvisioningPolicy usage.","type":"text/plain"},"type":"any","value":"","key":"usageType"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Provisioning Policy by UsageType' (get-provisioning-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Provisioning Policy by UsageType + + + +This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. +A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +
    Path Parameters
    + +The requested ProvisioningPolicyDto was successfully retrieved. + +
    Schema
      fields object[]
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-public-identities.api.mdx b/products/idn/api/v3/get-public-identities.api.mdx new file mode 100644 index 000000000..8c022c4c3 --- /dev/null +++ b/products/idn/api/v3/get-public-identities.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-public-identities +sidebar_label: Get a list of public identities +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getPublicIdentities","tags":["Public Identities"],"parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"required":false,"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**alias**: *eq, sw*\n\n**email**: *eq, sw*\n\n**firstname**: *eq, sw*\n\n**lastname**: *eq, sw*","example":"firstname eq \"John\""},{"in":"query","name":"add-core-filters","description":"If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*:\n - Should be either correlated or protected.\n - Should not be \"spadmin\" or \"cloudadmin\".\n - uid should not be null.\n - lastname should not be null.\n - email should not be null.","required":false,"example":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"required":false,"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**","example":"name"}],"responses":{"200":{"description":"A list of public identity objects.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","title":"Public Identity","description":"Details about a public identity","properties":{"id":{"type":"string","description":"Identity id","example":"2c9180857182305e0171993735622948"},"name":{"type":"string","description":"Human-readable display name of identity.","example":"Alison Ferguso"},"alias":{"type":"string","description":"Alternate unique identifier for the identity.","example":"alison.ferguso"},"email":{"nullable":true,"type":"string","description":"Email address of identity.","example":"alison.ferguso@acme-solar.com"},"status":{"nullable":true,"type":"string","description":"The lifecycle status for the identity","example":"Active"},"manager":{"description":"An identity reference to the manager of this identity","type":"object","nullable":true,"properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of identity.","example":"Thomas Edison"}}},"attributes":{"type":"array","description":"The public identity attributes of the identity","items":{"type":"object","properties":{"key":{"type":"string","description":"The attribute key","example":"country"},"name":{"type":"string","description":"Human-readable display name of the attribute","example":"Country"},"value":{"type":"string","description":"The attribute value","example":"US"}}}}}}},"example":[{"id":"2c9180857182305e0171993735622948","name":"Alison Ferguso","alias":"alison.ferguso","email":"alison.ferguso@acme-solar.com","status":"Active","manager":{"type":"IDENTITY","id":"2c9180a46faadee4016fb4e018c20639","name":"Thomas Edison"},"attributes":[{"key":"phone","name":"Phone","value":"5125551234"},{"key":"country","name":"Country","value":"US"}]},{"id":"2c9180a46faadee4016fb4e018c20639","name":"Thomas Edison","alias":"thomas.edison","email":"thomas.edison@acme-solar.com","status":"Active","manager":{"type":"IDENTITY","id":"2c918086676d3e0601677611dbde220f","name":"Mister Manager"},"attributes":[{"key":"phone","name":"Phone","value":"5125554321"},{"key":"country","name":"Country","value":"US"}]}]}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"description":"Get a list of public identities","method":"get","path":"/public-identities","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get a list of public identities","description":{"type":"text/plain"},"url":{"path":["public-identities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**alias**: *eq, sw*\n\n**email**: *eq, sw*\n\n**firstname**: *eq, sw*\n\n**lastname**: *eq, sw*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*:\n - Should be either correlated or protected.\n - Should not be \"spadmin\" or \"cloudadmin\".\n - uid should not be null.\n - lastname should not be null.\n - email should not be null.","type":"text/plain"},"key":"add-core-filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a list of public identities' (get-public-identities)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a list of public identities + + + +Get a list of public identities + +
    Query Parameters
    + +A list of public identity objects. + +
    Schema array
      manager object
      + +An identity reference to the manager of this identity + +
      attributes object[]
      + +The public identity attributes of the identity + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-public-identity-config.api.mdx b/products/idn/api/v3/get-public-identity-config.api.mdx new file mode 100644 index 000000000..10eadf17e --- /dev/null +++ b/products/idn/api/v3/get-public-identity-config.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-public-identity-config +sidebar_label: Get the Public Identities Configuration +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getPublicIdentityConfig","tags":["Public Identities Config"],"description":"Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. A token with ORG ADMIN authority is required to call this API.","responses":{"200":{"description":"Request succeeded.","content":{"application/json":{"schema":{"type":"object","description":"Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org.","properties":{"attributes":{"type":"array","description":"Up to 5 identity attributes that will be available to everyone in the org for all users in the org.","items":{"type":"object","description":"Used to map an attribute key for an Identity to its display name.","properties":{"key":{"type":"string","description":"The attribute key","example":"country"},"name":{"type":"string","description":"The attribute display name","example":"Country"}}}},"modified":{"nullable":true,"type":"string","description":"When this configuration was last modified.","format":"date-time","example":"2018-06-25T20:22:28.104Z"},"modifiedBy":{"description":"The identity who last modified this configuration.","type":"object","nullable":true,"properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of identity.","example":"Thomas Edison"}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/public-identities-config","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get the Public Identities Configuration","description":{"content":"Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. A token with ORG ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["public-identities-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get the Public Identities Configuration' (get-public-identity-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get the Public Identities Configuration + + + +Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. A token with ORG ADMIN authority is required to call this API. + +
    + +Request succeeded. + +
    Schema
      attributes object[]
      + +Up to 5 identity attributes that will be available to everyone in the org for all users in the org. + +
      modifiedBy object
      + +The identity who last modified this configuration. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-role-assigned-identities.api.mdx b/products/idn/api/v3/get-role-assigned-identities.api.mdx new file mode 100644 index 000000000..a789dcfcb --- /dev/null +++ b/products/idn/api/v3/get-role-assigned-identities.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-role-assigned-identities +sidebar_label: List Identities assigned a Role +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRoleAssignedIdentities","tags":["Roles"],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"description":"ID of the Role for which the assigned Identities are to be listed","example":"2c91808a7813090a017814121e121518","required":true},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**aliasName**: *eq, sw*\n\n**email**: *eq, sw*\n\n**name**: *eq, sw, co*","example":"name sw Joe"},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **id**, **name**, **aliasName**, **email**","example":"aliasName,name"}],"responses":{"200":{"description":"List of Identities assigned the Role","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"A subset of the fields of an Identity which is a member of a Role.","properties":{"id":{"type":"string","description":"The ID of the Identity","example":"2c9180a46faadee4016fb4e018c20639"},"aliasName":{"type":"string","description":"The alias / username of the Identity","example":"t.edison"},"name":{"type":"string","description":"The human-readable display name of the Identity","example":"Thomas Edison"},"email":{"type":"string","description":"Email address of the Identity","example":"t.edison@identitynow.com"},"roleAssignmentSource":{"type":"string","enum":["ACCESS_REQUEST","ROLE_MEMBERSHIP"],"description":"Type which indicates how a particular Identity obtained a particular Role","example":"ACCESS_REQUEST"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:role-unchecked:read","idn:role-unchecked:manage","idn:role-checked:manage","idn:role-checked:read"]}],"description":"List Identities assigned a Role","method":"get","path":"/roles/{id}/assigned-identities","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List Identities assigned a Role","description":{"type":"text/plain"},"url":{"path":["roles",":id","assigned-identities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**aliasName**: *eq, sw*\n\n**email**: *eq, sw*\n\n**name**: *eq, sw, co*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **id**, **name**, **aliasName**, **email**","type":"text/plain"},"key":"sorters","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Role for which the assigned Identities are to be listed","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Identities assigned a Role' (get-role-assigned-identities)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Identities assigned a Role + + + +List Identities assigned a Role + +
    Path Parameters
    Query Parameters
    + +List of Identities assigned the Role + +
    Schema array
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-role.api.mdx b/products/idn/api/v3/get-role.api.mdx new file mode 100644 index 000000000..b8f84b1e9 --- /dev/null +++ b/products/idn/api/v3/get-role.api.mdx @@ -0,0 +1,133 @@ +--- +id: get-role +sidebar_label: Get a Role +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRole","tags":["Roles"],"description":"This API returns a Role by its ID.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"ID of the Role","example":"2c91808a7813090a017814121e121518"}],"responses":{"200":{"description":"List of all Roles","content":{"application/json":{"schema":{"type":"object","description":"A Role","properties":{"id":{"type":"string","description":"The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.","example":"2c918086749d78830174a1a40e121518"},"name":{"type":"string","description":"The human-readable display name of the Role","maxLength":128,"example":"Role 2567"},"created":{"type":"string","description":"Date the Role was created","format":"date-time","example":"2021-03-01T22:32:58.104Z","readOnly":true},"modified":{"type":"string","description":"Date the Role was last modified.","format":"date-time","example":"2021-03-02T20:22:28.104Z","readOnly":true},"description":{"type":"string","nullable":true,"description":"A human-readable description of the Role","example":"Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor."},"owner":{"type":"object","nullable":true,"description":"The owner of this object.","properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"accessProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the Access Profile","example":"ff808081751e6e129f1518161919ecca"},"type":{"type":"string","description":"Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result.","enum":["ACCESS_PROFILE"],"example":"ACCESS_PROFILE"},"name":{"type":"string","description":"Human-readable display name of the Access Profile. This field is ignored on input.","example":"Access Profile 2567"}}},"nullable":true},"membership":{"nullable":true,"type":"object","description":"When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.","properties":{"type":{"type":"string","enum":["STANDARD","IDENTITY_LIST"],"description":"This enum characterizes the type of a Role's membership selector. Only the following two are fully supported:\n\nSTANDARD: Indicates that Role membership is defined in terms of a criteria expression\n\nIDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed","example":"IDENTITY_LIST"},"criteria":{"nullable":true,"type":"object","description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","nullable":true,"description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","nullable":true,"description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","nullable":true,"description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa."}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa."}}},"identities":{"type":"array","items":{"type":"object","description":"A reference to an Identity in an IDENTITY_LIST role membership criteria.","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY","nullable":true},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","nullable":true,"description":"Human-readable display name of the Identity.","example":"Thomas Edison"},"aliasName":{"type":"string","nullable":true,"description":"User name of the Identity","example":"t.edison"}}},"nullable":true,"description":"Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST."}}},"legacyMembershipInfo":{"type":"object","nullable":true,"description":"This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.","example":{"type":"IDENTITY_LIST"},"additionalProperties":true},"enabled":{"type":"boolean","description":"Whether the Role is enabled or not.","example":true,"default":false},"requestable":{"type":"boolean","description":"Whether the Role can be the target of access requests.","example":true,"default":false},"accessRequestConfig":{"nullable":true,"description":"Access request configuration for this object","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":true,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":true,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n\n**OWNER**: Owner of the associated Role\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"revocationRequestConfig":{"nullable":true,"default":null,"description":"Revocation request configuration for this object.","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":false,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":false,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the revocation request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"segments":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of IDs of segments, if any, to which this Role is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]}},"required":["name","owner"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:role-unchecked:read","idn:role-unchecked:manage","idn:role-checked:manage","idn:role-checked:read"]}],"method":"get","path":"/roles/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get a Role","description":{"content":"This API returns a Role by its ID.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.","type":"text/plain"},"url":{"path":["roles",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Role","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a Role' (get-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a Role + + + +This API returns a Role by its ID. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +
    Path Parameters
    + +List of all Roles + +
    Schema
      owner object
      + +The owner of this object. + +
      accessProfiles object[]
      membership object
      + +When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities. + +
      criteria object
      + +Defines STANDARD type Role membership + +
      key object
      + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
      children object[]
      + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + +
      key object
      + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
      children object[]
      + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + +
      key object
      + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
      identities object[]
      + +Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. + +
      legacyMembershipInfo object
      + +This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. + +
      accessRequestConfig object
      + +Access request configuration for this object + +
      approvalSchemes object[]
      + +List describing the steps in approving the request + +
      revocationRequestConfig object
      + +Revocation request configuration for this object. + +
      approvalSchemes object[]
      + +List describing the steps in approving the revocation request + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-saved-search.api.mdx b/products/idn/api/v3/get-saved-search.api.mdx new file mode 100644 index 000000000..476b17879 --- /dev/null +++ b/products/idn/api/v3/get-saved-search.api.mdx @@ -0,0 +1,116 @@ +--- +id: get-saved-search +sidebar_label: Return saved search by ID +hide_title: true +hide_table_of_contents: true +api: {"tags":["Saved Search"],"description":"Returns the specified saved search.\n","operationId":"getSavedSearch","parameters":[{"in":"path","name":"id","description":"ID of the requested document.","schema":{"type":"string"},"required":true,"example":"2c91808568c529c60168cca6f90c1313"}],"responses":{"200":{"description":"The requested saved search.","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"id":{"description":"The saved search ID.\n","type":"string","example":"0de46054-fe90-434a-b84e-c6b3359d0c64"},"owner":{"description":"The owner of the saved search.\n","type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"description":"The id of the object.\n","type":"string","example":"2c91808568c529c60168cca6f90c1313"}},"required":["type","id"]}}},{"type":"object","properties":{"name":{"description":"The name of the saved search.\n","type":"string","example":"Disabled accounts"},"description":{"description":"The description of the saved search.\n","type":"string","nullable":true,"example":"Disabled accounts"}}},{"type":"object","properties":{"public":{"description":"Indicates if the saved search is public.\n","type":"boolean","default":false,"example":false},"created":{"description":"The date the saved search was initially created.\n","type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"},"modified":{"description":"The last date the saved search was modified.\n","type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"},"indices":{"description":"The names of the Elasticsearch indices in which to search.\n","type":"array","items":{"description":"Enum representing the currently supported indices.\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofiles","accountactivities","entitlements","events","identities","roles","*"],"example":"identities"},"example":["identities"]},"columns":{"description":"The columns to be returned (specifies the order in which they will be presented) for each document type.\n\nThe currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_.\n","type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"field":{"description":"The name of the field.\n","type":"string","example":"email"},"header":{"description":"The value of the header.\n","type":"string","example":"Work Email"}},"required":["field"]}},"example":{"identity":[{"field":"displayName","header":"Display Name"},{"field":"e-mail","header":"Work Email"}]}},"query":{"description":"The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL.\n","type":"string","example":"@accounts(disabled:true)"},"fields":{"description":"The fields to be searched against in a multi-field query.\n","type":"array","nullable":true,"items":{"type":"string"},"example":["disabled"]},"sort":{"description":"The fields to be used to sort the search results.\n","type":"array","items":{"type":"string"},"example":["displayName"]},"filters":{"nullable":true,"allOf":[{"type":"object","description":"The filters to be applied for each filtered field name.","example":{"attributes.cloudAuthoritativeSource":{"type":"EXISTS","exclude":true},"accessCount":{"type":"RANGE","range":{"lower":{"value":"3"}}},"created":{"type":"RANGE","range":{"lower":{"value":"2019-12-01","inclusive":true},"upper":{"value":"2020-01-01"}}},"source.name":{"type":"TERMS","terms":["HR Employees","Corporate Active Directory"],"exclude":true},"protected":{"type":"TERMS","terms":["true"]}}},{"type":"object","properties":{"type":{"description":"Enum representing the currently supported filter types.\nAdditional values may be added in the future without notice.","type":"string","enum":["EXISTS","RANGE","TERMS"],"example":"RANGE"},"range":{"type":"object","description":"The range of values to be filtered.","properties":{"lower":{"description":"The lower bound of the range.","type":"object","required":["value"],"properties":{"value":{"description":"The value of the range's endpoint.","type":"string","example":"1"},"inclusive":{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}},"upper":{"description":"The upper bound of the range.","type":"object","required":["value"],"properties":{"value":{"description":"The value of the range's endpoint.","type":"string","example":"1"},"inclusive":{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}}}},"terms":{"description":"The terms to be filtered.","type":"array","items":{"type":"string","example":"account_count"}},"exclude":{"description":"Indicates if the filter excludes results.","type":"boolean","default":false,"example":false}}}]}},"required":["indices","query"]}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/saved-searches/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Return saved search by ID","description":{"content":"Returns the specified saved search.\n","type":"text/plain"},"url":{"path":["saved-searches",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the requested document.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Return saved search by ID' (get-saved-search)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Return saved search by ID + + + +Returns the specified saved search. + + +
    Path Parameters
    + +The requested saved search. + +
    Schema
      owner object
      + +The owner of the saved search. + + +
      columns object
      + +The columns to be returned (specifies the order in which they will be presented) for each document type. + +The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. + + +
      items object
      filters object
      + +The filters to be applied for each filtered field name. + +
      range object
      + +The range of values to be filtered. + +
      lower object
      + +The lower bound of the range. + +
      upper object
      + +The upper bound of the range. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-scheduled-search.api.mdx b/products/idn/api/v3/get-scheduled-search.api.mdx new file mode 100644 index 000000000..5bedd0dde --- /dev/null +++ b/products/idn/api/v3/get-scheduled-search.api.mdx @@ -0,0 +1,112 @@ +--- +id: get-scheduled-search +sidebar_label: Get a Scheduled Search +hide_title: true +hide_table_of_contents: true +api: {"tags":["Scheduled Search"],"description":"Returns the specified scheduled search.","operationId":"getScheduledSearch","parameters":[{"in":"path","name":"id","description":"ID of the requested document.","schema":{"type":"string"},"required":true,"example":"2c91808568c529c60168cca6f90c1313"}],"responses":{"200":{"description":"The requested scheduled search.","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"id":{"description":"The scheduled search ID.","type":"string","example":"0de46054-fe90-434a-b84e-c6b3359d0c64","readOnly":true},"owner":{"description":"The owner of the scheduled search","readOnly":true,"type":"object","properties":{"type":{"type":"string","description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"The ID of the referenced object","example":"2c9180867624cbd7017642d8c8c81f67"}},"required":["type","id"]},"ownerId":{"description":"The ID of the scheduled search owner.\n\nPlease use the `id` in the `owner` object instead.\n","type":"string","example":"2c9180867624cbd7017642d8c8c81f67","readOnly":true,"deprecated":true}}},{"type":"object","properties":{"name":{"description":"The name of the scheduled search.\n","type":"string","example":"Daily disabled accounts","nullable":true},"description":{"description":"The description of the scheduled search.\n","type":"string","nullable":true,"example":"Daily disabled accounts"}}},{"type":"object","properties":{"savedSearchId":{"description":"The ID of the saved search that will be executed.","type":"string","example":"554f1511-f0a1-4744-ab14-599514d3e57c"},"created":{"allOf":[{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}],"description":"The date the scheduled search was initially created.","readOnly":true},"modified":{"allOf":[{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}],"description":"The last date the scheduled search was modified.","readOnly":true},"schedule":{"type":"object","description":"The schedule information.","properties":{"type":{"description":"Enum representing the currently supported schedule types.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["DAILY","WEEKLY","MONTHLY","CALENDAR"],"example":"WEEKLY"},"days":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The days to execute the search.\n\nIf `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`.\n\nIf `type` is `MONTHLY`, the values will be a number in double quotes, like `\"1\"`, `\"10\"`, or `\"28\"`. Optionally, the value `\"L\"` can be used to refer to the last day of the month.\n","example":{"type":"LIST","values":["MON","WED","FRI"]},"nullable":true}]},"hours":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The hours selected.","example":{"type":"RANGE","values":["9","18"],"interval":3}}]},"expiration":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"timeZoneId":{"description":"The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org's default timezone is used.","nullable":true,"type":"string","example":"GMT-06:00"}},"required":["type","hours"]},"recipients":{"description":"A list of identities that should receive the scheduled search report via email.","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"The ID of the referenced object","example":"2c9180867624cbd7017642d8c8c81f67"}},"required":["type","id"]}},"enabled":{"description":"Indicates if the scheduled search is enabled.\n","type":"boolean","default":false,"example":false},"emailEmptyResults":{"description":"Indicates if email generation should not be suppressed if search returns no results.\n","type":"boolean","default":false,"example":false},"displayQueryDetails":{"description":"Indicates if the generated email should include the query and search results preview (which could include PII).\n","type":"boolean","default":false,"example":false}},"required":["savedSearchId","schedule","recipients"]}],"required":["id","owner","ownerId"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/scheduled-searches/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get a Scheduled Search","description":{"content":"Returns the specified scheduled search.","type":"text/plain"},"url":{"path":["scheduled-searches",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the requested document.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a Scheduled Search' (get-scheduled-search)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a Scheduled Search + + + +Returns the specified scheduled search. + +
    Path Parameters
    + +The requested scheduled search. + +
    Schema
      owner object
      + +The owner of the scheduled search + +
      schedule object
      + +The schedule information. + +
      days object
      + +The days to execute the search. + +If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. + +If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. + + +
      hours object
      + +The hours selected. + +
      recipients object[]
      + +A list of identities that should receive the scheduled search report via email. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-segment.api.mdx b/products/idn/api/v3/get-segment.api.mdx new file mode 100644 index 000000000..20a49ba54 --- /dev/null +++ b/products/idn/api/v3/get-segment.api.mdx @@ -0,0 +1,97 @@ +--- +id: get-segment +sidebar_label: Get a Segment by ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getSegment","security":[{"oauth2":["idn:segment:read","idn:segment:manage"]}],"tags":["Segments"],"description":"This API returns the segment specified by the given ID.\n\nA token with ORG_ADMIN or API authority is required to call this API.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the Segment to retrieve.","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"Segment","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Segment.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"name":{"type":"string","description":"Segment Business Name","example":"segment-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this Segment is created","example":"2020-01-01T00:00:00.000000Z"},"modified":{"type":"string","format":"date-time","description":"The time when this Segment is modified","example":"2020-01-01T00:00:00.000000Z"},"description":{"type":"string","description":"Optional description of the Segment","example":"This segment represents xyz"},"owner":{"type":"object","nullable":true,"description":"The owner of this object.","properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"visibilityCriteria":{"type":"object","properties":{"expression":{"type":"object","properties":{"operator":{"type":"string","description":"Operator for the expression","enum":["AND","EQUALS"],"example":"EQUALS"},"attribute":{"type":"string","description":"Name for the attribute","example":"location"},"value":{"type":"object","properties":{"type":{"type":"string","description":"The type of attribute value","example":"STRING"},"value":{"type":"string","description":"The attribute value","example":"Austin"}}},"children":{"type":"array","nullable":true,"description":"List of expressions","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of attribute value","example":"STRING"},"value":{"type":"string","description":"The attribute value","example":"Austin"}}},"example":[]}}}}},"active":{"type":"boolean","description":"Whether the Segment is currently active. Inactive segments have no effect.","default":false,"example":true}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/segments/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get a Segment by ID","description":{"content":"This API returns the segment specified by the given ID.\n\nA token with ORG_ADMIN or API authority is required to call this API.","type":"text/plain"},"url":{"path":["segments",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the Segment to retrieve.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a Segment by ID' (get-segment)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a Segment by ID + + + +This API returns the segment specified by the given ID. + +A token with ORG_ADMIN or API authority is required to call this API. + +
    Path Parameters
    + +Segment + +
    Schema
      owner object
      + +The owner of this object. + +
      visibilityCriteria object
      expression object
      value object
      children object[]
      + +List of expressions + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-service-desk-integration-template.api.mdx b/products/idn/api/v3/get-service-desk-integration-template.api.mdx new file mode 100644 index 000000000..2a8dcf327 --- /dev/null +++ b/products/idn/api/v3/get-service-desk-integration-template.api.mdx @@ -0,0 +1,103 @@ +--- +id: get-service-desk-integration-template +sidebar_label: Service Desk integration template by scriptName. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Service Desk Integration"],"description":"This API endpoint returns an existing Service Desk integration template by scriptName. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","operationId":"getServiceDeskIntegrationTemplate","parameters":[{"name":"scriptName","in":"path","description":"The scriptName value of the Service Desk integration template to get","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"aScriptName"}}],"responses":{"200":{"description":"Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true},"modified":{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}},{"type":"object","description":"This is the model for a Service Desk integration template, used to create and edit Service Desk Integrations.","required":["type","attributes","provisioningConfig"],"properties":{"type":{"description":"The 'type' property specifies the type of the Service Desk integration template.","type":"string","example":"Web Service SDIM","default":"Web Service SDIM"},"attributes":{"description":"The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template.","type":"object","additionalProperties":true,"example":{"property":"value","key":"value"}},"provisioningConfig":{"description":"The 'provisioningConfig' property specifies the configuration used to provision integrations using the template.","type":"object","properties":{"universalManager":{"description":"Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.","type":"boolean","readOnly":true,"example":true},"managedResourceRefs":{"description":"References to sources for the Service Desk integration template. May only be specified if universalManager is false.","type":"array","items":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"properties":{"type":{"description":"The type of object being referenced","enum":["SOURCE"],"example":"SOURCE"},"id":{"description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the source","example":"My Source"}}},"example":[{"type":"SOURCE","id":"2c9180855d191c59015d291ceb051111","name":"My Source 1"},{"type":"SOURCE","id":"2c9180855d191c59015d291ceb052222","name":"My Source 2"}]},"planInitializerScript":{"description":"This is a reference to a plan initializer script.","type":"object","properties":{"source":{"description":"This is a Rule that allows provisioning instruction changes.","type":"string","example":"\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n"}}},"noProvisioningRequests":{"description":"Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.","type":"boolean","example":true},"provisioningRequestExpiration":{"description":"When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.","type":"integer","format":"int32","example":7}}}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:service-desk-admin:read","idn:service-desk-integration:read"]}],"method":"get","path":"/service-desk-integrations/templates/{scriptName}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Service Desk integration template by scriptName.","description":{"content":"This API endpoint returns an existing Service Desk integration template by scriptName. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","type":"text/plain"},"url":{"path":["service-desk-integrations","templates",":scriptName"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The scriptName value of the Service Desk integration template to get","type":"text/plain"},"type":"any","value":"","key":"scriptName"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Service Desk integration template by scriptName.' (get-service-desk-integration-template)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Service Desk integration template by scriptName. + + + +This API endpoint returns an existing Service Desk integration template by scriptName. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +
    Path Parameters
    + +Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName. + +
    Schema
      attributes object
      + +The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template. + +
      provisioningConfig object
      + +The 'provisioningConfig' property specifies the configuration used to provision integrations using the template. + +
      managedResourceRefs object[]
      + +References to sources for the Service Desk integration template. May only be specified if universalManager is false. + +
      planInitializerScript object
      + +This is a reference to a plan initializer script. + +
    \\\\r\\\\n\\\\r\\\\n\\\\r\\\\n Before Provisioning Rule which changes disables and enables to a modify.\\\\r\\\\n \\n\"\n },\n \"noProvisioningRequests\": true,\n \"provisioningRequestExpiration\": 7\n }\n}"} language={"json"}>
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-service-desk-integration-types.api.mdx b/products/idn/api/v3/get-service-desk-integration-types.api.mdx new file mode 100644 index 000000000..778cb5e8d --- /dev/null +++ b/products/idn/api/v3/get-service-desk-integration-types.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-service-desk-integration-types +sidebar_label: Service Desk Integration Types List. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Service Desk Integration"],"description":"This API endpoint returns the current list of supported Service Desk integration types. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","operationId":"getServiceDeskIntegrationTypes","responses":{"200":{"description":"Responds with an array of the currently supported Service Desk integration types.","content":{"application/json":{"schema":{"type":"array","items":{"description":"This represents a Service Desk Integration template type.","required":["type","scriptName"],"type":"object","properties":{"name":{"description":"This is the name of the type.","example":"aName","type":"string"},"type":{"description":"This is the type value for the type.","example":"aType","type":"string"},"scriptName":{"description":"This is the scriptName attribute value for the type.","example":"aScriptName","type":"string"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:service-desk-admin:read","idn:service-desk-integration:read"]}],"method":"get","path":"/service-desk-integrations/types","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Service Desk Integration Types List.","description":{"content":"This API endpoint returns the current list of supported Service Desk integration types. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","type":"text/plain"},"url":{"path":["service-desk-integrations","types"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Service Desk Integration Types List.' (get-service-desk-integration-types)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Service Desk Integration Types List. + + + +This API endpoint returns the current list of supported Service Desk integration types. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +
    + +Responds with an array of the currently supported Service Desk integration types. + +
    Schema array
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-service-desk-integration.api.mdx b/products/idn/api/v3/get-service-desk-integration.api.mdx new file mode 100644 index 000000000..aa50210c1 --- /dev/null +++ b/products/idn/api/v3/get-service-desk-integration.api.mdx @@ -0,0 +1,115 @@ +--- +id: get-service-desk-integration +sidebar_label: Get a Service Desk integration +hide_title: true +hide_table_of_contents: true +api: {"tags":["Service Desk Integration"],"description":"Get an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","operationId":"getServiceDeskIntegration","parameters":[{"name":"id","in":"path","description":"ID of the Service Desk integration to get","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"anId"}}],"responses":{"200":{"description":"ServiceDeskIntegrationDto with the given ID","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true},"modified":{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}},{"type":"object","description":"Specification of a Service Desk integration","required":["description","type","attributes"],"properties":{"description":{"description":"Description of the Service Desk integration","type":"string","example":"A very nice Service Desk integration"},"type":{"description":"Service Desk integration types\n\n- ServiceNowSDIM\n- ServiceNow\n","type":"string","default":"ServiceNowSDIM","example":"ServiceNowSDIM"},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the identity that is the owner of this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the identity","example":"MyName"}}},"clusterRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the source cluster for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"cluster":{"description":"ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)","type":"string","example":"xyzzy999","deprecated":true},"managedSources":{"description":"Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)","type":"array","items":{"type":"string"},"deprecated":true,"example":["2c9180835d191a86015d28455b4a2329","2c5680835d191a85765d28455b4a9823"]},"provisioningConfig":{"description":"The 'provisioningConfig' property specifies the configuration used to provision integrations.","type":"object","properties":{"universalManager":{"description":"Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.","type":"boolean","readOnly":true,"example":true},"managedResourceRefs":{"description":"References to sources for the Service Desk integration template. May only be specified if universalManager is false.","type":"array","items":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"properties":{"type":{"description":"The type of object being referenced","enum":["SOURCE"],"example":"SOURCE"},"id":{"description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the source","example":"My Source"}}},"example":[{"type":"SOURCE","id":"2c9180855d191c59015d291ceb051111","name":"My Source 1"},{"type":"SOURCE","id":"2c9180855d191c59015d291ceb052222","name":"My Source 2"}]},"planInitializerScript":{"description":"This is a reference to a plan initializer script.","type":"object","properties":{"source":{"description":"This is a Rule that allows provisioning instruction changes.","type":"string","example":"\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n"}}},"noProvisioningRequests":{"description":"Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.","type":"boolean","example":true},"provisioningRequestExpiration":{"description":"When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.","type":"integer","format":"int32","example":7}}},"attributes":{"description":"Attributes of the Service Desk integration. Validation constraints enforced by the implementation.","type":"object","additionalProperties":true,"example":{"property":"value","key":"value"}},"beforeProvisioningRule":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to beforeProvisioningRule for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["RULE"],"example":"RULE"},"id":{"description":"ID of the rule","example":"2c91808568c529c60168cca6f90c1333"},"name":{"description":"Human-readable display name of the rule","example":"Example Rule"}}}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:service-desk-admin:read","idn:service-desk-integration:read"]}],"method":"get","path":"/service-desk-integrations/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get a Service Desk integration","description":{"content":"Get an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","type":"text/plain"},"url":{"path":["service-desk-integrations",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Service Desk integration to get","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a Service Desk integration' (get-service-desk-integration)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a Service Desk integration + + + +Get an existing Service Desk integration by ID. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +
    Path Parameters
    + +ServiceDeskIntegrationDto with the given ID + +
    Schema
      ownerRef object
      + +Reference to the identity that is the owner of this Service Desk integration + +
      clusterRef object
      + +Reference to the source cluster for this Service Desk integration + +
      provisioningConfig object
      + +The 'provisioningConfig' property specifies the configuration used to provision integrations. + +
      managedResourceRefs object[]
      + +References to sources for the Service Desk integration template. May only be specified if universalManager is false. + +
      planInitializerScript object
      + +This is a reference to a plan initializer script. + +
      attributes object
      + +Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + +
      beforeProvisioningRule object
      + +Reference to beforeProvisioningRule for this Service Desk integration + +
    \\\\r\\\\n\\\\r\\\\n\\\\r\\\\n Before Provisioning Rule which changes disables and enables to a modify.\\\\r\\\\n \\n\"\n },\n \"noProvisioningRequests\": true,\n \"provisioningRequestExpiration\": 7\n },\n \"attributes\": {\n \"property\": \"value\",\n \"key\": \"value\"\n },\n \"beforeProvisioningRule\": {\n \"type\": true,\n \"id\": true,\n \"name\": true\n }\n}"} language={"json"}>
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-service-desk-integrations.api.mdx b/products/idn/api/v3/get-service-desk-integrations.api.mdx new file mode 100644 index 000000000..be7a8f9ce --- /dev/null +++ b/products/idn/api/v3/get-service-desk-integrations.api.mdx @@ -0,0 +1,115 @@ +--- +id: get-service-desk-integrations +sidebar_label: List existing Service Desk Integrations +hide_title: true +hide_table_of_contents: true +api: {"tags":["Service Desk Integration"],"description":"Get a list of ServiceDeskIntegrationDto for existing Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","operationId":"getServiceDeskIntegrations","parameters":[{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"name":"sorters","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**","example":"name"},{"name":"filters","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"comma-separated"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq*\n\n**type**: *eq, in*\n\n**cluster**: *eq, in*","example":"name eq \"John Doe\""},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"List of ServiceDeskIntegrationDto","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true},"modified":{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}},{"type":"object","description":"Specification of a Service Desk integration","required":["description","type","attributes"],"properties":{"description":{"description":"Description of the Service Desk integration","type":"string","example":"A very nice Service Desk integration"},"type":{"description":"Service Desk integration types\n\n- ServiceNowSDIM\n- ServiceNow\n","type":"string","default":"ServiceNowSDIM","example":"ServiceNowSDIM"},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the identity that is the owner of this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the identity","example":"MyName"}}},"clusterRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the source cluster for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"cluster":{"description":"ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)","type":"string","example":"xyzzy999","deprecated":true},"managedSources":{"description":"Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)","type":"array","items":{"type":"string"},"deprecated":true,"example":["2c9180835d191a86015d28455b4a2329","2c5680835d191a85765d28455b4a9823"]},"provisioningConfig":{"description":"The 'provisioningConfig' property specifies the configuration used to provision integrations.","type":"object","properties":{"universalManager":{"description":"Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.","type":"boolean","readOnly":true,"example":true},"managedResourceRefs":{"description":"References to sources for the Service Desk integration template. May only be specified if universalManager is false.","type":"array","items":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"properties":{"type":{"description":"The type of object being referenced","enum":["SOURCE"],"example":"SOURCE"},"id":{"description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the source","example":"My Source"}}},"example":[{"type":"SOURCE","id":"2c9180855d191c59015d291ceb051111","name":"My Source 1"},{"type":"SOURCE","id":"2c9180855d191c59015d291ceb052222","name":"My Source 2"}]},"planInitializerScript":{"description":"This is a reference to a plan initializer script.","type":"object","properties":{"source":{"description":"This is a Rule that allows provisioning instruction changes.","type":"string","example":"\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n"}}},"noProvisioningRequests":{"description":"Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.","type":"boolean","example":true},"provisioningRequestExpiration":{"description":"When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.","type":"integer","format":"int32","example":7}}},"attributes":{"description":"Attributes of the Service Desk integration. Validation constraints enforced by the implementation.","type":"object","additionalProperties":true,"example":{"property":"value","key":"value"}},"beforeProvisioningRule":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to beforeProvisioningRule for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["RULE"],"example":"RULE"},"id":{"description":"ID of the rule","example":"2c91808568c529c60168cca6f90c1333"},"name":{"description":"Human-readable display name of the rule","example":"Example Rule"}}}}}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:service-desk-admin:read","idn:service-desk-integration:read"]}],"method":"get","path":"/service-desk-integrations","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List existing Service Desk Integrations","description":{"content":"Get a list of ServiceDeskIntegrationDto for existing Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","type":"text/plain"},"url":{"path":["service-desk-integrations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq*\n\n**type**: *eq, in*\n\n**cluster**: *eq, in*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List existing Service Desk Integrations' (get-service-desk-integrations)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List existing Service Desk Integrations + + + +Get a list of ServiceDeskIntegrationDto for existing Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +
    Query Parameters
    + +List of ServiceDeskIntegrationDto + +
    Schema array
      ownerRef object
      + +Reference to the identity that is the owner of this Service Desk integration + +
      clusterRef object
      + +Reference to the source cluster for this Service Desk integration + +
      provisioningConfig object
      + +The 'provisioningConfig' property specifies the configuration used to provision integrations. + +
      managedResourceRefs object[]
      + +References to sources for the Service Desk integration template. May only be specified if universalManager is false. + +
      planInitializerScript object
      + +This is a reference to a plan initializer script. + +
      attributes object
      + +Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + +
      beforeProvisioningRule object
      + +Reference to beforeProvisioningRule for this Service Desk integration + +
    \\\\r\\\\n\\\\r\\\\n\\\\r\\\\n Before Provisioning Rule which changes disables and enables to a modify.\\\\r\\\\n \\n\"\n },\n \"noProvisioningRequests\": true,\n \"provisioningRequestExpiration\": 7\n },\n \"attributes\": {\n \"property\": \"value\",\n \"key\": \"value\"\n },\n \"beforeProvisioningRule\": {\n \"type\": true,\n \"id\": true,\n \"name\": true\n }\n }\n]"} language={"json"}>
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-sod-all-report-run-status.api.mdx b/products/idn/api/v3/get-sod-all-report-run-status.api.mdx new file mode 100644 index 000000000..c090b80d6 --- /dev/null +++ b/products/idn/api/v3/get-sod-all-report-run-status.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-sod-all-report-run-status +sidebar_label: Get multi-report run task status +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:sod-violation:read"]}],"operationId":"getSodAllReportRunStatus","tags":["SOD Policy"],"description":"This endpoint gets the status for a violation report for all policy run.","responses":{"200":{"description":"Status of the violation report run task for all policy run.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object","properties":{"status":{"type":"string","description":"Status of a violation report","enum":["SUCCESS","WARNING","ERROR","TERMINATED","TEMP_ERROR","PENDING"],"example":"PENDING"}}}]},"example":{"status":"SUCCESS","type":"REPORT_RESULT","id":"37b3b32a-f394-46f8-acad-b5223969fa68","name":"Multi Query Report"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sod-violation-report","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get multi-report run task status","description":{"content":"This endpoint gets the status for a violation report for all policy run.","type":"text/plain"},"url":{"path":["sod-violation-report"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get multi-report run task status' (get-sod-all-report-run-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get multi-report run task status + + + +This endpoint gets the status for a violation report for all policy run. + +
    + +Status of the violation report run task for all policy run. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-sod-policy-schedule.api.mdx b/products/idn/api/v3/get-sod-policy-schedule.api.mdx new file mode 100644 index 000000000..4f94b0abb --- /dev/null +++ b/products/idn/api/v3/get-sod-policy-schedule.api.mdx @@ -0,0 +1,92 @@ +--- +id: get-sod-policy-schedule +sidebar_label: Get SOD policy schedule +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:sod-policy:read"]}],"operationId":"getSodPolicySchedule","tags":["SOD Policy"],"description":"This endpoint gets a specified SOD policy's schedule.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the SOD policy schedule to retrieve.","example":"ef38f943-47e9-4562-b5bb-8424a56397d8"}],"responses":{"200":{"description":"SOD policy schedule.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"SOD Policy schedule name","example":"SCH-1584312283015"},"created":{"type":"string","format":"date-time","description":"The time when this SOD policy schedule is created.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"modified":{"type":"string","format":"date-time","description":"The time when this SOD policy schedule is modified.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"description":{"type":"string","description":"SOD Policy schedule description","example":"Schedule for policy xyz"},"schedule":{"type":"object","description":"The schedule information.","properties":{"type":{"description":"Enum representing the currently supported schedule types.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["DAILY","WEEKLY","MONTHLY","CALENDAR"],"example":"WEEKLY"},"days":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The days to execute the search.\n\nIf `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`.\n\nIf `type` is `MONTHLY`, the values will be a number in double quotes, like `\"1\"`, `\"10\"`, or `\"28\"`. Optionally, the value `\"L\"` can be used to refer to the last day of the month.\n","example":{"type":"LIST","values":["MON","WED","FRI"]},"nullable":true}]},"hours":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The hours selected.","example":{"type":"RANGE","values":["9","18"],"interval":3}}]},"expiration":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"timeZoneId":{"description":"The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org's default timezone is used.","nullable":true,"type":"string","example":"GMT-06:00"}},"required":["type","hours"]},"recipients":{"type":"array","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}},"emailEmptyResults":{"type":"boolean","description":"Indicates if empty results need to be emailed","example":false,"default":false},"creatorId":{"type":"string","description":"Policy's creator ID","example":"0f11f2a47c944bf3a2bd742580fe3bde","readOnly":true},"modifierId":{"type":"string","description":"Policy's modifier ID","example":"0f11f2a47c944bf3a2bd742580fe3bde","readOnly":true}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sod-policies/{id}/schedule","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get SOD policy schedule","description":{"content":"This endpoint gets a specified SOD policy's schedule.","type":"text/plain"},"url":{"path":["sod-policies",":id","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the SOD policy schedule to retrieve.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get SOD policy schedule' (get-sod-policy-schedule)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get SOD policy schedule + + + +This endpoint gets a specified SOD policy's schedule. + +
    Path Parameters
    + +SOD policy schedule. + +
    Schema
      schedule object
      + +The schedule information. + +
      days object
      + +The days to execute the search. + +If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. + +If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. + + +
      hours object
      + +The hours selected. + +
      recipients object[]
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-sod-policy.api.mdx b/products/idn/api/v3/get-sod-policy.api.mdx new file mode 100644 index 000000000..63ac600ef --- /dev/null +++ b/products/idn/api/v3/get-sod-policy.api.mdx @@ -0,0 +1,104 @@ +--- +id: get-sod-policy +sidebar_label: Get SOD policy by ID +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:sod-policy:read"]}],"operationId":"getSodPolicy","tags":["SOD Policy"],"description":"This gets specified SOD policy.\nRequires role of ORG_ADMIN.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the SOD Policy to retrieve.","example":"ef38f943-47e9-4562-b5bb-8424a56397d8"}],"responses":{"200":{"description":"SOD policy ID.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Policy id","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"name":{"type":"string","description":"Policy Business Name","example":"policy-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this SOD policy is created.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"modified":{"type":"string","format":"date-time","description":"The time when this SOD policy is modified.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"description":{"type":"string","description":"Optional description of the SOD policy","example":"This policy ensures compliance of xyz","nullable":true},"ownerRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"externalPolicyReference":{"type":"string","description":"Optional External Policy Reference","example":"XYZ policy","nullable":true},"policyQuery":{"type":"string","description":"Search query of the SOD policy","example":"@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)"},"compensatingControls":{"type":"string","description":"Optional compensating controls(Mitigating Controls)","example":"Have a manager review the transaction decisions for their \"out of compliance\" employee","nullable":true},"correctionAdvice":{"type":"string","description":"Optional correction advice","example":"Based on the role of the employee, managers should remove access that is not required for their job function.","nullable":true},"state":{"type":"string","description":"whether the policy is enforced or not","enum":["ENFORCED","NOT_ENFORCED"],"example":"ENFORCED"},"tags":{"type":"array","description":"tags for this policy object","example":["TAG1","TAG2"],"items":{"type":"string"}},"creatorId":{"type":"string","description":"Policy's creator ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"modifierId":{"type":"string","description":"Policy's modifier ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","nullable":true,"readOnly":true},"violationOwnerAssignmentConfig":{"nullable":true,"type":"object","properties":{"assignmentRule":{"type":"string","enum":["MANAGER","STATIC",null],"description":"Details about the violations owner.\nMANAGER - identity's manager\nSTATIC - Governance Group or Identity","example":"MANAGER","nullable":true},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"nullable":true}]}}},"scheduled":{"type":"boolean","description":"defines whether a policy has been scheduled or not","example":true,"default":false},"type":{"type":"string","description":"whether a policy is query based or conflicting access based","default":"GENERAL","enum":["GENERAL","CONFLICTING_ACCESS_BASED"],"example":"GENERAL"},"conflictingAccessCriteria":{"allOf":[{"type":"object","properties":{"leftCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","minItems":1,"maxItems":50,"items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"Type of the propery to which this reference applies to","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}},"rightCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","minItems":1,"maxItems":50,"items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"Type of the propery to which this reference applies to","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}}}},{"nullable":true}]}}},"examples":{"Conflicting Access Based Policy":{"value":{"id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"Conflicting-Policy-Name","created":"2020-01-01T00:00:00.000000Z","modified":"2020-01-01T00:00:00.000000Z","description":"This policy ensures compliance of xyz","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Owner Name"},"externalPolicyReference":"XYZ policy","policyQuery":"@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)","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":["string"],"creatorId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","modifierId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","violationOwnerAssignmentConfig":{"assignmentRule":"MANAGER","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Violation Owner Name"}},"scheduled":true,"type":"CONFLICTING_ACCESS_BASED","conflictingAccessCriteria":{"leftCriteria":{"name":"money-in","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67"}]},"rightCriteria":{"name":"money-out","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a68"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a69"}]}}}},"General Policy":{"value":{"description":"Description","ownerRef":{"type":"IDENTITY","id":"2c918087682f9a86016839c05e8f1aff","name":"Owner Name"},"externalPolicyReference":"New policy","policyQuery":"policy query implementation","compensatingControls":"Compensating controls","correctionAdvice":"Correction advice","tags":[],"state":"ENFORCED","scheduled":false,"creatorId":"2c918087682f9a86016839c05e8f1aff","modifierId":null,"violationOwnerAssignmentConfig":null,"type":"GENERAL","conflictingAccessCriteria":null,"id":"52c11db4-733e-4c31-949a-766c95ec95f1","name":"General-Policy-Name","created":"2020-05-12T19:47:38Z","modified":"2020-05-12T19:47:38Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sod-policies/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get SOD policy by ID","description":{"content":"This gets specified SOD policy.\nRequires role of ORG_ADMIN.","type":"text/plain"},"url":{"path":["sod-policies",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the SOD Policy to retrieve.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get SOD policy by ID' (get-sod-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get SOD policy by ID + + + +This gets specified SOD policy. +Requires role of ORG_ADMIN. + +
    Path Parameters
    + +SOD policy ID. + +
    Schema
      ownerRef object
      violationOwnerAssignmentConfig object
      ownerRef object
      conflictingAccessCriteria object
      leftCriteria object
      criteriaList object[]
      + +**Possible values:** `>= 1`, `<= 50` + +
      + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
      rightCriteria object
      criteriaList object[]
      + +**Possible values:** `>= 1`, `<= 50` + +
      + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-sod-violation-report-run-status.api.mdx b/products/idn/api/v3/get-sod-violation-report-run-status.api.mdx new file mode 100644 index 000000000..37fcfe158 --- /dev/null +++ b/products/idn/api/v3/get-sod-violation-report-run-status.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-sod-violation-report-run-status +sidebar_label: Get violation report run status +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:sod-violation:read"]}],"operationId":"getSodViolationReportRunStatus","tags":["SOD Policy"],"description":"This gets the status for a violation report run task that has already been invoked.","parameters":[{"in":"path","name":"reportResultId","schema":{"type":"string"},"required":true,"description":"The ID of the report reference to retrieve.","example":"2e8d8180-24bc-4d21-91c6-7affdb473b0d"}],"responses":{"200":{"description":"Status of the violation report run task.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object","properties":{"status":{"type":"string","description":"Status of a violation report","enum":["SUCCESS","WARNING","ERROR","TERMINATED","TEMP_ERROR","PENDING"],"example":"PENDING"}}}]},"example":{"status":"SUCCESS","type":"REPORT_RESULT","id":"2e8d8180-24bc-4d21-91c6-7affdb473b0d","name":"policy-xyz"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sod-policies/sod-violation-report-status/{reportResultId}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get violation report run status","description":{"content":"This gets the status for a violation report run task that has already been invoked.","type":"text/plain"},"url":{"path":["sod-policies","sod-violation-report-status",":reportResultId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the report reference to retrieve.","type":"text/plain"},"type":"any","value":"","key":"reportResultId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get violation report run status' (get-sod-violation-report-run-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get violation report run status + + + +This gets the status for a violation report run task that has already been invoked. + +
    Path Parameters
    + +Status of the violation report run task. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-sod-violation-report-status.api.mdx b/products/idn/api/v3/get-sod-violation-report-status.api.mdx new file mode 100644 index 000000000..224a62598 --- /dev/null +++ b/products/idn/api/v3/get-sod-violation-report-status.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-sod-violation-report-status +sidebar_label: Get SOD violation report status +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:sod-violation:read"]}],"operationId":"getSodViolationReportStatus","tags":["SOD Policy"],"description":"This gets the status for a violation report run task that has already been invoked.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the violation report to retrieve status for.","example":"ef38f943-47e9-4562-b5bb-8424a56397d8"}],"responses":{"200":{"description":"Status of the violation report run task.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object","properties":{"status":{"type":"string","description":"Status of a violation report","enum":["SUCCESS","WARNING","ERROR","TERMINATED","TEMP_ERROR","PENDING"],"example":"PENDING"}}}]},"example":{"status":"SUCCESS","type":"REPORT_RESULT","id":"2e8d8180-24bc-4d21-91c6-7affdb473b0d","name":"policy-xyz"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sod-policies/{id}/violation-report","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get SOD violation report status","description":{"content":"This gets the status for a violation report run task that has already been invoked.","type":"text/plain"},"url":{"path":["sod-policies",":id","violation-report"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the violation report to retrieve status for.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get SOD violation report status' (get-sod-violation-report-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get SOD violation report status + + + +This gets the status for a violation report run task that has already been invoked. + +
    Path Parameters
    + +Status of the violation report run task. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-source-health.api.mdx b/products/idn/api/v3/get-source-health.api.mdx new file mode 100644 index 000000000..d4c1cbaa1 --- /dev/null +++ b/products/idn/api/v3/get-source-health.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-source-health +sidebar_label: Fetches source health by id +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getSourceHealth","security":[{"oauth2":["idn:sources:read"]}],"tags":["Sources"],"description":"This endpoint fetches source health by source's id","parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source id.","example":"2c9180835d191a86015d28455b4a2329"}],"responses":{"200":{"description":"Fetched source health successfully","content":{"application/json":{"schema":{"type":"object","description":"Dto for source health data","properties":{"id":{"type":"string","readOnly":true,"description":"the id of the Source","example":"2c91808568c529c60168cca6f90c1324"},"type":{"type":"string","description":"Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ","example":"OpenLDAP - Direct"},"name":{"type":"string","description":"the name of the source","example":"Source1234"},"org":{"type":"string","description":"source's org","example":"denali-cjh"},"isAuthoritative":{"type":"boolean","example":false,"description":"Is the source authoritative"},"isCluster":{"type":"boolean","example":false,"description":"Is the source in a cluster"},"hostname":{"type":"string","example":"megapod-useast1-secret-hostname.sailpoint.com","description":"source's hostname"},"pod":{"type":"string","description":"source's pod","example":"megapod-useast1"},"iqServiceVersion":{"type":"string","description":"The version of the iqService","example":"iqVersion123"},"status":{"type":"string","enum":["SOURCE_STATE_ERROR_CLUSTER","SOURCE_STATE_ERROR_SOURCE","SOURCE_STATE_ERROR_VA","SOURCE_STATE_FAILURE_CLUSTER","SOURCE_STATE_FAILURE_SOURCE","SOURCE_STATE_HEALTHY","SOURCE_STATE_UNCHECKED_CLUSTER","SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES","SOURCE_STATE_UNCHECKED_SOURCE","SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS"],"description":"connection test result","example":"SOURCE_STATE_UNCHECKED_SOURCE"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sources/{sourceId}/source-health","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Fetches source health by id","description":{"content":"This endpoint fetches source health by source's id","type":"text/plain"},"url":{"path":["sources",":sourceId","source-health"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id.","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Fetches source health by id' (get-source-health)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Fetches source health by id + + + +This endpoint fetches source health by source's id + +
    Path Parameters
    + +Fetched source health successfully + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-source-schema.api.mdx b/products/idn/api/v3/get-source-schema.api.mdx new file mode 100644 index 000000000..61c7fbc0f --- /dev/null +++ b/products/idn/api/v3/get-source-schema.api.mdx @@ -0,0 +1,96 @@ +--- +id: get-source-schema +sidebar_label: Get Source Schema by ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getSourceSchema","tags":["Sources"],"description":"Get the Source Schema by ID in IdentityNow.\n","parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source id.","example":"2c9180835d191a86015d28455b4a2329"},{"in":"path","name":"schemaId","schema":{"type":"string"},"required":true,"description":"The Schema id.","example":"2c9180835d191a86015d28455b4a2329"}],"responses":{"200":{"description":"The requested Schema was successfully retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Schema.","example":"2c9180835d191a86015d28455b4a2329"},"name":{"type":"string","description":"The name of the Schema.","example":"account"},"nativeObjectType":{"type":"string","description":"The name of the object type on the native system that the schema represents.","example":"User"},"identityAttribute":{"type":"string","description":"The name of the attribute used to calculate the unique identifier for an object in the schema.","example":"sAMAccountName"},"displayAttribute":{"type":"string","description":"The name of the attribute used to calculate the display value for an object in the schema.","example":"distinguishedName"},"hierarchyAttribute":{"type":"string","description":"The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.","example":"memberOf"},"includePermissions":{"type":"boolean","description":"Flag indicating whether or not the include permissions with the object data when aggregating the schema.","example":false},"features":{"type":"array","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.","example":"AUTHENTICATE"},"description":"The features that the schema supports.","example":["PROVISIONING","NO_PERMISSIONS_PROVISIONING","GROUPS_HAVE_MEMBERS"]},"configuration":{"type":"object","description":"Holds any extra configuration data that the schema may require.","example":{"groupMemberAttribute":"member"}},"attributes":{"type":"array","description":"The attribute definitions which form the schema.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"sAMAccountName"},"type":{"description":"The type of the attribute.","example":"STRING","type":"string","enum":["STRING","LONG","INT","BOOLEAN"]},"schema":{"description":"A reference to the schema on the source to the attribute values map to.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"The object ID this reference applies to.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The human-readable display name of the object.","example":"group"}}},"description":{"type":"string","description":"A human-readable description of the attribute.","example":"SAM Account Name"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","example":false},"isEntitlement":{"type":"boolean","description":"Flag indicating whether or not the attribute is an entitlement.","example":false},"isGroup":{"type":"boolean","description":"Flag indicating whether or not the attribute represents a group.\nThis can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute..\n","example":false}}},"example":[{"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":{"type":"string","description":"The date the Schema was created.","format":"date-time","example":"2019-12-24T22:32:58.104Z"},"modified":{"type":"string","description":"The date the Schema was last modified.","format":"date-time","example":"2019-12-31T20:22:28.104Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sources/{sourceId}/schemas/{schemaId}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get Source Schema by ID","description":{"content":"Get the Source Schema by ID in IdentityNow.\n","type":"text/plain"},"url":{"path":["sources",":sourceId","schemas",":schemaId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id.","type":"text/plain"},"type":"any","value":"","key":"sourceId"},{"disabled":false,"description":{"content":"(Required) The Schema id.","type":"text/plain"},"type":"any","value":"","key":"schemaId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Source Schema by ID' (get-source-schema)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Source Schema by ID + + + +Get the Source Schema by ID in IdentityNow. + + +
    Path Parameters
    + +The requested Schema was successfully retrieved. + +
    Schema
      attributes object[]
      + +The attribute definitions which form the schema. + +
      schema object
      + +A reference to the schema on the source to the attribute values map to. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-source.api.mdx b/products/idn/api/v3/get-source.api.mdx new file mode 100644 index 000000000..ec45b5b89 --- /dev/null +++ b/products/idn/api/v3/get-source.api.mdx @@ -0,0 +1,128 @@ +--- +id: get-source +sidebar_label: Get Source by ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getSource","security":[{"oauth2":["idn:sources:read"]}],"tags":["Sources"],"description":"This end-point gets a specific source in IdentityNow.\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Source id","example":"2c9180835d191a86015d28455b4a2329"}],"responses":{"200":{"description":"A Source object","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"the id of the Source","example":"2c91808568c529c60168cca6f90c1324"},"name":{"type":"string","description":"Human-readable name of the source","example":"My Source"},"description":{"type":"string","description":"Human-readable description of the source","example":"This is the corporate directory."},"owner":{"description":"Reference to an owning Identity Object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity","example":"MyName"}}},"cluster":{"description":"Reference to the associated Cluster","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"type":"string","description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"accountCorrelationConfig":{"description":"Reference to an Account Correlation Config object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG"],"example":"ACCOUNT_CORRELATION_CONFIG"},"id":{"type":"string","description":"ID of the account correlation config","example":"2c9180855d191c59015d28583727245a"},"name":{"type":"string","description":"Human-readable display name of the account correlation config","example":"Directory [source-62867] Account Correlation"}}},"accountCorrelationRule":{"description":"Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"managerCorrelationMapping":{"description":"Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity","type":"object","properties":{"accountAttribute":{"type":"string","description":"Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.","example":"manager"},"identityAttribute":{"type":"string","description":"Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.","example":"manager"}}},"managerCorrelationRule":{"description":"Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"beforeProvisioningRule":{"description":"Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"schemas":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"ID of the schema","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the schema","example":"MySchema"}}},"description":"List of references to Schema objects","example":[{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232a","name":"account"},{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232b","name":"group"}]},"passwordPolicies":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["PASSWORD_POLICY"],"example":"PASSWORD_POLICY"},"id":{"type":"string","description":"ID of the policy","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the policy","example":"My Password Policy"}}},"description":"List of references to the associated PasswordPolicy objects.","example":[{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb053980","name":"Corporate Password Policy"},{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb057777","name":"Vendor Password Policy"}]},"features":{"type":"array","description":"Optional features that can be supported by a source.","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.","example":"AUTHENTICATE"},"example":["SYNC_PROVISIONING","MANAGER_LOOKUP","SEARCH","PROVISIONING","AUTHENTICATE","GROUP_PROVISIONING","PASSWORD"]},"type":{"type":"string","description":"Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ","example":"OpenLDAP - Direct"},"connector":{"type":"string","description":"Connector script name.","example":"active-directory"},"connectorClass":{"type":"string","description":"The fully qualified name of the Java class that implements the connector interface.","example":"sailpoint.connector.LDAPConnector"},"connectorAttributes":{"type":"object","description":"Connector specific configuration; will differ from type to type.","example":{"healthCheckTimeout":30,"authSearchAttributes":["cn","uid","mail"]}},"deleteThreshold":{"type":"integer","format":"int32","description":"Number from 0 to 100 that specifies when to skip the delete phase.","example":10},"authoritative":{"type":"boolean","description":"When true indicates the source is referenced by an IdentityProfile.","example":false},"managementWorkgroup":{"description":"Reference to Management Workgroup for this Source","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["GOVERNANCE_GROUP"],"example":"GOVERNANCE_GROUP"},"id":{"type":"string","description":"ID of the management workgroup","example":"2c91808568c529c60168cca6f90c2222"},"name":{"type":"string","description":"Human-readable display name of the management workgroup","example":"My Management Workgroup"}}},"healthy":{"type":"boolean","description":"When true indicates a healthy source","example":true},"status":{"type":"string","description":"A status identifier, giving specific information on why a source is healthy or not","example":"SOURCE_STATE_HEALTHY"},"since":{"type":"string","description":"Timestamp showing when a source health check was last performed","example":"2021-09-28T15:48:29.3801666300Z"},"connectorId":{"type":"string","description":"The id of connector","example":"active-directory"},"connectorName":{"type":"string","description":"The name of the connector that was chosen on source creation","example":"Active Directory"},"connectionType":{"type":"string","description":"The type of connection (direct or file)","example":"file"},"connectorImplementstionId":{"type":"string","description":"The connector implementstion id","example":"delimited-file"}},"required":["name","owner","connector"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sources/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get Source by ID","description":{"content":"This end-point gets a specific source in IdentityNow.\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Source by ID' (get-source)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Source by ID + + + +This end-point gets a specific source in IdentityNow. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +
    Path Parameters
    + +A Source object + +
    Schema
      owner object
      + +Reference to an owning Identity Object + +
      cluster object
      + +Reference to the associated Cluster + +
      accountCorrelationConfig object
      + +Reference to an Account Correlation Config object + +
      accountCorrelationRule object
      + +Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used. + +
      managerCorrelationMapping object
      + +Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + +
      managerCorrelationRule object
      + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
      beforeProvisioningRule object
      + +Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + +
      schemas object[]
      + +List of references to Schema objects + +
      passwordPolicies object[]
      + +List of references to the associated PasswordPolicy objects. + +
      managementWorkgroup object
      + +Reference to Management Workgroup for this Source + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-status-check-details.api.mdx b/products/idn/api/v3/get-status-check-details.api.mdx new file mode 100644 index 000000000..81aa04be0 --- /dev/null +++ b/products/idn/api/v3/get-status-check-details.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-status-check-details +sidebar_label: Get the time check configuration +hide_title: true +hide_table_of_contents: true +api: {"tags":["Service Desk Integration"],"description":"Get the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","operationId":"getStatusCheckDetails","responses":{"200":{"description":"QueuedCheckConfigDetails containing the configured values","content":{"application/json":{"schema":{"description":"Configuration of maximum number days and interval for checking Service Desk integration queue status","required":["provisioningStatusCheckIntervalMinutes","provisioningMaxStatusCheckDays"],"type":"object","properties":{"provisioningStatusCheckIntervalMinutes":{"description":"interval in minutes between status checks","type":"string","example":"30"},"provisioningMaxStatusCheckDays":{"description":"maximum number of days to check","type":"string","example":"2"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:service-desk-admin:read","idn:service-desk-integration:read"]}],"method":"get","path":"/service-desk-integrations/status-check-configuration","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get the time check configuration","description":{"content":"Get the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","type":"text/plain"},"url":{"path":["service-desk-integrations","status-check-configuration"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get the time check configuration' (get-status-check-details)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get the time check configuration + + + +Get the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +
    + +QueuedCheckConfigDetails containing the configured values + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-tagged-object.api.mdx b/products/idn/api/v3/get-tagged-object.api.mdx new file mode 100644 index 000000000..86cd4f296 --- /dev/null +++ b/products/idn/api/v3/get-tagged-object.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-tagged-object +sidebar_label: Get Tagged Object +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getTaggedObject","security":[{"oauth2":["idn:tag:read","idn:tag:manage"]}],"tags":["Tagged Objects"],"description":"This gets a tagged object for the specified type.","parameters":[{"in":"path","name":"type","schema":{"type":"string","enum":["ROLE","IDENTITY","SOD_POLICY"]},"required":true,"description":"The type of tagged object to retrieve.","example":"ROLE"},{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the object reference to retrieve.","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"Tagged object by type and ID.","content":{"application/json":{"schema":{"type":"object","properties":{"objectRef":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","nullable":true,"description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"tags":{"type":"array","items":{"type":"string"},"description":"Labels to be applied to an Object","example":["BU_FINANCE","PCI"]}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/tagged-objects/{type}/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get Tagged Object","description":{"content":"This gets a tagged object for the specified type.","type":"text/plain"},"url":{"path":["tagged-objects",":type",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The type of tagged object to retrieve.","type":"text/plain"},"type":"any","value":"","key":"type"},{"disabled":false,"description":{"content":"(Required) The ID of the object reference to retrieve.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Tagged Object' (get-tagged-object)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get Tagged Object + + + +This gets a tagged object for the specified type. + +
    Path Parameters
    + +Tagged object by type and ID. + +
    Schema
      objectRef object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-transform.api.mdx b/products/idn/api/v3/get-transform.api.mdx new file mode 100644 index 000000000..71f511fb9 --- /dev/null +++ b/products/idn/api/v3/get-transform.api.mdx @@ -0,0 +1,494 @@ +--- +id: get-transform +sidebar_label: Transform by ID +hide_title: true +hide_table_of_contents: true +api: {"tags":["Transforms"],"description":"This API returns the transform specified by the given ID.\nA token with transform read authority is required to call this API.","operationId":"getTransform","parameters":[{"name":"id","in":"path","description":"ID of the transform to retrieve","required":true,"style":"simple","explode":false,"example":"2cd78adghjkja34jh2b1hkjhasuecd","schema":{"type":"string"}}],"responses":{"200":{"description":"Transform with the given ID","content":{"application/json":{"schema":{"type":"object","description":"The representation of an internally- or customer-defined transform.","required":["name","type","attributes"],"properties":{"id":{"type":"string","readOnly":true,"description":"Unique ID of this transform","example":"2cd78adghjkja34jh2b1hkjhasuecd"},"name":{"type":"string","description":"Unique name of this transform","example":"Timestamp To Date","minLength":1,"maxLength":50},"type":{"type":"string","description":"The type of transform operation","enum":["accountAttribute","base64Decode","base64Encode","concat","conditional","dateCompare","dateFormat","dateMath","decomposeDiacriticalMarks","e164phone","firstValid","rule","identityAttribute","indexOf","iso3166","lastIndexOf","leftPad","lookup","lower","normalizeNames","randomAlphaNumeric","randomNumeric","reference","replaceAll","replace","rightPad","split","static","substring","trim","upper","usernameGenerator","uuid"],"example":"dateFormat","externalDocs":{"description":"Transform Operations","url":"https://developer.sailpoint.com/idn/docs/transforms/operations"}},"attributes":{"description":"Meta-data about the transform. Values in this list are specific to the type of transform to be executed.","oneOf":[{"title":"accountAttribute","type":"object","required":["sourceName","attributeName"],"properties":{"sourceName":{"type":"string","description":"A reference to the source to search for the account","example":"Workday"},"attributeName":{"type":"string","description":"The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.","example":"DEPARTMENT"},"accountSortAttribute":{"type":"string","description":"The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries","example":"created"},"accountSortDescending":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)","example":false},"accountReturnFirstLink":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false","example":false},"accountFilter":{"type":"string","description":"This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria.\nOnly certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements","example":"!(nativeIdentity.startsWith(\"*DELETED*\"))"},"accountPropertyFilter":{"type":"string","description":"This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.\n\nAll account attributes are available for filtering as this operation is performed in memory.","example":"(groups.containsAll({'Admin'}) || location == 'Austin')"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"base64Decode","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"base64Encode","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"concat","type":"object","required":["values"],"properties":{"values":{"type":"array","items":{"type":"object"},"description":"An array of items to join together","example":["John"," ","Smith"]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"conditional","type":"object","required":["expression","positiveCondition","negativeCondition"],"properties":{"expression":{"type":"string","description":"A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. \n\nThe `eq` operator is the only valid comparison","example":"ValueA eq ValueB"},"positiveCondition":{"type":"string","description":"The output of the transform if the expression evalutes to true","example":"true"},"negativeCondition":{"type":"string","description":"The output of the transform if the expression evalutes to false","example":"false"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateCompare","type":"object","required":["firstDate","secondDate","operator","positiveCondition","negativeCondition"],"properties":{"firstDate":{"description":"This is the first date to consider (The date that would be on the left hand side of the comparison operation).","oneOf":[{"title":"accountAttribute","type":"object","required":["sourceName","attributeName"],"properties":{"sourceName":{"type":"string","description":"A reference to the source to search for the account","example":"Workday"},"attributeName":{"type":"string","description":"The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.","example":"DEPARTMENT"},"accountSortAttribute":{"type":"string","description":"The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries","example":"created"},"accountSortDescending":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)","example":false},"accountReturnFirstLink":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false","example":false},"accountFilter":{"type":"string","description":"This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria.\nOnly certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements","example":"!(nativeIdentity.startsWith(\"*DELETED*\"))"},"accountPropertyFilter":{"type":"string","description":"This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.\n\nAll account attributes are available for filtering as this operation is performed in memory.","example":"(groups.containsAll({'Admin'}) || location == 'Austin')"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateFormat","type":"object","properties":{"inputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"outputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}}]},"secondDate":{"description":"This is the second date to consider (The date that would be on the right hand side of the comparison operation).","oneOf":[{"title":"accountAttribute","type":"object","required":["sourceName","attributeName"],"properties":{"sourceName":{"type":"string","description":"A reference to the source to search for the account","example":"Workday"},"attributeName":{"type":"string","description":"The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.","example":"DEPARTMENT"},"accountSortAttribute":{"type":"string","description":"The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries","example":"created"},"accountSortDescending":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)","example":false},"accountReturnFirstLink":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false","example":false},"accountFilter":{"type":"string","description":"This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria.\nOnly certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements","example":"!(nativeIdentity.startsWith(\"*DELETED*\"))"},"accountPropertyFilter":{"type":"string","description":"This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.\n\nAll account attributes are available for filtering as this operation is performed in memory.","example":"(groups.containsAll({'Admin'}) || location == 'Austin')"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateFormat","type":"object","properties":{"inputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"outputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}}]},"operator":{"type":"string","description":"This is the comparison to perform.\n| Operation | Description |\n| --------- | ------- |\n| LT | Strictly less than: firstDate < secondDate |\n| LTE | Less than or equal to: firstDate <= secondDate |\n| GT | Strictly greater than: firstDate > secondDate |\n| GTE | Greater than or equal to: firstDate >= secondDate |\n","enum":["LT","LTE","GT","GTE"],"example":"LT"},"positiveCondition":{"type":"string","description":"The output of the transform if the expression evalutes to true","example":"true"},"negativeCondition":{"type":"string","description":"The output of the transform if the expression evalutes to false","example":false},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateFormat","type":"object","properties":{"inputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"outputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateMath","type":"object","required":["expression"],"properties":{"expression":{"type":"string","description":"A string value of the date and time components to operation on, along with the math operations to execute.\n","externalDocs":{"description":"Date Math Expressions","url":"https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure"},"example":"now+1w"},"roundUp":{"type":"boolean","description":"A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. \n\n\nIf not provided, the transform will default to `false`\n\n\n`true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component)\n\n\n`false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated)\n","example":false},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"decomposeDiacriticalMarks","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"e164phone","type":"object","properties":{"defaultRegion":{"type":"string","description":"This is an optional attribute that can be used to define the region of the phone number to format into.\n\n\nIf defaultRegion is not provided, it will take US as the default country.\n\n\nThe format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\n","example":"US"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"firstValid","type":"object","required":["values"],"properties":{"values":{"type":"array","items":{"type":"object"},"description":"An array of attributes to evaluate for existence.","example":[{"attributes":{"sourceName":"Active Directory","attributeName":"sAMAccountName"},"type":"accountAttribute"},{"attributes":{"sourceName":"Okta","attributeName":"login"},"type":"accountAttribute"},{"attributes":{"sourceName":"HR Source","attributeName":"employeeID"},"type":"accountAttribute"}]},"ignoreErrors":{"type":"boolean","description":"a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur.","example":false},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false}}},{"title":"rule","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"This is the name of the Generic rule that needs to be invoked by the transform","example":"Generic Calculation Rule"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false}}},{"type":"object","required":["name","operation","includeNumbers","includeSpecialChars","length"],"properties":{"name":{"type":"string","description":"This must always be set to \"Cloud Services Deployment Utility\"","example":"Cloud Services Deployment Utility"},"operation":{"type":"string","description":"The operation to perform `generateRandomString`","example":"generateRandomString"},"includeNumbers":{"type":"boolean","description":"This must be either \"true\" or \"false\" to indicate whether the generator logic should include numbers","example":true},"includeSpecialChars":{"type":"boolean","description":"This must be either \"true\" or \"false\" to indicate whether the generator logic should include special characters","example":true},"length":{"type":"string","description":"This specifies how long the randomly generated string needs to be\n\n\n>NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters\n","example":"10"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false}}},{"type":"object","required":["name","operation","uid"],"properties":{"name":{"type":"string","description":"This must always be set to \"Cloud Services Deployment Utility\"","example":"Cloud Services Deployment Utility"},"operation":{"type":"string","description":"The operation to perform `getReferenceIdentityAttribute`","example":"getReferenceIdentityAttribute"},"uid":{"type":"string","description":"This is the SailPoint User Name (uid) value of the identity whose attribute is desired\n\nAs a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute.\n","example":"2c91808570313110017040b06f344ec9"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false}}}]},{"title":"identityAttribute","type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The system (camel-cased) name of the identity attribute to bring in","example":"email"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"indexOf","type":"object","required":["substring"],"properties":{"substring":{"type":"string","description":"A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.","example":"admin_"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"iso3166","type":"object","properties":{"format":{"type":"string","description":"An optional value to denote which ISO 3166 format to return. Valid values are:\n\n\n`alpha2` - Two-character country code (e.g., \"US\"); this is the default value if no format is supplied\n\n\n`alpha3` - Three-character country code (e.g., \"USA\")\n\n\n`numeric` - The numeric country code (e.g., \"840\")\n","example":"alpha2"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"leftPad","type":"object","required":["length"],"properties":{"length":{"type":"string","description":"An integer value for the desired length of the final output string","example":"4"},"padding":{"type":"string","description":"A string value representing the character that the incoming data should be padded with to get to the desired length\n\n\nIf not provided, the transform will default to a single space (\" \") character for padding\n","example":"0"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"lookup","type":"object","required":["table"],"properties":{"table":{"type":"object","additionalProperties":true,"description":"This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched\n\n\n>**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return \"Unknown Region\" for the attribute that is mapped to this transform.\n","example":{"USA":"Americas","FRA":"EMEA","AUS":"APAC","default":"Unknown Region"}},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"lower","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"nameNormalizer","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"randomAlphaNumeric","type":"object","properties":{"length":{"type":"string","description":"This is an integer value specifying the size/number of characters the random string must contain\n\n\n* This value must be a positive number and cannot be blank\n\n\n* If no length is provided, the transform will default to a value of `32`\n\n\n* Due to identity attribute data constraints, the maximum allowable value is `450` characters\n","example":"10"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"randomNumeric","type":"object","properties":{"length":{"type":"string","description":"This is an integer value specifying the size/number of characters the random string must contain\n\n\n* This value must be a positive number and cannot be blank\n\n\n* If no length is provided, the transform will default to a value of `32`\n\n\n* Due to identity attribute data constraints, the maximum allowable value is `450` characters\n","example":"10"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"reference","type":"object","required":["id"],"properties":{"id":{"type":"string","description":"This ID specifies the name of the pre-existing transform which you want to use within your current transform","example":"Existing Transform"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"replaceAll","type":"object","required":["table"],"properties":{"table":{"type":"object","additionalProperties":true,"description":"An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.","example":{"-":" ","\"":"'","ñ":"n"}},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"replace","type":"object","required":["regex","replacement"],"properties":{"regex":{"type":"string","description":"This can be a string or a regex pattern in which you want to replace.","example":"[^a-zA-Z]","externalDocs":{"description":"Regex Builder","url":"https://regex101.com/"}},"replacement":{"type":"string","description":"This is the replacement string that should be substituded wherever the string or pattern is found.","example":" "},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"rightPad","type":"object","required":["length"],"properties":{"length":{"type":"string","description":"An integer value for the desired length of the final output string","example":"4"},"padding":{"type":"string","description":"A string value representing the character that the incoming data should be padded with to get to the desired length\n\n\nIf not provided, the transform will default to a single space (\" \") character for padding\n","example":"0"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"split","type":"object","required":["delimiter","index"],"properties":{"delimiter":{"type":"string","description":"This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data","example":","},"index":{"type":"string","description":"An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.","example":"5"},"throws":{"type":"boolean","description":"A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array)\n\n\n`true` - The transform should return \"IndexOutOfBoundsException\"\n\n\n`false` - The transform should return null\n\n\nIf not provided, the transform will default to false and return a null\n","example":true},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"static","type":"object","required":["values"],"properties":{"values":{"type":"string","description":"This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.","example":"string$variable","externalDocs":{"description":"Static Transform Documentation","url":"https://developer.sailpoint.com/idn/docs/transforms/operations/static"}},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false}}},{"title":"substring","type":"object","required":["begin"],"properties":{"begin":{"type":"integer","description":"The index of the first character to include in the returned substring.\n\n\nIf `begin` is set to -1, the transform will begin at character 0 of the input data\n","example":1,"format":"int32"},"beginOffset":{"type":"integer","description":"This integer value is the number of characters to add to the begin attribute when returning a substring. \n\nThis attribute is only used if begin is not -1.\n","example":3,"format":"int32"},"end":{"type":"integer","description":"The index of the first character to exclude from the returned substring.\n\nIf end is -1 or not provided at all, the substring transform will return everything up to the end of the input string.\n","example":6,"format":"int32"},"endOffset":{"type":"integer","description":"This integer value is the number of characters to add to the end attribute when returning a substring. \n\nThis attribute is only used if end is provided and is not -1.\n","example":1,"format":"int32"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"trim","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"upper","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"uuid","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false}}}]},"internal":{"type":"boolean","readOnly":true,"description":"Indicates whether this is an internal SailPoint-created transform or a customer-created transform","example":false}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:transform:read"]}],"method":"get","path":"/transforms/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Transform by ID","description":{"content":"This API returns the transform specified by the given ID.\nA token with transform read authority is required to call this API.","type":"text/plain"},"url":{"path":["transforms",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the transform to retrieve","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Transform by ID' (get-transform)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Transform by ID + + + +This API returns the transform specified by the given ID. +A token with transform read authority is required to call this API. + +
    Path Parameters
    + +Transform with the given ID + +
    Schema
      attributes object
      + +Meta-data about the transform. Values in this list are specific to the type of transform to be executed. + +
      oneOf
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      firstDate object
      + +This is the first date to consider (The date that would be on the left hand side of the comparison operation). + +
      oneOf
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      inputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • outputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      secondDate object
      + +This is the second date to consider (The date that would be on the right hand side of the comparison operation). + +
      oneOf
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      inputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • outputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
       secondDate |\n| GTE | Greater than or equal to: firstDate >= secondDate |\n"} schemaName={"string"} qualifierMessage={"**Possible values:** [`LT`, `LTE`, `GT`, `GTE`]"} defaultValue={undefined}>
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      inputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • outputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      table object
      + +This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched + + +>**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. + + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      table object
      + +An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-work-item.api.mdx b/products/idn/api/v3/get-work-item.api.mdx new file mode 100644 index 000000000..efbd861a0 --- /dev/null +++ b/products/idn/api/v3/get-work-item.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-work-item +sidebar_label: Get a Work Item +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getWorkItem","tags":["Work Items"],"description":"This gets the details of a Work Item belonging to either the specified user(admin required), or the current user.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"ID of the work item.","example":"2c9180835d191a86015d28455b4a2329"}],"responses":{"200":{"description":"The work item with the given ID.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the work item","example":"2c9180835d2e5168015d32f890ca1581"},"requesterId":{"type":"string","description":"ID of the requester","example":"2c9180835d2e5168015d32f890ca1581"},"requesterDisplayName":{"type":"string","description":"The displayname of the requester","example":"John Smith"},"ownerId":{"type":"string","description":"The ID of the owner","example":"2c9180835d2e5168015d32f890ca1581"},"ownerName":{"type":"string","description":"The name of the owner","example":"Jason Smith"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z","description":"Time when the work item was created"},"modified":{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"Time when the work item was last updated"},"description":{"type":"string","description":"The description of the work item","example":"Create account on source 'AD'"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"},"type":{"type":"string","enum":["UNKNOWN","GENERIC","CERTIFICATION","REMEDIATION","DELEGATION","APPROVAL","VIOLATIONREVIEW","FORM","POLICYVIOLATION","CHALLENGE","IMPACTANALYSIS","SIGNOFF","EVENT","MANUALACTION","TEST"],"example":"GENERIC","description":"The type of the work item"},"remediationItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the certification","example":"2c9180835d2e5168015d32f890ca1581"},"targetId":{"type":"string","description":"The ID of the certification target","example":"2c9180835d2e5168015d32f890ca1581"},"targetName":{"type":"string","description":"The name of the certification target","example":"john.smith"},"targetDisplayName":{"type":"string","description":"The display name of the certification target","example":"emailAddress"},"applicationName":{"type":"string","description":"The name of the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute being certified","example":"phoneNumber"},"attributeOperation":{"type":"string","description":"The operation of the certification on the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute being certified","example":"512-555-1212"},"nativeIdentity":{"type":"string","description":"The native identity of the target","example":"jason.smith2"}}},"approvalItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the approval item","example":"2c9180835d2e5168015d32f890ca1581"},"account":{"type":"string","description":"The account referenced by the approval item","example":"john.smith"},"application":{"type":"string","description":"The name the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute","example":"emailAddress"},"attributeOperation":{"type":"string","description":"The operation of the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute","example":"a@b.com"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"}}},"name":{"type":"string","description":"The work item name","example":"Account Create"},"completed":{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z","description":"The time at which the work item completed"},"numItems":{"type":"integer","format":"int32","description":"The number of items in the work item","example":19},"form":{"type":"object","properties":{"id":{"type":"string","description":"ID of the form","example":"2c9180835d2e5168015d32f890ca1581"},"name":{"type":"string","description":"Name of the form","example":"AccountSelection Form"},"title":{"type":"string","description":"The form title","example":"Account Selection for John.Doe"},"subtitle":{"type":"string","description":"The form subtitle.","example":"Please select from the following"},"targetUser":{"type":"string","description":"The name of the user that should be shown this form","example":"Jane.Doe"},"sections":{"type":"object","allOf":[{"type":"object","properties":{"name":{"type":"string","description":"Name of the FormItem","example":"Field1"}}},{"type":"object","properties":{"label":{"type":"string","description":"Label of the section","example":"Section 1"},"formItems":{"type":"array","items":{"type":"object"},"description":"List of FormItems. FormItems can be SectionDetails and/or FieldDetails","example":[]}}}]}}},"errors":{"type":"array","items":{"type":"string"},"example":["The work item ID that was specified was not found."],"description":"An array of errors that ocurred during the work item"}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/work-items/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get a Work Item","description":{"content":"This gets the details of a Work Item belonging to either the specified user(admin required), or the current user.","type":"text/plain"},"url":{"path":["work-items",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the work item.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a Work Item' (get-work-item)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a Work Item + + + +This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. + +
    Path Parameters
    + +The work item with the given ID. + +
    Schema
      remediationItems object
      approvalItems object
      form object
      sections object
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/get-work-items-summary.api.mdx b/products/idn/api/v3/get-work-items-summary.api.mdx new file mode 100644 index 000000000..60bdd2442 --- /dev/null +++ b/products/idn/api/v3/get-work-items-summary.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-work-items-summary +sidebar_label: Work Items Summary +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getWorkItemsSummary","tags":["Work Items"],"description":"This gets a summary of work items belonging to either the specified user(admin required), or the current user.","parameters":[{"in":"query","name":"ownerId","schema":{"type":"string"},"description":"ID of the work item owner.","required":false,"example":"1211bcaa32112bcef6122adb21cef1ac"}],"responses":{"200":{"description":"List of work items","content":{"application/json":{"schema":{"type":"object","properties":{"open":{"type":"integer","description":"The count of open work items","example":29},"completed":{"type":"integer","description":"The count of completed work items","example":1},"total":{"type":"integer","description":"The count of total work items","example":30}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/work-items/summary","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Work Items Summary","description":{"content":"This gets a summary of work items belonging to either the specified user(admin required), or the current user.","type":"text/plain"},"url":{"path":["work-items","summary"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"ID of the work item owner.","type":"text/plain"},"key":"ownerId","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Work Items Summary' (get-work-items-summary)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Work Items Summary + + + +This gets a summary of work items belonging to either the specified user(admin required), or the current user. + +
    Query Parameters
    + +List of work items + +
    Schema
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/identity-profiles.tag.mdx b/products/idn/api/v3/identity-profiles.tag.mdx new file mode 100644 index 000000000..df0eec8c8 --- /dev/null +++ b/products/idn/api/v3/identity-profiles.tag.mdx @@ -0,0 +1,30 @@ +--- +id: identity-profiles +title: "Identity Profiles" +description: "Identity Profiles" +custom_edit_url: null +--- + + + +Use this API to implement identity profile functionality. +With this functionality in place, administrators can view identity profiles and their configurations. + +Identity profiles represent the configurations that can be applied to identities as a way of granting them a set of security and access, as well as defining the mappings between their identity attributes and their source attributes. + +In IdentityNow, administrators can use the Identities drop-down menu and select Identity Profiles to view the list of identity profiles. +This list shows some details about each identity profile, along with its status. +They can select an identity profile to view its settings, its mappings between identity attributes and correlating source account attributes, and its provisioning settings. + +Refer to [Creating Identity Profiles](https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html) for more information about identity profiles. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/identitynow-v-3-api.info.mdx b/products/idn/api/v3/identitynow-v-3-api.info.mdx new file mode 100644 index 000000000..6dd013c53 --- /dev/null +++ b/products/idn/api/v3/identitynow-v-3-api.info.mdx @@ -0,0 +1,36 @@ +--- +id: identitynow-v-3-api +sidebar_label: Introduction +sidebar_position: 0 +hide_title: true +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'IdentityNow V3 API' (identitynow-v-3-api)" +--- + +import ApiLogo from "@theme/ApiLogo"; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import Export from "@theme/ApiDemoPanel/Export"; + +Version: 3.0.0 + + + +# IdentityNow V3 API + + + +Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + +

    Authentication

    + +OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information. +- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) +- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) +- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) + +Which authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use) + +Learn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details) + + +
    Security Scheme Type:oauth2
    clientCredentials OAuth Flow:

    Token URL: https://tenant.api.identitynow.com/oauth/token

    Scopes:
    • sp:scopes:default: default scope
    • sp:scopes:all: access to all scopes
    authorizationCode OAuth Flow:

    Token URL: https://tenant.api.identitynow.com/oauth/token

    Authorization URL: https://tenant.identitynow.com/oauth/authorize

    Scopes:
    • sp:scopes:default: default scope
    • sp:scopes:all: access to all scopes

    Contact

    Developer Relations: URL: https://developer.sailpoint.com/discuss/api-help

    License

    MIT
    \ No newline at end of file diff --git a/products/idn/api/v3/import-accounts-schema.api.mdx b/products/idn/api/v3/import-accounts-schema.api.mdx new file mode 100644 index 000000000..7ee1fd11c --- /dev/null +++ b/products/idn/api/v3/import-accounts-schema.api.mdx @@ -0,0 +1,89 @@ +--- +id: import-accounts-schema +sidebar_label: Uploads source accounts schema template +hide_title: true +hide_table_of_contents: true +api: {"tags":["Sources"],"description":"This API uploads a source schema template file to configure a source's account attributes.\n\nTo retrieve the file to modify and upload, log into Identity Now. \n\nClick **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema**\n\n>**NOTE: This API is designated only for Delimited File sources.**","operationId":"importAccountsSchema","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"The Source id","example":"8c190e6787aa4ed9a90bd9d5344523fb"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Successfully uploaded the file","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Schema.","example":"2c9180835d191a86015d28455b4a2329"},"name":{"type":"string","description":"The name of the Schema.","example":"account"},"nativeObjectType":{"type":"string","description":"The name of the object type on the native system that the schema represents.","example":"User"},"identityAttribute":{"type":"string","description":"The name of the attribute used to calculate the unique identifier for an object in the schema.","example":"sAMAccountName"},"displayAttribute":{"type":"string","description":"The name of the attribute used to calculate the display value for an object in the schema.","example":"distinguishedName"},"hierarchyAttribute":{"type":"string","description":"The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.","example":"memberOf"},"includePermissions":{"type":"boolean","description":"Flag indicating whether or not the include permissions with the object data when aggregating the schema.","example":false},"features":{"type":"array","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.","example":"AUTHENTICATE"},"description":"The features that the schema supports.","example":["PROVISIONING","NO_PERMISSIONS_PROVISIONING","GROUPS_HAVE_MEMBERS"]},"configuration":{"type":"object","description":"Holds any extra configuration data that the schema may require.","example":{"groupMemberAttribute":"member"}},"attributes":{"type":"array","description":"The attribute definitions which form the schema.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"sAMAccountName"},"type":{"description":"The type of the attribute.","example":"STRING","type":"string","enum":["STRING","LONG","INT","BOOLEAN"]},"schema":{"description":"A reference to the schema on the source to the attribute values map to.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"The object ID this reference applies to.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The human-readable display name of the object.","example":"group"}}},"description":{"type":"string","description":"A human-readable description of the attribute.","example":"SAM Account Name"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","example":false},"isEntitlement":{"type":"boolean","description":"Flag indicating whether or not the attribute is an entitlement.","example":false},"isGroup":{"type":"boolean","description":"Flag indicating whether or not the attribute represents a group.\nThis can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute..\n","example":false}}},"example":[{"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":{"type":"string","description":"The date the Schema was created.","format":"date-time","example":"2019-12-24T22:32:58.104Z"},"modified":{"type":"string","description":"The date the Schema was last modified.","format":"date-time","example":"2019-12-31T20:22:28.104Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:source-schema:manage"]}],"method":"post","path":"/sources/{id}/schemas/accounts","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Uploads source accounts schema template","description":{"content":"This API uploads a source schema template file to configure a source's account attributes.\n\nTo retrieve the file to modify and upload, log into Identity Now. \n\nClick **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema**\n\n>**NOTE: This API is designated only for Delimited File sources.**","type":"text/plain"},"url":{"path":["sources",":id","schemas","accounts"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[]},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Uploads source accounts schema template' (import-accounts-schema)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Uploads source accounts schema template + + + +This API uploads a source schema template file to configure a source's account attributes. + +To retrieve the file to modify and upload, log into Identity Now. + +Click **Admin** -\> **Connections** -\> **Sources** -\> **`{SourceName}`** -\> **Import Data** -\> **Account Schema** -\> **Options** -\> **Download Schema** + +>**NOTE: This API is designated only for Delimited File sources.** + +
    Path Parameters
    Request Body required
    + +Successfully uploaded the file + +
    Schema
      attributes object[]
      + +The attribute definitions which form the schema. + +
      schema object
      + +A reference to the schema on the source to the attribute values map to. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/import-connector-file.api.mdx b/products/idn/api/v3/import-connector-file.api.mdx new file mode 100644 index 000000000..18cf9cb77 --- /dev/null +++ b/products/idn/api/v3/import-connector-file.api.mdx @@ -0,0 +1,116 @@ +--- +id: import-connector-file +sidebar_label: Upload connector file to source +hide_title: true +hide_table_of_contents: true +api: {"operationId":"importConnectorFile","security":[{"oauth2":["idn:sources-admin:manage"]}],"tags":["Sources"],"parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source id.","example":"2c9180835d191a86015d28455b4a2329"}],"description":"This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events.\nA token with ORG_ADMIN authority is required to call this API.","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Uploaded the file successfully and sent all post-upload events","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"the id of the Source","example":"2c91808568c529c60168cca6f90c1324"},"name":{"type":"string","description":"Human-readable name of the source","example":"My Source"},"description":{"type":"string","description":"Human-readable description of the source","example":"This is the corporate directory."},"owner":{"description":"Reference to an owning Identity Object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity","example":"MyName"}}},"cluster":{"description":"Reference to the associated Cluster","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"type":"string","description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"accountCorrelationConfig":{"description":"Reference to an Account Correlation Config object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG"],"example":"ACCOUNT_CORRELATION_CONFIG"},"id":{"type":"string","description":"ID of the account correlation config","example":"2c9180855d191c59015d28583727245a"},"name":{"type":"string","description":"Human-readable display name of the account correlation config","example":"Directory [source-62867] Account Correlation"}}},"accountCorrelationRule":{"description":"Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"managerCorrelationMapping":{"description":"Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity","type":"object","properties":{"accountAttribute":{"type":"string","description":"Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.","example":"manager"},"identityAttribute":{"type":"string","description":"Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.","example":"manager"}}},"managerCorrelationRule":{"description":"Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"beforeProvisioningRule":{"description":"Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"schemas":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"ID of the schema","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the schema","example":"MySchema"}}},"description":"List of references to Schema objects","example":[{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232a","name":"account"},{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232b","name":"group"}]},"passwordPolicies":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["PASSWORD_POLICY"],"example":"PASSWORD_POLICY"},"id":{"type":"string","description":"ID of the policy","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the policy","example":"My Password Policy"}}},"description":"List of references to the associated PasswordPolicy objects.","example":[{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb053980","name":"Corporate Password Policy"},{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb057777","name":"Vendor Password Policy"}]},"features":{"type":"array","description":"Optional features that can be supported by a source.","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.","example":"AUTHENTICATE"},"example":["SYNC_PROVISIONING","MANAGER_LOOKUP","SEARCH","PROVISIONING","AUTHENTICATE","GROUP_PROVISIONING","PASSWORD"]},"type":{"type":"string","description":"Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ","example":"OpenLDAP - Direct"},"connector":{"type":"string","description":"Connector script name.","example":"active-directory"},"connectorClass":{"type":"string","description":"The fully qualified name of the Java class that implements the connector interface.","example":"sailpoint.connector.LDAPConnector"},"connectorAttributes":{"type":"object","description":"Connector specific configuration; will differ from type to type.","example":{"healthCheckTimeout":30,"authSearchAttributes":["cn","uid","mail"]}},"deleteThreshold":{"type":"integer","format":"int32","description":"Number from 0 to 100 that specifies when to skip the delete phase.","example":10},"authoritative":{"type":"boolean","description":"When true indicates the source is referenced by an IdentityProfile.","example":false},"managementWorkgroup":{"description":"Reference to Management Workgroup for this Source","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["GOVERNANCE_GROUP"],"example":"GOVERNANCE_GROUP"},"id":{"type":"string","description":"ID of the management workgroup","example":"2c91808568c529c60168cca6f90c2222"},"name":{"type":"string","description":"Human-readable display name of the management workgroup","example":"My Management Workgroup"}}},"healthy":{"type":"boolean","description":"When true indicates a healthy source","example":true},"status":{"type":"string","description":"A status identifier, giving specific information on why a source is healthy or not","example":"SOURCE_STATE_HEALTHY"},"since":{"type":"string","description":"Timestamp showing when a source health check was last performed","example":"2021-09-28T15:48:29.3801666300Z"},"connectorId":{"type":"string","description":"The id of connector","example":"active-directory"},"connectorName":{"type":"string","description":"The name of the connector that was chosen on source creation","example":"Active Directory"},"connectionType":{"type":"string","description":"The type of connection (direct or file)","example":"file"},"connectorImplementstionId":{"type":"string","description":"The connector implementstion id","example":"delimited-file"}},"required":["name","owner","connector"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sources/{sourceId}/upload-connector-file","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Upload connector file to source","description":{"content":"This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":sourceId","upload-connector-file"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id.","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[]},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Upload connector file to source' (import-connector-file)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Upload connector file to source + + + +This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events. +A token with ORG_ADMIN authority is required to call this API. + +
    Path Parameters
    Request Body required
    + +Uploaded the file successfully and sent all post-upload events + +
    Schema
      owner object
      + +Reference to an owning Identity Object + +
      cluster object
      + +Reference to the associated Cluster + +
      accountCorrelationConfig object
      + +Reference to an Account Correlation Config object + +
      accountCorrelationRule object
      + +Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used. + +
      managerCorrelationMapping object
      + +Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + +
      managerCorrelationRule object
      + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
      beforeProvisioningRule object
      + +Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + +
      schemas object[]
      + +List of references to Schema objects + +
      passwordPolicies object[]
      + +List of references to the associated PasswordPolicy objects. + +
      managementWorkgroup object
      + +Reference to Management Workgroup for this Source + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/import-entitlements-schema.api.mdx b/products/idn/api/v3/import-entitlements-schema.api.mdx new file mode 100644 index 000000000..802318ecd --- /dev/null +++ b/products/idn/api/v3/import-entitlements-schema.api.mdx @@ -0,0 +1,89 @@ +--- +id: import-entitlements-schema +sidebar_label: Uploads source entitlements schema template +hide_title: true +hide_table_of_contents: true +api: {"tags":["Sources"],"description":"This API uploads a source schema template file to configure a source's entitlement attributes.\n\nTo retrieve the file to modify and upload, log into Identity Now. \n\nClick **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download**\n\n>**NOTE: This API is designated only for Delimited File sources.**","operationId":"importEntitlementsSchema","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"The Source id","example":"8c190e6787aa4ed9a90bd9d5344523fb"},{"in":"query","name":"schemaName","schema":{"type":"string"},"description":"Name of entitlement schema","example":"?schemaName=group"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Successfully uploaded the file","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Schema.","example":"2c9180835d191a86015d28455b4a2329"},"name":{"type":"string","description":"The name of the Schema.","example":"account"},"nativeObjectType":{"type":"string","description":"The name of the object type on the native system that the schema represents.","example":"User"},"identityAttribute":{"type":"string","description":"The name of the attribute used to calculate the unique identifier for an object in the schema.","example":"sAMAccountName"},"displayAttribute":{"type":"string","description":"The name of the attribute used to calculate the display value for an object in the schema.","example":"distinguishedName"},"hierarchyAttribute":{"type":"string","description":"The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.","example":"memberOf"},"includePermissions":{"type":"boolean","description":"Flag indicating whether or not the include permissions with the object data when aggregating the schema.","example":false},"features":{"type":"array","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.","example":"AUTHENTICATE"},"description":"The features that the schema supports.","example":["PROVISIONING","NO_PERMISSIONS_PROVISIONING","GROUPS_HAVE_MEMBERS"]},"configuration":{"type":"object","description":"Holds any extra configuration data that the schema may require.","example":{"groupMemberAttribute":"member"}},"attributes":{"type":"array","description":"The attribute definitions which form the schema.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"sAMAccountName"},"type":{"description":"The type of the attribute.","example":"STRING","type":"string","enum":["STRING","LONG","INT","BOOLEAN"]},"schema":{"description":"A reference to the schema on the source to the attribute values map to.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"The object ID this reference applies to.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The human-readable display name of the object.","example":"group"}}},"description":{"type":"string","description":"A human-readable description of the attribute.","example":"SAM Account Name"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","example":false},"isEntitlement":{"type":"boolean","description":"Flag indicating whether or not the attribute is an entitlement.","example":false},"isGroup":{"type":"boolean","description":"Flag indicating whether or not the attribute represents a group.\nThis can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute..\n","example":false}}},"example":[{"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":{"type":"string","description":"The date the Schema was created.","format":"date-time","example":"2019-12-24T22:32:58.104Z"},"modified":{"type":"string","description":"The date the Schema was last modified.","format":"date-time","example":"2019-12-31T20:22:28.104Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:source-schema:manage"]}],"method":"post","path":"/sources/{id}/schemas/entitlements","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Uploads source entitlements schema template","description":{"content":"This API uploads a source schema template file to configure a source's entitlement attributes.\n\nTo retrieve the file to modify and upload, log into Identity Now. \n\nClick **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download**\n\n>**NOTE: This API is designated only for Delimited File sources.**","type":"text/plain"},"url":{"path":["sources",":id","schemas","entitlements"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Name of entitlement schema","type":"text/plain"},"key":"schemaName","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[]},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Uploads source entitlements schema template' (import-entitlements-schema)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Uploads source entitlements schema template + + + +This API uploads a source schema template file to configure a source's entitlement attributes. + +To retrieve the file to modify and upload, log into Identity Now. + +Click **Admin** -\> **Connections** -\> **Sources** -\> **`{SourceName}`** -\> **Import Data** -\> **Import Entitlements** -\> **Download** + +>**NOTE: This API is designated only for Delimited File sources.** + +
    Path Parameters
    Query Parameters
    Request Body required
    + +Successfully uploaded the file + +
    Schema
      attributes object[]
      + +The attribute definitions which form the schema. + +
      schema object
      + +A reference to the schema on the source to the attribute values map to. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/import-identity-profiles.api.mdx b/products/idn/api/v3/import-identity-profiles.api.mdx new file mode 100644 index 000000000..9bc0f4ce9 --- /dev/null +++ b/products/idn/api/v3/import-identity-profiles.api.mdx @@ -0,0 +1,123 @@ +--- +id: import-identity-profiles +sidebar_label: Import Identity Profiles +hide_title: true +hide_table_of_contents: true +api: {"operationId":"importIdentityProfiles","description":"This imports previously exported identity profiles.","tags":["Identity Profiles"],"requestBody":{"description":"Previously exported Identity Profiles.","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Identity Profile exported object","properties":{"version":{"type":"integer","example":1,"description":"Version or object from the target service.","format":"int32"},"self":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"object":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true},"modified":{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}},{"type":"object","required":["authoritativeSource"],"properties":{"description":{"type":"string","description":"The description of the Identity Profile.","example":"My custom flat file profile","nullable":true},"owner":{"type":"object","description":"The owner of the Identity Profile.","nullable":true,"properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Type of the object to which this reference applies","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"priority":{"type":"integer","format":"int64","description":"The priority for an Identity Profile.","example":10},"authoritativeSource":{"type":"object","properties":{"type":{"type":"string","enum":["SOURCE"],"description":"Type of the object to which this reference applies","example":"SOURCE"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"HR Active Directory"}}},"identityRefreshRequired":{"type":"boolean","default":false,"description":"True if a identity refresh is needed. Typically triggered when a change on the source has been made.","example":true},"identityCount":{"type":"integer","description":"The number of identities that belong to the Identity Profile.","format":"int32","example":8},"identityAttributeConfig":{"type":"object","description":"Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process.","properties":{"enabled":{"description":"The backend will only promote values if the profile/mapping is enabled.","type":"boolean","default":false,"example":true},"attributeTransforms":{"type":"array","items":{"type":"object","description":"Defines a transformation definition for an identity attribute.","properties":{"identityAttributeName":{"type":"string","description":"Name of the identity attribute.","example":"email"},"transformDefinition":{"description":"The seaspray transformation definition.","type":"object","properties":{"type":{"type":"string","description":"The type of the transform definition.","example":"accountAttribute"},"attributes":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"object"}]},"description":"Arbitrary key-value pairs to store any metadata for the object","example":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}}}}}}}}},"identityExceptionReportReference":{"type":"object","nullable":true,"properties":{"taskResultId":{"type":"string","format":"uuid","description":"The id of the task result.","example":"2b838de9-db9b-abcf-e646-d4f274ad4238"},"reportName":{"type":"string","example":"My annual report","description":"The name of the report."}}},"hasTimeBasedAttr":{"description":"Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile.","type":"boolean","default":false,"example":true}}}]}}}}}}},"responses":{"200":{"description":"The result of importing Identity Profiles.","content":{"application/json":{"schema":{"type":"object","title":"Import Object Response Body","description":"Response model for import of a single object.","properties":{"infos":{"description":"Informational messages returned from the target service on import.","type":"array","items":{"type":"object","title":"Config Import/Export Message","description":"Message model for Config Import/Export.","properties":{"key":{"type":"string","description":"Message key.","example":"UNKNOWN_REFERENCE_RESOLVER"},"text":{"type":"string","description":"Message text.","example":"Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]"},"details":{"type":"object","description":"Message details if any, in key:value pairs.","additionalProperties":true,"example":{"details":"message details"}}},"required":["key","text","details"]}},"warnings":{"description":"Warning messages returned from the target service on import.","type":"array","items":{"type":"object","title":"Config Import/Export Message","description":"Message model for Config Import/Export.","properties":{"key":{"type":"string","description":"Message key.","example":"UNKNOWN_REFERENCE_RESOLVER"},"text":{"type":"string","description":"Message text.","example":"Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]"},"details":{"type":"object","description":"Message details if any, in key:value pairs.","additionalProperties":true,"example":{"details":"message details"}}},"required":["key","text","details"]}},"errors":{"description":"Error messages returned from the target service on import.","type":"array","items":{"type":"object","title":"Config Import/Export Message","description":"Message model for Config Import/Export.","properties":{"key":{"type":"string","description":"Message key.","example":"UNKNOWN_REFERENCE_RESOLVER"},"text":{"type":"string","description":"Message text.","example":"Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]"},"details":{"type":"object","description":"Message details if any, in key:value pairs.","additionalProperties":true,"example":{"details":"message details"}}},"required":["key","text","details"]}},"importedObjects":{"description":"References to objects that were created or updated by the import.","type":"array","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}}},"required":["infos","warnings","errors","importedObjects"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:identity-profile:manage"]}],"method":"post","path":"/identity-profiles/import","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"version":1,"self":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"},"object":{"name":"aName","description":"My custom flat file profile","owner":{"type":"IDENTITY","id":"2c9180835d191a86015d28455b4b232a","name":"William Wilson"},"priority":10,"authoritativeSource":{"type":"SOURCE","id":"2c9180835d191a86015d28455b4b232a","name":"HR Active Directory"},"identityRefreshRequired":true,"identityCount":8,"identityAttributeConfig":{"enabled":true,"attributeTransforms":[{"identityAttributeName":"email","transformDefinition":{"type":"accountAttribute","attributes":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}}}]},"identityExceptionReportReference":{"taskResultId":"2b838de9-db9b-abcf-e646-d4f274ad4238","reportName":"My annual report"},"hasTimeBasedAttr":true}}],"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Import Identity Profiles","description":{"content":"This imports previously exported identity profiles.","type":"text/plain"},"url":{"path":["identity-profiles","import"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Import Identity Profiles' (import-identity-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Import Identity Profiles + + + +This imports previously exported identity profiles. + +
    Request Body array required
    + +Previously exported Identity Profiles. + +
      self object
      object object
      owner object
      + +The owner of the Identity Profile. + +
      authoritativeSource object required
      identityAttributeConfig object
      + +Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. + +
      attributeTransforms object[]
      transformDefinition object
      + +The seaspray transformation definition. + +
      attributes object
      + +Arbitrary key-value pairs to store any metadata for the object + +
      identityExceptionReportReference object
    + +The result of importing Identity Profiles. + +
    Schema
      infos object[]
      + +Informational messages returned from the target service on import. + +
      details object
      + +Message details if any, in key:value pairs. + +
      warnings object[]
      + +Warning messages returned from the target service on import. + +
      details object
      + +Message details if any, in key:value pairs. + +
      errors object[]
      + +Error messages returned from the target service on import. + +
      details object
      + +Message details if any, in key:value pairs. + +
      importedObjects object[]
      + +References to objects that were created or updated by the import. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/import-non-employee-records-in-bulk.api.mdx b/products/idn/api/v3/import-non-employee-records-in-bulk.api.mdx new file mode 100644 index 000000000..145a334ba --- /dev/null +++ b/products/idn/api/v3/import-non-employee-records-in-bulk.api.mdx @@ -0,0 +1,89 @@ +--- +id: import-non-employee-records-in-bulk +sidebar_label: Imports, or Updates, Non-Employee Records +hide_title: true +hide_table_of_contents: true +api: {"operationId":"importNonEmployeeRecordsInBulk","security":[{"oauth2":["idn:nelm:manage"]}],"tags":["Non-Employee Lifecycle Management"],"description":"This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create`","parameters":[{"in":"path","name":"id","description":"Source Id (UUID)","required":true,"schema":{"type":"string"},"example":"e136567de87e4d029e60b3c3c55db56d"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"data":{"type":"string","format":"binary"}},"required":["data"]}}}},"responses":{"202":{"description":"The CSV was accepted to be bulk inserted now or at a later time.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The bulk upload job's ID. (UUID)","example":"2c91808568c529c60168cca6f90cffff"},"sourceId":{"type":"string","description":"The ID of the source to bulk-upload non-employees to. (UUID)","example":"2c91808568c529c60168cca6f90c1313"},"created":{"type":"string","format":"date-time","description":"The date-time the job was submitted.","example":"2019-08-23T18:52:59.162Z"},"modified":{"type":"string","format":"date-time","description":"The date-time that the job was last updated.","example":"2019-08-23T18:52:59.162Z"},"status":{"type":"string","enum":["PENDING","IN_PROGRESS","COMPLETED","ERROR"],"description":"Returns the following values indicating the progress or result of the bulk upload job.\n\"PENDING\" means the job is queued and waiting to be processed.\n\"IN_PROGRESS\" means the job is currently being processed.\n\"COMPLETED\" means the job has been completed without any errors.\n\"ERROR\" means the job failed to process with errors.\n","example":"PENDING"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.\nThe response body will contain the list of specific errors with one on each line.\n","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/non-employee-sources/{id}/non-employee-bulk-upload","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Imports, or Updates, Non-Employee Records","description":{"content":"This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create`","type":"text/plain"},"url":{"path":["non-employee-sources",":id","non-employee-bulk-upload"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Source Id (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[]},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Imports, or Updates, Non-Employee Records' (import-non-employee-records-in-bulk)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Imports, or Updates, Non-Employee Records + + + +This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` + +
    Path Parameters
    Request Body
    + +The CSV was accepted to be bulk inserted now or at a later time. + +
    Schema
    + +Client Error - Returned if the request body is invalid. +The response body will contain the list of specific errors with one on each line. + + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/lifecycle-states.tag.mdx b/products/idn/api/v3/lifecycle-states.tag.mdx new file mode 100644 index 000000000..f2ac820cb --- /dev/null +++ b/products/idn/api/v3/lifecycle-states.tag.mdx @@ -0,0 +1,58 @@ +--- +id: lifecycle-states +title: "Lifecycle States" +description: "Lifecycle States" +custom_edit_url: null +--- + + + +Use this API to implement and customize lifecycle state functionality. +With this functionality in place, administrators can create and configure custom lifecycle states for use across their organizations, which is key to controlling which users have access, when they have access, and the access they have. + +A lifecycle state describes a user's status in a company. For example, two lifecycle states come by default with IdentityNow: 'Active' and 'Inactive.' +When an active employee takes an extended leave of absence from a company, his or her lifecycle state may change to 'Inactive,' for security purposes. +The inactive employee would lose access to all the applications, sources, and sensitive data during the leave of absence, but when the employee returns and becomes active again, all that access would be restored. +This saves administrators the time that would otherwise be spent provisioning the employee's access to each individual tool, reviewing the employee's certification history, etc. + +Administrators can create a variety of custom lifecycle states. Refer to [Planning New Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#planning-new-lifecycle-states) for some custom lifecycle state ideas. + +Administrators must define the criteria for being in each lifecycle state, and they must define how IdentityNow manages users' access to apps and sources for each lifecycle state. + +In IdentityNow, administrators can manage lifecycle states by going to Admin > Identities > Identity Profile, selecting the identity profile whose lifecycle states they want to manage, selecting the 'Provisioning' tab, and using the left panel to either select the lifecycle state they want to modify or create a new lifecycle state. + +In the 'Provisioning' tab, administrators can make the following access changes to an identity profile's lifecycle state: + +- Enable/disable the lifecycle state for the identity profile. + +- Enable/disable source accounts for the identity profile's lifecycle state. + +- Add existing access profiles to grant to the identity profiles in that lifecycle state. + +- Create a new access profile to grant to the identity profile in that lifecycle state. + +Access profiles granted in a previous lifecycle state are automatically revoked when the identity moves to a new lifecycle state. +To maintain access across multiple lifecycle states, administrators must grant the access profiles in each lifecycle state. +For example, if an administrator wants users with the 'HR Employee' identity profile to maintain their building access in both the 'Active' and 'Leave of Absence' lifecycle states, the administrator must grant the access profile for that building access to both lifecycle states. + +During scheduled refreshes, IdentityNow evaluates lifFecycle states to determine whether their assigned identities have the access defined in the lifecycle states' access profiles. +If the identities are missing access, IdentityNow provisions that access. + +Administrators can also use the 'Provisioning' tab to configure email notifications for IdentityNow to send whenever an identity with that identity profile has a lifecycle state change. +Refer to [Configuring Lifecycle State Notifications](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#configuring-lifecycle-state-notifications) for more information on how to do so. + +An identity's lifecycle state can have four different statuses: the lifecycle state's status can be 'Active,' it can be 'Not Set,' it can be 'Not Valid,' or it 'Does Not Match Technical Name Case.' +Refer to [Moving Identities into Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#moving-identities-into-lifecycle-states) for more information about these different lifecycle state statuses. + +Refer to [Setting Up Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html) for more information about lifecycle states. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/list-access-profiles.api.mdx b/products/idn/api/v3/list-access-profiles.api.mdx new file mode 100644 index 000000000..e93a9f90b --- /dev/null +++ b/products/idn/api/v3/list-access-profiles.api.mdx @@ -0,0 +1,113 @@ +--- +id: list-access-profiles +sidebar_label: List Access Profiles +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listAccessProfiles","tags":["Access Profiles"],"description":"This API returns a list of Access Profiles.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","parameters":[{"in":"query","name":"for-subadmin","schema":{"type":"string"},"description":"If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID.\n\nA 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.","example":"8c190e6787aa4ed9a90bd9d5344523fb","required":false},{"in":"query","name":"limit","description":"Note that for this API the maximum value for limit is 50.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":50,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":50,"default":50}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**requestable**: *eq*\n\n**source.id**: *eq, in*","example":"name eq \"SailPoint Support\"","required":false},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name, created, modified**","example":"name,-modified","required":false},{"in":"query","name":"for-segment-ids","schema":{"type":"string","format":"comma-separated"},"description":"If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.","example":"0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d","required":false},{"in":"query","name":"include-unsegmented","schema":{"type":"boolean","default":true},"description":"Whether or not the response list should contain unsegmented Access Profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.","example":false,"required":false}],"responses":{"200":{"description":"List of Access Profiles","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Access Profile","example":"2c91808a7190d06e01719938fcd20792","readOnly":true},"name":{"type":"string","description":"Name of the Access Profile","example":"Employee-database-read-write"},"description":{"type":"string","nullable":true,"description":"Information about the Access Profile","example":"Collection of entitlements to read/write the employee database"},"created":{"type":"string","description":"Date the Access Profile was created","format":"date-time","example":"2021-03-01T22:32:58.104Z","readOnly":true},"modified":{"type":"string","description":"Date the Access Profile was last modified.","format":"date-time","example":"2021-03-02T20:22:28.104Z","readOnly":true},"enabled":{"type":"boolean","description":"Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement.","example":true},"owner":{"description":"Owner of the Access Profile","type":"object","nullable":true,"properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"source":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Source with with which the Access Profile is associated","example":"2c91809773dee3610173fdb0b6061ef4"},"type":{"type":"string","enum":["SOURCE"],"description":"The type of the Source, will always be SOURCE","example":"SOURCE"},"name":{"type":"string","description":"The display name of the associated Source","example":"ODS-AD-SOURCE"}}},"entitlements":{"type":"array","description":"A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement.","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Entitlement","example":"2c91809773dee32014e13e122092014e"},"type":{"type":"string","enum":["ENTITLEMENT"],"description":"The type of the Entitlement, will always be ENTITLEMENT","example":"ENTITLEMENT"},"name":{"type":"string","description":"The display name of the Entitlement","example":"CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"}}}},"requestable":{"type":"boolean","description":"Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error.","example":true},"accessRequestConfig":{"nullable":true,"description":"Access request configuration for this object","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":true},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":true},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"revocationRequestConfig":{"nullable":true,"description":"Revocation request configuration for this object.","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":false,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":false,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the revocation request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"segments":{"type":"array","nullable":true,"items":{"type":"string"},"description":"List of IDs of segments, if any, to which this Access Profile is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]},"provisioningCriteria":{"description":"When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression is evaluated against those Accounts to choose one to provision with the Access Profile.","nullable":true,"example":{"operation":"OR","children":[{"operation":"AND","children":[{"attribute":"dn","operation":"CONTAINS","value":"useast"},{"attribute":"manager","operation":"CONTAINS","value":"Scott.Clark"}]},{"operation":"AND","children":[{"attribute":"dn","operation":"EQUALS","value":"Gibson"},{"attribute":"telephoneNumber","operation":"CONTAINS","value":"512"}]}]},"type":"object","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","nullable":true,"description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines matching criteria for an Account to be provisioned with a specific Access Profile","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","nullable":true,"description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines matching criteria for an Account to be provisioned with a specific Access Profile","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.","example":null}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.","example":null}}}},"required":["owner","name","source"]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:access-profile:read"]}],"method":"get","path":"/access-profiles","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List Access Profiles","description":{"content":"This API returns a list of Access Profiles.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["access-profiles"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID.\n\nA 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.","type":"text/plain"},"key":"for-subadmin","value":""},{"disabled":false,"description":{"content":"Note that for this API the maximum value for limit is 50.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**created, modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**requestable**: *eq*\n\n**source.id**: *eq, in*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name, created, modified**","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.","type":"text/plain"},"key":"for-segment-ids","value":""},{"disabled":false,"description":{"content":"Whether or not the response list should contain unsegmented Access Profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.","type":"text/plain"},"key":"include-unsegmented","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Access Profiles' (list-access-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Access Profiles + + + +This API returns a list of Access Profiles. + +A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +
    Query Parameters
    + +List of Access Profiles + +
    Schema array
      owner object
      + +Owner of the Access Profile + +
      source object
      entitlements object[]
      + +A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. + +
      accessRequestConfig object
      + +Access request configuration for this object + +
      approvalSchemes object[]
      + +List describing the steps in approving the request + +
      revocationRequestConfig object
      + +Revocation request configuration for this object. + +
      approvalSchemes object[]
      + +List describing the steps in approving the revocation request + +
      provisioningCriteria object
      + +When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression is evaluated against those Accounts to choose one to provision with the Access Profile. + +
      children object[]
      + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + +
      children object[]
      + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-access-request-status.api.mdx b/products/idn/api/v3/list-access-request-status.api.mdx new file mode 100644 index 000000000..bb2242eeb --- /dev/null +++ b/products/idn/api/v3/list-access-request-status.api.mdx @@ -0,0 +1,172 @@ +--- +id: list-access-request-status +sidebar_label: Access Request Status +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listAccessRequestStatus","tags":["Access Requests"],"description":"The Access Request Status API returns a list of access request statuses based on the specified query parameters.\nAny token with any authority can request their own status. A token with ORG_ADMIN authority is required to call this API to get a list of statuses for other users.","parameters":[{"in":"query","name":"requested-for","schema":{"type":"string"},"example":"2c9180877b2b6ea4017b2c545f971429","description":"Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","required":false},{"in":"query","name":"requested-by","schema":{"type":"string"},"example":"2c9180877b2b6ea4017b2c545f971429","description":"Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","required":false},{"in":"query","name":"regarding-identity","schema":{"type":"string"},"example":"2c9180877b2b6ea4017b2c545f971429","description":"Filter the results by the specified identity which is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*.","required":false},{"in":"query","name":"count","description":"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.","required":false,"schema":{"type":"boolean","default":false},"example":false},{"in":"query","name":"limit","description":"Max number of results to return.","required":false,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250},"example":100},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.","required":false,"schema":{"type":"integer","format":"int32","minimum":0},"example":10},{"in":"query","name":"filters","schema":{"type":"string"},"example":"accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**accountActivityItemId**: *eq, in*","required":false},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created, modified, accountActivityItemId**","example":"created","required":false}],"responses":{"200":{"description":"List of requested item status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Human-readable display name of the item being requested.","example":"AccessProfile1"},"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"Type of requested object.","example":"ACCESS_PROFILE"},"cancelledRequestDetails":{"nullable":true,"type":"object","properties":{"comment":{"type":"string","description":"Comment made by the owner when cancelling the associated request.","example":"Nisl quis ipsum quam quisque condimentum nunc ut dolor nunc."},"owner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"modified":{"type":"string","format":"date-time","description":"Date comment was added by the owner when cancelling the associated request","example":"2019-12-20T09:17:12.192Z"}},"description":"Provides additional details for a request that has been cancelled."},"errorMessages":{"type":"array","nullable":true,"items":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"description":"List of list of localized error messages, if any, encountered during the approval/provisioning process."},"state":{"type":"string","enum":["EXECUTING","REQUEST_COMPLETED","CANCELLED","TERMINATED","PROVISIONING_VERIFICATION_PENDING","REJECTED","PROVISIONING_FAILED","NOT_ALL_ITEMS_PROVISIONED","ERROR"],"description":"Indicates the state of an access request:\n* EXECUTING: The request is executing, which indicates the system is doing some processing.\n* REQUEST_COMPLETED: Indicates the request has been completed.\n* CANCELLED: The request was cancelled with no user input.\n* TERMINATED: The request has been terminated before it was able to complete.\n* PROVISIONING_VERIFICATION_PENDING: The request has finished any approval steps and provisioning is waiting to be verified.\n* REJECTED: The request was rejected.\n* PROVISIONING_FAILED: The request has failed to complete.\n* NOT_ALL_ITEMS_PROVISIONED: One or more of the requested items failed to complete, but there were one or more successes.\n* ERROR: An error occurred during request processing.","example":"EXECUTING"},"approvalDetails":{"type":"array","items":{"type":"object","properties":{"forwarded":{"type":"boolean","description":"True if the request for this item was forwarded from one owner to another.","example":false},"originalOwner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Base identity/workgroup reference object representing the original owner, if forwarded."},"currentOwner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Base reference of approver that will make decision."},"reviewedBy":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The identity who has reviewed the approval."},"modified":{"type":"string","format":"date-time","description":"Time at which item was modified.","example":"2019-08-23T18:52:57.398Z"},"status":{"type":"string","enum":["PENDING","APPROVED","REJECTED","EXPIRED","CANCELLED","ARCHIVED"],"description":"Indicates the state of the request processing for this item:\n* PENDING: The request for this item is awaiting processing.\n* APPROVED: The request for this item has been approved.\n* REJECTED: The request for this item was rejected.\n* EXPIRED: The request for this item expired with no action taken.\n* CANCELLED: The request for this item was cancelled with no user action.\n* ARCHIVED: The request for this item has been archived after completion.","example":"PENDING"},"scheme":{"type":"string","enum":["APP_OWNER","SOURCE_OWNER","MANAGER","ROLE_OWNER","ACCESS_PROFILE_OWNER","ENTITLEMENT_OWNER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step.","example":"MANAGER"},"errorMessages":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}},"description":"If the request failed, includes any error messages that were generated."},"comment":{"type":"string","description":"Comment, if any, provided by the approver.","example":"I approve this request"},"removeDate":{"type":"string","description":"The date the role or access profile is no longer assigned to the specified identity.","format":"date-time","example":"2020-07-11T00:00:00Z"}}},"description":"Approval details for each item."},"manualWorkItemDetails":{"type":"array","nullable":true,"items":{"type":"object","properties":{"forwarded":{"type":"boolean","description":"True if the request for this item was forwarded from one owner to another.","example":true},"originalOwner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Base identity/workgroup reference object representing the original owner, if forwarded."},"currentOwner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Base reference of approver that will make decision."},"modified":{"type":"string","format":"date-time","description":"Time at which item was modified.","example":"2019-08-23T18:52:57.398Z"},"status":{"type":"string","enum":["PENDING","APPROVED","REJECTED","EXPIRED","CANCELLED","ARCHIVED"],"description":"Indicates the state of the request processing for this item:\n* PENDING: The request for this item is awaiting processing.\n* APPROVED: The request for this item has been approved.\n* REJECTED: The request for this item was rejected.\n* EXPIRED: The request for this item expired with no action taken.\n* CANCELLED: The request for this item was cancelled with no user action.\n* ARCHIVED: The request for this item has been archived after completion.","example":"PENDING"},"forwardHistory":{"type":"array","items":{"type":"object","properties":{"oldApproverName":{"type":"string","description":"Display name of approver from whom the approval was forwarded.","example":"Frank Mir"},"newApproverName":{"type":"string","description":"Display name of approver to whom the approval was forwarded.","example":"Al Volta"},"comment":{"type":"string","nullable":true,"description":"Comment made while forwarding.","example":"Forwarding from Frank to Al"},"modified":{"type":"string","format":"date-time","description":"Time at which approval was forwarded.","example":"2019-08-23T18:52:57.398Z"},"forwarderName":{"type":"string","nullable":true,"description":"Display name of forwarder who forwarded the approval.","example":"William Wilson"},"reassignmentType":{"description":"The approval reassignment type. \n* MANUAL_REASSIGNMENT: An approval with this reassignment type has been specifically reassigned by the approval task's owner, from their queue to someone else's. \n* AUTOMATIC_REASSIGNMENT: An approval with this reassignment type has been automatically reassigned from another approver's queue, according to that approver's reassignment configuration. The approver's reassignment configuration may be set up to automatically reassign approval tasks for a defined (or possibly open-ended) period of time.\n* AUTO_ESCALATION: An approval with this reassignment type has been automatically reassigned from another approver's queue, according to the request's escalation configuration. For more information about escalation configuration, refer to [Setting Global Reminders and Escalation Policies](https://documentation.sailpoint.com/saas/help/requests/config_emails.html).\n* SELF_REVIEW_DELEGATION: An approval with this reassignment type has been automatically reassigned by the system to prevent self-review. This helps prevent situations like a requester being tasked with approving their own request. For more information about preventing self-review, refer to [Self-review Prevention](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html#self-review-prevention) and [Preventing Self-approval](https://documentation.sailpoint.com/saas/help/requests/config_ap_roles.html#preventing-self-approval).","example":"AUTOMATIC_REASSIGNMENT","type":"string","enum":["MANUAL_REASSIGNMENT","AUTOMATIC_REASSIGNMENT","AUTO_ESCALATION","SELF_REVIEW_DELEGATION"]}}},"description":"The history of approval forward action."}}},"description":"Manual work items created for provisioning the item."},"accountActivityItemId":{"type":"string","description":"Id of associated account activity item.","example":"2c9180926cbfbddd016cbfc7c3b10010"},"requestType":{"type":"string","enum":["GRANT_ACCESS","REVOKE_ACCESS"],"description":"Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field.","example":"GRANT_ACCESS"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"},"requester":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The identity that requested the item."},"requestedFor":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The identity for whom the Access Request Status is requested for."},"requesterComment":{"nullable":true,"description":"The requester's comment.","type":"object","properties":{"comment":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat"},"author":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the author","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"}}},"created":{"type":"string","format":"date-time","description":"Date and time comment was created","example":"2017-07-11T18:45:37.098Z"}}},"sodViolationContext":{"nullable":true,"description":"The details of the SOD violations for the associated approval.","type":"object","properties":{"state":{"type":"string","enum":["SUCCESS","ERROR"],"description":"The status of SOD violation check","example":"SUCCESS"},"uuid":{"description":"The id of the Violation check event","type":"string","example":"f73d16e9-a038-46c5-b217-1246e15fdbdd"},"violationCheckResult":{"description":"The inner object representing the completed SOD Violation check","type":"object","properties":{"message":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}},"description":"If the request failed, includes any error message that was generated.","example":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An error has occurred during the SOD violation check"}]},"clientMetadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check.","example":{"requestedAppName":"test-app","requestedAppId":"2c91808f7892918f0178b78da4a305a1"}},"violationContexts":{"type":"array","items":{"description":"The contextual information of the violated criteria","type":"object","properties":{"policy":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Reference to the Policy that is being violated."},"conflictingAccessCriteria":{"type":"object","description":"The object which contains the left and right hand side of the entitlements that got violated according to the policy.","properties":{"leftCriteria":{"type":"object","properties":{"criteriaList":{"type":"array","items":{"description":"Details of the Entitlement criteria","type":"object","properties":{"existing":{"type":"boolean","example":true,"description":"If the entitlement already belonged to the user or not."},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Entitlement ID","example":"2c918085771e9d3301773b3cb66f6398"},"name":{"type":"string","description":"Entitlement name","example":"My HR Entitlement"}}}}}},"rightCriteria":{"type":"object","properties":{"criteriaList":{"type":"array","items":{"description":"Details of the Entitlement criteria","type":"object","properties":{"existing":{"type":"boolean","example":true,"description":"If the entitlement already belonged to the user or not."},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Entitlement ID","example":"2c918085771e9d3301773b3cb66f6398"},"name":{"type":"string","description":"Entitlement name","example":"My HR Entitlement"}}}}}}}}}}},"violatedPolicies":{"type":"array","description":"A list of the Policies that were violated","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Reference to the policy that was violated","example":[{"type":"SOD_POLICY","id":"69129440-422d-4a23-aadd-35c828d5bfda","name":"HR Policy"}]}}}}}},"provisioningDetails":{"nullable":true,"type":"object","properties":{"orderedSubPhaseReferences":{"type":"string","description":"Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase.","example":"manualWorkItemDetails"}},"description":"Provides additional details about provisioning for this request."},"preApprovalTriggerDetails":{"nullable":true,"type":"object","properties":{"comment":{"type":"string","description":"Comment left for the pre-approval decision","example":"Access is Approved"},"reviewer":{"type":"string","description":"The reviewer of the pre-approval decision","example":"John Doe"},"decision":{"type":"string","enum":["APPROVED","REJECTED"],"description":"The decision of the pre-approval trigger","example":"APPROVED"}},"description":"Provides additional details about the pre-approval trigger for this request."},"accessRequestPhases":{"type":"array","items":{"type":"object","properties":{"started":{"type":"string","description":"The time that this phase started.","format":"date-time","example":"2020-07-11T00:00:00Z"},"finished":{"type":"string","description":"The time that this phase finished.","format":"date-time","example":"2020-07-12T00:00:00Z"},"name":{"type":"string","description":"The name of this phase.","example":"APPROVAL_PHASE"},"state":{"type":"string","enum":["PENDING","EXECUTING","COMPLETED","CANCELLED"],"description":"The state of this phase.","example":"COMPLETED"},"result":{"type":"string","enum":["SUCCESSFUL","FAILED"],"description":"The state of this phase.","example":"SUCCESSFUL"},"phaseReference":{"type":"string","description":"A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items.","example":"approvalDetails"}},"description":"Provides additional details about this access request phase."},"description":"A list of Phases that the Access Request has gone through in order, to help determine the status of the request."},"description":{"type":"string","description":"Description associated to the requested object.","example":"This is the Engineering role that engineers are granted."},"removeDate":{"type":"string","format":"date-time","nullable":true,"description":"When the role access is scheduled for removal.","example":"2019-10-23T00:00:00.000Z"},"cancelable":{"type":"boolean","description":"True if the request can be canceled.","example":true},"accessRequestId":{"type":"string","format":"string","description":"This is the account activity id.","example":"2b838de9-db9b-abcf-e646-d4f274ad4238"},"clientMetadata":{"nullable":true,"type":"object","additionalProperties":{"type":"string"},"description":"Arbitrary key-value pairs, if any were included in the corresponding access request","example":{"key1":"value1","key2":"value2"}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/access-request-status","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Access Request Status","description":{"content":"The Access Request Status API returns a list of access request statuses based on the specified query parameters.\nAny token with any authority can request their own status. A token with ORG_ADMIN authority is required to call this API to get a list of statuses for other users.","type":"text/plain"},"url":{"path":["access-request-status"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","type":"text/plain"},"key":"requested-for","value":""},{"disabled":false,"description":{"content":"Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","type":"text/plain"},"key":"requested-by","value":""},{"disabled":false,"description":{"content":"Filter the results by the specified identity which is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*.","type":"text/plain"},"key":"regarding-identity","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Max number of results to return.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**accountActivityItemId**: *eq, in*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created, modified, accountActivityItemId**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Access Request Status' (list-access-request-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Access Request Status + + + +The Access Request Status API returns a list of access request statuses based on the specified query parameters. +Any token with any authority can request their own status. A token with ORG_ADMIN authority is required to call this API to get a list of statuses for other users. + +
    Query Parameters
    + +List of requested item status. + +
    Schema array
      cancelledRequestDetails object
      + +Provides additional details for a request that has been cancelled. + +
      owner object
      approvalDetails object[]
      + +Approval details for each item. + +
      originalOwner object
      + +Base identity/workgroup reference object representing the original owner, if forwarded. + +
      currentOwner object
      + +Base reference of approver that will make decision. + +
      reviewedBy object
      + +The identity who has reviewed the approval. + +
      errorMessages object[]
      + +If the request failed, includes any error messages that were generated. + +
      manualWorkItemDetails object[]
      + +Manual work items created for provisioning the item. + +
      originalOwner object
      + +Base identity/workgroup reference object representing the original owner, if forwarded. + +
      currentOwner object
      + +Base reference of approver that will make decision. + +
      forwardHistory object[]
      + +The history of approval forward action. + +
      requester object
      + +The identity that requested the item. + +
      requestedFor object
      + +The identity for whom the Access Request Status is requested for. + +
      requesterComment object
      + +The requester's comment. + +
      author object
      sodViolationContext object
      + +The details of the SOD violations for the associated approval. + +
      violationCheckResult object
      + +The inner object representing the completed SOD Violation check + +
      message object
      + +If the request failed, includes any error message that was generated. + +
      clientMetadata object
      + +Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. + +
    • property name* string
      • violationContexts object[]
      policy object
      + +Reference to the Policy that is being violated. + +
      conflictingAccessCriteria object
      + +The object which contains the left and right hand side of the entitlements that got violated according to the policy. + +
      leftCriteria object
      criteriaList object[]
      rightCriteria object
      criteriaList object[]
      violatedPolicies object[]
      + +A list of the Policies that were violated + +
      provisioningDetails object
      + +Provides additional details about provisioning for this request. + +
      preApprovalTriggerDetails object
      + +Provides additional details about the pre-approval trigger for this request. + +
      accessRequestPhases object[]
      + +A list of Phases that the Access Request has gone through in order, to help determine the status of the request. + +
      clientMetadata object
      + +Arbitrary key-value pairs, if any were included in the corresponding access request + +
    • property name* string
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-account-activities.api.mdx b/products/idn/api/v3/list-account-activities.api.mdx new file mode 100644 index 000000000..592705a2f --- /dev/null +++ b/products/idn/api/v3/list-account-activities.api.mdx @@ -0,0 +1,91 @@ +--- +id: list-account-activities +sidebar_label: List Account Activities +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listAccountActivities","tags":["Account Activities"],"description":"This gets a collection of account activities that satisfy the given query parameters.","parameters":[{"in":"query","name":"requested-for","schema":{"type":"string"},"description":"The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","required":false,"example":"2c91808568c529c60168cca6f90c1313"},{"in":"query","name":"requested-by","schema":{"type":"string"},"description":"The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","required":false,"example":"2c91808568c529c60168cca6f90c1313"},{"in":"query","name":"regarding-identity","schema":{"type":"string"},"description":"The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*.","required":false,"example":"2c91808568c529c60168cca6f90c1313"},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results).\n\nFiltering is supported for the following fields and operators:\n\n**type**: *eq, in* (See the `type` property in the response schema for possible values)\n\n**created**: *gt, lt, ge, le*\n\n**modified**: *gt, lt, ge, le*","example":"type eq \"Identity Refresh\"","required":false},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\nSorting is supported for the following fields: **type, created, modified**","example":"created","required":false}],"responses":{"200":{"description":"List of account activities","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the account activity","example":"2c9180835d2e5168015d32f890ca1581"},"name":{"type":"string","description":"The name of the activity","example":"2c9180835d2e5168015d32f890ca1581"},"created":{"description":"When the activity was first created","type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"},"modified":{"description":"When the activity was last modified","type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z","nullable":true},"completed":{"description":"When the activity was completed","type":"string","format":"date-time","nullable":true,"example":"2018-10-19T13:49:37.385Z"},"completionStatus":{"nullable":true,"type":"string","description":"The status after completion.","enum":["SUCCESS","FAILURE","INCOMPLETE","PENDING"],"example":"SUCCESS"},"type":{"nullable":true,"type":"string","example":"appRequest","description":"The type of action the activity performed. Please see the following list of types. This list may grow over time.\n\n- CloudAutomated\n- IdentityAttributeUpdate\n- appRequest\n- LifecycleStateChange\n- AccountStateUpdate\n- AccountAttributeUpdate\n- CloudPasswordRequest\n- Attribute Synchronization Refresh\n- Certification\n- Identity Refresh\n- Lifecycle Change Refresh\n\n\n[Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data).\n"},"requesterIdentitySummary":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"ID of this identity summary","example":"ff80818155fe8c080155fe8d925b0316"},"name":{"type":"string","description":"Human-readable display name of identity","example":"SailPoint Services"},"identityId":{"type":"string","description":"ID of the identity that this summary represents","example":"c15b9f5cca5a4e9599eaa0e64fa921bd"},"completed":{"type":"boolean","description":"Indicates if all access items for this summary have been decided on","example":true}}},"targetIdentitySummary":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"ID of this identity summary","example":"ff80818155fe8c080155fe8d925b0316"},"name":{"type":"string","description":"Human-readable display name of identity","example":"SailPoint Services"},"identityId":{"type":"string","description":"ID of the identity that this summary represents","example":"c15b9f5cca5a4e9599eaa0e64fa921bd"},"completed":{"type":"boolean","description":"Indicates if all access items for this summary have been decided on","example":true}}},"errors":{"nullable":true,"description":"A list of error messages, if any, that were encountered.","type":"array","items":{"type":"string"},"example":["sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds."]},"warnings":{"nullable":true,"description":"A list of warning messages, if any, that were encountered.","type":"array","items":{"type":"string"},"example":["Some warning, another warning"]},"items":{"type":"array","description":"Individual actions performed as part of this account activity","items":{"type":"object","properties":{"id":{"type":"string","description":"Item id","example":"48c545831b264409a81befcabb0e3c5a"},"name":{"type":"string","description":"Human-readable display name of item","example":"48c545831b264409a81befcabb0e3c5a"},"requested":{"type":"string","format":"date-time","description":"Date and time item was requested","example":"2017-07-11T18:45:37.098Z"},"approvalStatus":{"nullable":true,"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"},"provisioningStatus":{"type":"string","enum":["PENDING","FINISHED","UNVERIFIABLE","COMMITED","FAILED","RETRY"],"description":"Provisioning state of an account activity item","example":"PENDING"},"requesterComment":{"type":"object","nullable":true,"properties":{"commenterId":{"type":"string","description":"Id of the identity making the comment","example":"2c918084660f45d6016617daa9210584"},"commenterName":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"},"body":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat."},"date":{"type":"string","format":"date-time","description":"Date and time comment was made","example":"2017-07-11T18:45:37.098Z"}}},"reviewerIdentitySummary":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"ID of this identity summary","example":"ff80818155fe8c080155fe8d925b0316"},"name":{"type":"string","description":"Human-readable display name of identity","example":"SailPoint Services"},"identityId":{"type":"string","description":"ID of the identity that this summary represents","example":"c15b9f5cca5a4e9599eaa0e64fa921bd"},"completed":{"type":"boolean","description":"Indicates if all access items for this summary have been decided on","example":true}}},"reviewerComment":{"type":"object","nullable":true,"properties":{"commenterId":{"type":"string","description":"Id of the identity making the comment","example":"2c918084660f45d6016617daa9210584"},"commenterName":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"},"body":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat."},"date":{"type":"string","format":"date-time","description":"Date and time comment was made","example":"2017-07-11T18:45:37.098Z"}}},"operation":{"nullable":true,"type":"string","enum":["ADD","CREATE","MODIFY","DELETE","DISABLE","ENABLE","UNLOCK","LOCK","REMOVE"],"description":"Represents an operation in an account activity item","example":"ADD"},"attribute":{"type":"string","description":"Attribute to which account activity applies","nullable":true,"example":"detectedRoles"},"value":{"type":"string","description":"Value of attribute","nullable":true,"example":"Treasury Analyst [AccessProfile-1529010191212]"},"nativeIdentity":{"nullable":true,"type":"string","description":"Native identity in the target system to which the account activity applies","example":"Sandie.Camero"},"sourceId":{"type":"string","description":"Id of Source to which account activity applies","example":"2c91808363ef85290164000587130c0c"},"accountRequestInfo":{"type":"object","nullable":true,"properties":{"requestedObjectId":{"type":"string","description":"Id of requested object","example":"2c91808563ef85690164001c31140c0c"},"requestedObjectName":{"type":"string","description":"Human-readable name of requested object","example":"Treasury Analyst"},"requestedObjectType":{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"Enum represented the currently supported requestable object types. Additional values may be added in the future without notice.","example":"ACCESS_PROFILE"}},"description":"If an account activity item is associated with an access request, captures details of that request."},"clientMetadata":{"nullable":true,"type":"object","additionalProperties":{"type":"string"},"description":"Arbitrary key-value pairs, if any were included in the corresponding access request item","example":{"customKey1":"custom value 1","customKey2":"custom value 2"}},"removeDate":{"nullable":true,"type":"string","description":"The date the role or access profile is no longer assigned to the specified identity.","format":"date-time","example":"2020-07-11T00:00:00Z"}}}},"executionStatus":{"type":"string","description":"The current state of execution.","enum":["EXECUTING","VERIFYING","TERMINATED","COMPLETED"],"example":"COMPLETED"},"clientMetadata":{"nullable":true,"type":"object","additionalProperties":{"type":"string"},"description":"Arbitrary key-value pairs, if any were included in the corresponding access request","example":{"customKey1":"custom value 1","customKey2":"custom value 2"}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/account-activities","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List Account Activities","description":{"content":"This gets a collection of account activities that satisfy the given query parameters.","type":"text/plain"},"url":{"path":["account-activities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","type":"text/plain"},"key":"requested-for","value":""},{"disabled":false,"description":{"content":"The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","type":"text/plain"},"key":"requested-by","value":""},{"disabled":false,"description":{"content":"The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*.","type":"text/plain"},"key":"regarding-identity","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results).\n\nFiltering is supported for the following fields and operators:\n\n**type**: *eq, in* (See the `type` property in the response schema for possible values)\n\n**created**: *gt, lt, ge, le*\n\n**modified**: *gt, lt, ge, le*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\nSorting is supported for the following fields: **type, created, modified**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Account Activities' (list-account-activities)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Account Activities + + + +This gets a collection of account activities that satisfy the given query parameters. + +
    Query Parameters
    + +List of account activities + +
    Schema array
      requesterIdentitySummary object
      targetIdentitySummary object
      items object[]
      + +Individual actions performed as part of this account activity + +
      requesterComment object
      reviewerIdentitySummary object
      reviewerComment object
      accountRequestInfo object
      + +If an account activity item is associated with an access request, captures details of that request. + +
      clientMetadata object
      + +Arbitrary key-value pairs, if any were included in the corresponding access request item + +
    • property name* string
      • clientMetadata object
      + +Arbitrary key-value pairs, if any were included in the corresponding access request + +
    • property name* string
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-accounts.api.mdx b/products/idn/api/v3/list-accounts.api.mdx new file mode 100644 index 000000000..520758466 --- /dev/null +++ b/products/idn/api/v3/list-accounts.api.mdx @@ -0,0 +1,80 @@ +--- +id: list-accounts +sidebar_label: Accounts List +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listAccounts","tags":["Accounts"],"description":"This returns a list of accounts. \nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:accounts:read"]}],"parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"example":"identityId eq \"2c9180858082150f0180893dbaf44201\"","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**identityId**: *eq*\n\n**name**: *eq, in*\n\n**nativeIdentity**: *eq, in*\n\n**sourceId**: *eq, in*\n\n**uncorrelated**: *eq*","required":false},{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"example":"id,name","description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **id**, **name**, **created**, **modified**"}],"responses":{"200":{"description":"List of account objects","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true},"modified":{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}},{"type":"object","required":["sourceId","sourceName","attributes","authoritative","disabled","locked","nativeIdentity","systemAccount","uncorrelated","manuallyCorrelated","hasEntitlements"],"properties":{"sourceId":{"type":"string","example":"2c9180835d2e5168015d32f890ca1581","description":"The unique ID of the source this account belongs to"},"sourceName":{"type":"string","example":"Employees","description":"The display name of the source this account belongs to"},"identityId":{"type":"string","example":"2c9180835d2e5168015d32f890ca1581","description":"The unique ID of the identity this account is correlated to"},"attributes":{"type":"object","additionalProperties":true,"description":"The account attributes that are aggregated","example":{"firstName":"SailPoint","lastName":"Support","displayName":"SailPoint Support"}},"authoritative":{"type":"boolean","description":"Indicates if this account is from an authoritative source","example":false},"description":{"type":"string","description":"A description of the account","nullable":true,"example":null},"disabled":{"type":"boolean","description":"Indicates if the account is currently disabled","example":false},"locked":{"type":"boolean","description":"Indicates if the account is currently locked","example":false},"nativeIdentity":{"type":"string","description":"The unique ID of the account generated by the source system","example":"552775"},"systemAccount":{"type":"boolean","example":false,"description":"If true, this is a user account within IdentityNow. If false, this is an account from a source system."},"uncorrelated":{"type":"boolean","description":"Indicates if this account is not correlated to an identity","example":false},"uuid":{"type":"string","description":"The unique ID of the account as determined by the account schema","example":"slpt.support","nullable":true},"manuallyCorrelated":{"type":"boolean","description":"Indicates if the account has been manually correlated to an identity","example":false},"hasEntitlements":{"type":"boolean","description":"Indicates if the account has entitlements","example":true}}}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/accounts","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Accounts List","description":{"content":"This returns a list of accounts. \nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**identityId**: *eq*\n\n**name**: *eq, in*\n\n**nativeIdentity**: *eq, in*\n\n**sourceId**: *eq, in*\n\n**uncorrelated**: *eq*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **id**, **name**, **created**, **modified**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Accounts List' (list-accounts)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Accounts List + + + +This returns a list of accounts. +A token with ORG_ADMIN authority is required to call this API. + +
    Query Parameters
    + +List of account objects + +
    Schema array
      attributes object
      + +The account attributes that are aggregated + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-completed-approvals.api.mdx b/products/idn/api/v3/list-completed-approvals.api.mdx new file mode 100644 index 000000000..93168d89e --- /dev/null +++ b/products/idn/api/v3/list-completed-approvals.api.mdx @@ -0,0 +1,135 @@ +--- +id: list-completed-approvals +sidebar_label: Completed Access Request Approvals List +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listCompletedApprovals","tags":["Access Request Approvals"],"description":"This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info.","parameters":[{"in":"query","name":"owner-id","required":false,"schema":{"type":"string"},"description":"If present, the value returns only completed approvals for the specified identity.\n * ORG_ADMIN users can call this with any identity ID value.\n * ORG_ADMIN users can also fetch all the approvals in the org, when\nowner-id is not used.\n * Non-ORG_ADMIN users can only specify *me* or pass their own\nidentity ID value.","example":"2c91808568c529c60168cca6f90c1313"},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**requestedFor.id**: *eq, in*\n\n**modified**: *gt, lt, ge, le*","example":"id eq \"2c91808568c529c60168cca6f90c1313\""},{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created, modified**","example":"modified"}],"responses":{"200":{"description":"List of Completed Approvals.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The approval id.","example":"id12345"},"name":{"type":"string","description":"The name of the approval.","example":"aName"},"created":{"type":"string","format":"date-time","description":"When the approval was created.","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","description":"When the approval was modified last time.","example":"2018-07-25T20:22:28.104Z"},"requestCreated":{"type":"string","format":"date-time","description":"When the access-request was created.","example":"2017-07-11T18:45:35.098Z"},"requestType":{"type":"string","enum":["GRANT_ACCESS","REVOKE_ACCESS"],"description":"Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field.","example":"GRANT_ACCESS"},"requester":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The identity that requested the item."},"requestedFor":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The identity for whom the item is requested for."},"reviewedBy":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The identity who has reviewed the approval."},"owner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The owner or approver of the approval."},"requestedObject":{"description":"The requested access item.","type":"object","properties":{"id":{"type":"string","description":"Id of the object.","example":"2c9180835d2e5168015d32f890ca1581"},"name":{"type":"string","description":"Name of the object.","example":"Applied Research Access"},"description":{"type":"string","description":"Description of the object.","example":"Access to research information, lab results, and schematics"},"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"Type of the object.","example":"ROLE"}}},"requesterComment":{"type":"object","properties":{"comment":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat"},"author":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the author","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"}}},"created":{"type":"string","format":"date-time","description":"Date and time comment was created","example":"2017-07-11T18:45:37.098Z"}},"description":"The requester's comment."},"reviewerComment":{"allOf":[{"type":"object","properties":{"comment":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat"},"author":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the author","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"}}},"created":{"type":"string","format":"date-time","description":"Date and time comment was created","example":"2017-07-11T18:45:37.098Z"}}}],"description":"The approval's reviewer's comment.","nullable":true},"previousReviewersComments":{"type":"array","items":{"type":"object","properties":{"comment":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat"},"author":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the author","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"}}},"created":{"type":"string","format":"date-time","description":"Date and time comment was created","example":"2017-07-11T18:45:37.098Z"}}},"description":"The history of the previous reviewers comments."},"forwardHistory":{"type":"array","items":{"type":"object","properties":{"oldApproverName":{"type":"string","description":"Display name of approver from whom the approval was forwarded.","example":"Frank Mir"},"newApproverName":{"type":"string","description":"Display name of approver to whom the approval was forwarded.","example":"Al Volta"},"comment":{"type":"string","nullable":true,"description":"Comment made while forwarding.","example":"Forwarding from Frank to Al"},"modified":{"type":"string","format":"date-time","description":"Time at which approval was forwarded.","example":"2019-08-23T18:52:57.398Z"},"forwarderName":{"type":"string","nullable":true,"description":"Display name of forwarder who forwarded the approval.","example":"William Wilson"},"reassignmentType":{"description":"The approval reassignment type. \n* MANUAL_REASSIGNMENT: An approval with this reassignment type has been specifically reassigned by the approval task's owner, from their queue to someone else's. \n* AUTOMATIC_REASSIGNMENT: An approval with this reassignment type has been automatically reassigned from another approver's queue, according to that approver's reassignment configuration. The approver's reassignment configuration may be set up to automatically reassign approval tasks for a defined (or possibly open-ended) period of time.\n* AUTO_ESCALATION: An approval with this reassignment type has been automatically reassigned from another approver's queue, according to the request's escalation configuration. For more information about escalation configuration, refer to [Setting Global Reminders and Escalation Policies](https://documentation.sailpoint.com/saas/help/requests/config_emails.html).\n* SELF_REVIEW_DELEGATION: An approval with this reassignment type has been automatically reassigned by the system to prevent self-review. This helps prevent situations like a requester being tasked with approving their own request. For more information about preventing self-review, refer to [Self-review Prevention](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html#self-review-prevention) and [Preventing Self-approval](https://documentation.sailpoint.com/saas/help/requests/config_ap_roles.html#preventing-self-approval).","example":"AUTOMATIC_REASSIGNMENT","type":"string","enum":["MANUAL_REASSIGNMENT","AUTOMATIC_REASSIGNMENT","AUTO_ESCALATION","SELF_REVIEW_DELEGATION"]}}},"description":"The history of approval forward action."},"commentRequiredWhenRejected":{"type":"boolean","description":"When true the rejector has to provide comments when rejecting","example":true},"state":{"description":"The final state of the approval","type":"string","enum":["APPROVED","REJECTED"],"example":"APPROVED"},"removeDate":{"type":"string","description":"The date the role or access profile is no longer assigned to the specified identity.","format":"date-time","example":"2020-07-11T00:00:00Z","nullable":true},"removeDateUpdateRequested":{"type":"boolean","description":"If true, then the request was to change the remove date or sunset date.","example":true},"currentRemoveDate":{"type":"string","description":"The remove date or sunset date that was assigned at the time of the request.","format":"date-time","example":"2020-07-11T00:00:00Z","nullable":true},"sodViolationContext":{"description":"The details of the SOD violations for the associated approval.","type":"object","properties":{"state":{"type":"string","enum":["SUCCESS","ERROR"],"description":"The status of SOD violation check","example":"SUCCESS"},"uuid":{"description":"The id of the Violation check event","type":"string","example":"f73d16e9-a038-46c5-b217-1246e15fdbdd"},"violationCheckResult":{"description":"The inner object representing the completed SOD Violation check","type":"object","properties":{"message":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}},"description":"If the request failed, includes any error message that was generated.","example":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An error has occurred during the SOD violation check"}]},"clientMetadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check.","example":{"requestedAppName":"test-app","requestedAppId":"2c91808f7892918f0178b78da4a305a1"}},"violationContexts":{"type":"array","items":{"description":"The contextual information of the violated criteria","type":"object","properties":{"policy":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Reference to the Policy that is being violated."},"conflictingAccessCriteria":{"type":"object","description":"The object which contains the left and right hand side of the entitlements that got violated according to the policy.","properties":{"leftCriteria":{"type":"object","properties":{"criteriaList":{"type":"array","items":{"description":"Details of the Entitlement criteria","type":"object","properties":{"existing":{"type":"boolean","example":true,"description":"If the entitlement already belonged to the user or not."},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Entitlement ID","example":"2c918085771e9d3301773b3cb66f6398"},"name":{"type":"string","description":"Entitlement name","example":"My HR Entitlement"}}}}}},"rightCriteria":{"type":"object","properties":{"criteriaList":{"type":"array","items":{"description":"Details of the Entitlement criteria","type":"object","properties":{"existing":{"type":"boolean","example":true,"description":"If the entitlement already belonged to the user or not."},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Entitlement ID","example":"2c918085771e9d3301773b3cb66f6398"},"name":{"type":"string","description":"Entitlement name","example":"My HR Entitlement"}}}}}}}}}}},"violatedPolicies":{"type":"array","description":"A list of the Policies that were violated","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Reference to the policy that was violated","example":[{"type":"SOD_POLICY","id":"69129440-422d-4a23-aadd-35c828d5bfda","name":"HR Policy"}]}}}}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/access-request-approvals/completed","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Completed Access Request Approvals List","description":{"content":"This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info.","type":"text/plain"},"url":{"path":["access-request-approvals","completed"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If present, the value returns only completed approvals for the specified identity.\n * ORG_ADMIN users can call this with any identity ID value.\n * ORG_ADMIN users can also fetch all the approvals in the org, when\nowner-id is not used.\n * Non-ORG_ADMIN users can only specify *me* or pass their own\nidentity ID value.","type":"text/plain"},"key":"owner-id","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**requestedFor.id**: *eq, in*\n\n**modified**: *gt, lt, ge, le*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created, modified**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Completed Access Request Approvals List' (list-completed-approvals)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Completed Access Request Approvals List + + + +This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. + +
    Query Parameters
    + +List of Completed Approvals. + +
    Schema array
      requester object
      + +The identity that requested the item. + +
      requestedFor object
      + +The identity for whom the item is requested for. + +
      reviewedBy object
      + +The identity who has reviewed the approval. + +
      owner object
      + +The owner or approver of the approval. + +
      requestedObject object
      + +The requested access item. + +
      requesterComment object
      + +The requester's comment. + +
      author object
      reviewerComment object
      author object
      previousReviewersComments object[]
      + +The history of the previous reviewers comments. + +
      author object
      forwardHistory object[]
      + +The history of approval forward action. + +
      sodViolationContext object
      + +The details of the SOD violations for the associated approval. + +
      violationCheckResult object
      + +The inner object representing the completed SOD Violation check + +
      message object
      + +If the request failed, includes any error message that was generated. + +
      clientMetadata object
      + +Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. + +
    • property name* string
      • violationContexts object[]
      policy object
      + +Reference to the Policy that is being violated. + +
      conflictingAccessCriteria object
      + +The object which contains the left and right hand side of the entitlements that got violated according to the policy. + +
      leftCriteria object
      criteriaList object[]
      rightCriteria object
      criteriaList object[]
      violatedPolicies object[]
      + +A list of the Policies that were violated + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-identity-access-review-items.api.mdx b/products/idn/api/v3/list-identity-access-review-items.api.mdx new file mode 100644 index 000000000..4f9d91a65 --- /dev/null +++ b/products/idn/api/v3/list-identity-access-review-items.api.mdx @@ -0,0 +1,123 @@ +--- +id: list-identity-access-review-items +sidebar_label: List of Access Review Items +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listIdentityAccessReviewItems","tags":["Certifications"],"description":"This API returns a list of access review items for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity campaign certification ID","example":"ef38f94347e94562b5bb8424a56397d8"},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","required":false,"name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**type / access.type**: *eq*\n\n**completed**: *eq, ne*\n\n**identitySummary.id**: *eq, in*\n\n**identitySummary.name**: *eq, sw*\n\n**access.id**: *eq, in*\n\n**access.name**: *eq, sw*\n\n**entitlement.sourceName**: *eq, sw*\n\n**accessProfile.sourceName**: *eq, sw*","example":"id eq \"ef38f94347e94562b5bb8424a56397d8\""},{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"example":"access.name,-accessProfile.sourceName","description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName**"},{"in":"query","name":"entitlements","required":false,"schema":{"type":"string"},"example":"identityEntitlement","description":"Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs.\n\nAn error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time."},{"in":"query","name":"access-profiles","required":false,"schema":{"type":"string"},"example":"accessProfile1","description":"Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs.\n\nAn error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time."},{"in":"query","name":"roles","required":false,"schema":{"type":"string"},"example":"userRole","description":"Filter results to view access review items that pertain to any of the specified comma-separated role IDs.\n\nAn error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time."}],"responses":{"200":{"description":"A list of access review items","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"accessSummary":{"type":"object","description":"An object holding the access that is being reviewed","properties":{"access":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"The ID of the item being certified","example":"2c9180867160846801719932c5153fb7"},"name":{"type":"string","description":"The name of the item being certified","example":"Entitlement for Company Database"}}},"entitlement":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"The id for the entitlement","example":"2c918085718230600171993742c63558"},"name":{"type":"string","description":"The name of the entitlement","example":"CN=entitlement.bbb7c650"},"description":{"nullable":true,"type":"string","description":"Information about the entitlement","example":"Gives read/write access to the company database"},"privileged":{"type":"boolean","example":false,"description":"Indicates if the entitlement is a privileged entitlement"},"owner":{"type":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"},"id":{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"},"name":{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"},"email":{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}},"attributeName":{"type":"string","description":"The name of the attribute on the source","example":"memberOf"},"attributeValue":{"type":"string","description":"The value of the attribute on the source","example":"CN=entitlement.bbb7c650"},"sourceSchemaObjectType":{"type":"string","description":"The schema object type on the source used to represent the entitlement and its attributes","example":"groups"},"sourceName":{"type":"string","description":"The name of the source for which this entitlement belongs","example":"ODS-AD-Source"},"sourceType":{"type":"string","description":"The type of the source for which the entitlement belongs","example":"Active Directory - Direct"},"hasPermissions":{"type":"boolean","description":"Indicates if the entitlement has permissions","example":false},"isPermission":{"type":"boolean","description":"Indicates if the entitlement is a representation of an account permission","example":false},"revocable":{"type":"boolean","description":"Indicates whether the entitlement can be revoked","example":true},"cloudGoverned":{"type":"boolean","description":"True if the entitlement is cloud governed","example":false},"account":{"type":"object","nullable":true,"description":"Information about the status of the entitlement","properties":{"nativeIdentity":{"type":"string","description":"The native identity for this account","example":"CN=Alison Ferguso"},"disabled":{"type":"boolean","example":false,"description":"Indicates whether this account is currently disabled"},"locked":{"type":"boolean","example":false,"description":"Indicates whether this account is currently locked"},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"nullable":true,"type":"string","description":"The id associated with the account","example":"2c9180857182305e0171993737eb29e6"},"name":{"nullable":true,"type":"string","description":"The account name","example":"Alison Ferguso"},"created":{"nullable":true,"type":"string","format":"date-time","description":"When the account was created","example":"2020-04-20T20:11:05.067Z"},"modified":{"nullable":true,"type":"string","format":"date-time","description":"When the account was last modified","example":"2020-05-20T18:57:16.987Z"}}}}},"accessProfile":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Access Profile","example":"2c91808a7190d06e01719938fcd20792"},"name":{"type":"string","description":"Name of the Access Profile","example":"Employee-database-read-write"},"description":{"type":"string","description":"Information about the Access Profile","example":"Collection of entitlements to read/write the employee database"},"privileged":{"type":"boolean","description":"Indicates if the entitlement is a privileged entitlement","example":false},"cloudGoverned":{"type":"boolean","description":"True if the entitlement is cloud governed","example":false},"endDate":{"nullable":true,"type":"string","format":"date-time","description":"The date at which a user's access expires","example":"2021-12-25T00:00:00.000Z"},"owner":{"type":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"},"id":{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"},"name":{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"},"email":{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}},"description":"Owner of the Access Profile"},"entitlements":{"type":"array","description":"A list of entitlements associated with this Access Profile","items":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"The id for the entitlement","example":"2c918085718230600171993742c63558"},"name":{"type":"string","description":"The name of the entitlement","example":"CN=entitlement.bbb7c650"},"description":{"nullable":true,"type":"string","description":"Information about the entitlement","example":"Gives read/write access to the company database"},"privileged":{"type":"boolean","example":false,"description":"Indicates if the entitlement is a privileged entitlement"},"owner":{"type":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"},"id":{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"},"name":{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"},"email":{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}},"attributeName":{"type":"string","description":"The name of the attribute on the source","example":"memberOf"},"attributeValue":{"type":"string","description":"The value of the attribute on the source","example":"CN=entitlement.bbb7c650"},"sourceSchemaObjectType":{"type":"string","description":"The schema object type on the source used to represent the entitlement and its attributes","example":"groups"},"sourceName":{"type":"string","description":"The name of the source for which this entitlement belongs","example":"ODS-AD-Source"},"sourceType":{"type":"string","description":"The type of the source for which the entitlement belongs","example":"Active Directory - Direct"},"hasPermissions":{"type":"boolean","description":"Indicates if the entitlement has permissions","example":false},"isPermission":{"type":"boolean","description":"Indicates if the entitlement is a representation of an account permission","example":false},"revocable":{"type":"boolean","description":"Indicates whether the entitlement can be revoked","example":true},"cloudGoverned":{"type":"boolean","description":"True if the entitlement is cloud governed","example":false},"account":{"type":"object","nullable":true,"description":"Information about the status of the entitlement","properties":{"nativeIdentity":{"type":"string","description":"The native identity for this account","example":"CN=Alison Ferguso"},"disabled":{"type":"boolean","example":false,"description":"Indicates whether this account is currently disabled"},"locked":{"type":"boolean","example":false,"description":"Indicates whether this account is currently locked"},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"nullable":true,"type":"string","description":"The id associated with the account","example":"2c9180857182305e0171993737eb29e6"},"name":{"nullable":true,"type":"string","description":"The account name","example":"Alison Ferguso"},"created":{"nullable":true,"type":"string","format":"date-time","description":"When the account was created","example":"2020-04-20T20:11:05.067Z"},"modified":{"nullable":true,"type":"string","format":"date-time","description":"When the account was last modified","example":"2020-05-20T18:57:16.987Z"}}}}}},"created":{"type":"string","description":"Date the Access Profile was created.","format":"date-time","example":"2021-01-01T22:32:58.104Z"},"modified":{"type":"string","description":"Date the Access Profile was last modified.","format":"date-time","example":"2021-02-01T22:32:58.104Z"}}},"role":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"The id for the Role","example":"2c91808a7190d06e0171993907fd0794"},"name":{"type":"string","description":"The name of the Role","example":"Accounting-Employees"},"description":{"type":"string","description":"Information about the Role","example":"Role for members of the accounting department with the necessary Access Profiles"},"privileged":{"type":"boolean","description":"Indicates if the entitlement is a privileged entitlement","example":false},"owner":{"type":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"},"id":{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"},"name":{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"},"email":{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}},"revocable":{"type":"boolean","description":"Indicates whether the Role can be revoked or requested","example":false},"endDate":{"type":"string","format":"date-time","description":"The date when a user's access expires.","example":"2021-12-25T00:00:00.000Z"},"accessProfiles":{"type":"array","description":"The list of Access Profiles associated with this Role","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Access Profile","example":"2c91808a7190d06e01719938fcd20792"},"name":{"type":"string","description":"Name of the Access Profile","example":"Employee-database-read-write"},"description":{"type":"string","description":"Information about the Access Profile","example":"Collection of entitlements to read/write the employee database"},"privileged":{"type":"boolean","description":"Indicates if the entitlement is a privileged entitlement","example":false},"cloudGoverned":{"type":"boolean","description":"True if the entitlement is cloud governed","example":false},"endDate":{"nullable":true,"type":"string","format":"date-time","description":"The date at which a user's access expires","example":"2021-12-25T00:00:00.000Z"},"owner":{"type":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"},"id":{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"},"name":{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"},"email":{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}},"description":"Owner of the Access Profile"},"entitlements":{"type":"array","description":"A list of entitlements associated with this Access Profile","items":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"The id for the entitlement","example":"2c918085718230600171993742c63558"},"name":{"type":"string","description":"The name of the entitlement","example":"CN=entitlement.bbb7c650"},"description":{"nullable":true,"type":"string","description":"Information about the entitlement","example":"Gives read/write access to the company database"},"privileged":{"type":"boolean","example":false,"description":"Indicates if the entitlement is a privileged entitlement"},"owner":{"type":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"},"id":{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"},"name":{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"},"email":{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}},"attributeName":{"type":"string","description":"The name of the attribute on the source","example":"memberOf"},"attributeValue":{"type":"string","description":"The value of the attribute on the source","example":"CN=entitlement.bbb7c650"},"sourceSchemaObjectType":{"type":"string","description":"The schema object type on the source used to represent the entitlement and its attributes","example":"groups"},"sourceName":{"type":"string","description":"The name of the source for which this entitlement belongs","example":"ODS-AD-Source"},"sourceType":{"type":"string","description":"The type of the source for which the entitlement belongs","example":"Active Directory - Direct"},"hasPermissions":{"type":"boolean","description":"Indicates if the entitlement has permissions","example":false},"isPermission":{"type":"boolean","description":"Indicates if the entitlement is a representation of an account permission","example":false},"revocable":{"type":"boolean","description":"Indicates whether the entitlement can be revoked","example":true},"cloudGoverned":{"type":"boolean","description":"True if the entitlement is cloud governed","example":false},"account":{"type":"object","nullable":true,"description":"Information about the status of the entitlement","properties":{"nativeIdentity":{"type":"string","description":"The native identity for this account","example":"CN=Alison Ferguso"},"disabled":{"type":"boolean","example":false,"description":"Indicates whether this account is currently disabled"},"locked":{"type":"boolean","example":false,"description":"Indicates whether this account is currently locked"},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"nullable":true,"type":"string","description":"The id associated with the account","example":"2c9180857182305e0171993737eb29e6"},"name":{"nullable":true,"type":"string","description":"The account name","example":"Alison Ferguso"},"created":{"nullable":true,"type":"string","format":"date-time","description":"When the account was created","example":"2020-04-20T20:11:05.067Z"},"modified":{"nullable":true,"type":"string","format":"date-time","description":"When the account was last modified","example":"2020-05-20T18:57:16.987Z"}}}}}},"created":{"type":"string","description":"Date the Access Profile was created.","format":"date-time","example":"2021-01-01T22:32:58.104Z"},"modified":{"type":"string","description":"Date the Access Profile was last modified.","format":"date-time","example":"2021-02-01T22:32:58.104Z"}}}}}}}},"identitySummary":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the identity summary","example":"2c91808772a504f50172a9540e501ba7"},"name":{"type":"string","description":"Name of the linked identity","example":"Alison Ferguso"},"identityId":{"type":"string","description":"The ID of the identity being certified","example":"2c9180857182306001719937377a33de"},"completed":{"type":"boolean","description":"Indicates whether the review items for the linked identity's certification have been completed","example":true}}},"id":{"type":"string","description":"The review item's id","example":"ef38f94347e94562b5bb8424a56397d8"},"completed":{"type":"boolean","description":"Whether the review item is complete","example":false},"newAccess":{"type":"boolean","description":"Indicates whether the review item is for new access to a source","example":false},"decision":{"type":"string","description":"The decision to approve or revoke the review item","enum":["APPROVE","REVOKE"],"example":"APPROVE"},"comments":{"nullable":true,"type":"string","description":"Comments for this review item","example":"This user still needs access to this source"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/certifications/{id}/access-review-items","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List of Access Review Items","description":{"content":"This API returns a list of access review items for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.","type":"text/plain"},"url":{"path":["certifications",":id","access-review-items"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**type / access.type**: *eq*\n\n**completed**: *eq, ne*\n\n**identitySummary.id**: *eq, in*\n\n**identitySummary.name**: *eq, sw*\n\n**access.id**: *eq, in*\n\n**access.name**: *eq, sw*\n\n**entitlement.sourceName**: *eq, sw*\n\n**accessProfile.sourceName**: *eq, sw*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName**","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs.\n\nAn error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time.","type":"text/plain"},"key":"entitlements","value":""},{"disabled":false,"description":{"content":"Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs.\n\nAn error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time.","type":"text/plain"},"key":"access-profiles","value":""},{"disabled":false,"description":{"content":"Filter results to view access review items that pertain to any of the specified comma-separated role IDs.\n\nAn error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time.","type":"text/plain"},"key":"roles","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identity campaign certification ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List of Access Review Items' (list-identity-access-review-items)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List of Access Review Items + + + +This API returns a list of access review items for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +
    Path Parameters
    Query Parameters
    + +A list of access review items + +
    Schema array
      accessSummary object
      + +An object holding the access that is being reviewed + +
      access object
      entitlement object
      owner object
      account object
      + +Information about the status of the entitlement + +
      accessProfile object
      owner object
      + +Owner of the Access Profile + +
      entitlements object[]
      + +A list of entitlements associated with this Access Profile + +
      owner object
      account object
      + +Information about the status of the entitlement + +
      role object
      owner object
      accessProfiles object[]
      + +The list of Access Profiles associated with this Role + +
      owner object
      + +Owner of the Access Profile + +
      entitlements object[]
      + +A list of entitlements associated with this Access Profile + +
      owner object
      account object
      + +Information about the status of the entitlement + +
      identitySummary object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-identity-certifications.api.mdx b/products/idn/api/v3/list-identity-certifications.api.mdx new file mode 100644 index 000000000..6ae40c0eb --- /dev/null +++ b/products/idn/api/v3/list-identity-certifications.api.mdx @@ -0,0 +1,75 @@ +--- +id: list-identity-certifications +sidebar_label: Identity Campaign Certifications by IDs +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listIdentityCertifications","tags":["Certifications"],"description":"This API returns a list of identity campaign certifications that satisfy the given query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to Governance Groups.","parameters":[{"in":"query","name":"reviewer-identity","schema":{"type":"string"},"example":"me","description":"The ID of reviewer identity. *me* indicates the current user.","required":false},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"example":"id eq \"ef38f94347e94562b5bb8424a56397d8\"","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n**id**: *eq, in*\n**campaign.id**: *eq, in*\n**phase**: *eq*\n**completed**: *eq, ne*"},{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"example":"name,due","description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\nSorting is supported for the following fields: **name, due, signed**"}],"responses":{"200":{"description":"List of identity campaign certifications","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"example":"2c9180835d2e5168015d32f890ca1581","type":"string","description":"id of the certification"},"name":{"example":"Source Owner Access Review for Employees [source]","type":"string","description":"name of the certification"},"campaign":{"type":"object","required":["id","name","type","campaignType","description","correlatedStatus","mandatoryCommentRequirement"],"properties":{"id":{"type":"string","description":"The unique ID of the campaign.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the campaign.","example":"Campaign Name"},"type":{"type":"string","enum":["CAMPAIGN"],"description":"The type of object that is being referenced.","example":"CAMPAIGN"},"campaignType":{"type":"string","enum":["MANAGER","SOURCE_OWNER","SEARCH"],"description":"The type of the campaign.","example":"MANAGER"},"description":{"type":"string","description":"The description of the campaign set by the admin who created it.","nullable":true,"example":"A description of the campaign"},"correlatedStatus":{"description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"},"mandatoryCommentRequirement":{"type":"string","description":"Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.","enum":["ALL_DECISIONS","REVOKE_ONLY_DECISIONS","NO_DECISIONS"],"example":"NO_DECISIONS"}}},"completed":{"type":"boolean","description":"Have all decisions been made?","example":true},"identitiesCompleted":{"type":"integer","description":"The number of identities for whom all decisions have been made and are complete.","example":5,"format":"int32"},"identitiesTotal":{"type":"integer","description":"The total number of identities in the Certification, both complete and incomplete.","example":10,"format":"int32"},"created":{"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"created date"},"modified":{"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"modified date"},"decisionsMade":{"type":"integer","description":"The number of approve/revoke/acknowledge decisions that have been made.","example":20,"format":"int32"},"decisionsTotal":{"type":"integer","description":"The total number of approve/revoke/acknowledge decisions.","example":40,"format":"int32"},"due":{"type":"string","format":"date-time","description":"The due date of the certification.","example":"2018-10-19T13:49:37.385Z"},"signed":{"type":"string","format":"date-time","nullable":true,"description":"The date the reviewer signed off on the Certification.","example":"2018-10-19T13:49:37.385Z"},"reviewer":{"type":"object","properties":{"id":{"type":"string","description":"The id of the reviewer.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the reviewer.","example":"Reviewer Name"},"email":{"type":"string","description":"The email of the reviewing identity.","example":"reviewer@test.com"},"type":{"type":"string","enum":["IDENTITY"],"description":"The type of the reviewing identity.","example":"IDENTITY"},"created":{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The created date of the reviewing identity."},"modified":{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The modified date of the reviewing identity."}}},"reassignment":{"type":"object","nullable":true,"properties":{"from":{"type":"object","properties":{"id":{"type":"string","description":"The id of the certification.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the certification.","example":"Certification Name"},"type":{"type":"string","enum":["CERTIFICATION"],"example":"CERTIFICATION"},"reviewer":{"type":"object","properties":{"id":{"type":"string","description":"The id of the reviewer.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the reviewer.","example":"Reviewer Name"},"email":{"type":"string","description":"The email of the reviewing identity.","example":"reviewer@test.com"},"type":{"type":"string","enum":["IDENTITY"],"description":"The type of the reviewing identity.","example":"IDENTITY"},"created":{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The created date of the reviewing identity."},"modified":{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The modified date of the reviewing identity."}}}}},"comment":{"type":"string","description":"The comment entered when the Certification was reassigned","example":"Reassigned for a reason"}}},"hasErrors":{"description":"Identifies if the certification has an error","type":"boolean","example":false},"errorMessage":{"description":"Description of the certification error","nullable":true,"type":"string","example":"The certification has an error"},"phase":{"type":"string","description":"The current phase of the campaign.\n* `STAGED`: The campaign is waiting to be activated.\n* `ACTIVE`: The campaign is active.\n* `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete.\n","enum":["STAGED","ACTIVE","SIGNED"],"example":"ACTIVE"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/certifications","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Identity Campaign Certifications by IDs","description":{"content":"This API returns a list of identity campaign certifications that satisfy the given query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to Governance Groups.","type":"text/plain"},"url":{"path":["certifications"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The ID of reviewer identity. *me* indicates the current user.","type":"text/plain"},"key":"reviewer-identity","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n**id**: *eq, in*\n**campaign.id**: *eq, in*\n**phase**: *eq*\n**completed**: *eq, ne*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\nSorting is supported for the following fields: **name, due, signed**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Identity Campaign Certifications by IDs' (list-identity-certifications)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Identity Campaign Certifications by IDs + + + +This API returns a list of identity campaign certifications that satisfy the given query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to Governance Groups. + +
    Query Parameters
    + +List of identity campaign certifications + +
    Schema array
      campaign object
      reviewer object
      reassignment object
      from object
      reviewer object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-identity-profiles.api.mdx b/products/idn/api/v3/list-identity-profiles.api.mdx new file mode 100644 index 000000000..ca474a470 --- /dev/null +++ b/products/idn/api/v3/list-identity-profiles.api.mdx @@ -0,0 +1,92 @@ +--- +id: list-identity-profiles +sidebar_label: Identity Profiles List +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listIdentityProfiles","tags":["Identity Profiles"],"description":"This returns a list of Identity Profiles based on the specified query parameters.\nA token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"example":"id eq \"ef38f94347e94562b5bb8424a56397d8\"","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, ne*\n\n**name**: *eq, ne*\n\n**priority**: *eq, ne*"},{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"example":"id,name","description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **id**, **name**, **priority**"}],"responses":{"200":{"description":"List of identityProfiles.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true},"modified":{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}},{"type":"object","required":["authoritativeSource"],"properties":{"description":{"type":"string","description":"The description of the Identity Profile.","example":"My custom flat file profile","nullable":true},"owner":{"type":"object","description":"The owner of the Identity Profile.","nullable":true,"properties":{"type":{"type":"string","enum":["IDENTITY"],"description":"Type of the object to which this reference applies","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"priority":{"type":"integer","format":"int64","description":"The priority for an Identity Profile.","example":10},"authoritativeSource":{"type":"object","properties":{"type":{"type":"string","enum":["SOURCE"],"description":"Type of the object to which this reference applies","example":"SOURCE"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"HR Active Directory"}}},"identityRefreshRequired":{"type":"boolean","default":false,"description":"True if a identity refresh is needed. Typically triggered when a change on the source has been made.","example":true},"identityCount":{"type":"integer","description":"The number of identities that belong to the Identity Profile.","format":"int32","example":8},"identityAttributeConfig":{"type":"object","description":"Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process.","properties":{"enabled":{"description":"The backend will only promote values if the profile/mapping is enabled.","type":"boolean","default":false,"example":true},"attributeTransforms":{"type":"array","items":{"type":"object","description":"Defines a transformation definition for an identity attribute.","properties":{"identityAttributeName":{"type":"string","description":"Name of the identity attribute.","example":"email"},"transformDefinition":{"description":"The seaspray transformation definition.","type":"object","properties":{"type":{"type":"string","description":"The type of the transform definition.","example":"accountAttribute"},"attributes":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"object"}]},"description":"Arbitrary key-value pairs to store any metadata for the object","example":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}}}}}}}}},"identityExceptionReportReference":{"type":"object","nullable":true,"properties":{"taskResultId":{"type":"string","format":"uuid","description":"The id of the task result.","example":"2b838de9-db9b-abcf-e646-d4f274ad4238"},"reportName":{"type":"string","example":"My annual report","description":"The name of the report."}}},"hasTimeBasedAttr":{"description":"Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile.","type":"boolean","default":false,"example":true}}}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:identity-profile:read"]}],"method":"get","path":"/identity-profiles","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Identity Profiles List","description":{"content":"This returns a list of Identity Profiles based on the specified query parameters.\nA token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles.","type":"text/plain"},"url":{"path":["identity-profiles"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, ne*\n\n**name**: *eq, ne*\n\n**priority**: *eq, ne*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **id**, **name**, **priority**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Identity Profiles List' (list-identity-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Identity Profiles List + + + +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. + +
    Query Parameters
    + +List of identityProfiles. + +
    Schema array
      owner object
      + +The owner of the Identity Profile. + +
      authoritativeSource object
      identityAttributeConfig object
      + +Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. + +
      attributeTransforms object[]
      transformDefinition object
      + +The seaspray transformation definition. + +
      attributes object
      + +Arbitrary key-value pairs to store any metadata for the object + +
      identityExceptionReportReference object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-lifecycle-states.api.mdx b/products/idn/api/v3/list-lifecycle-states.api.mdx new file mode 100644 index 000000000..57f04ec80 --- /dev/null +++ b/products/idn/api/v3/list-lifecycle-states.api.mdx @@ -0,0 +1,80 @@ +--- +id: list-lifecycle-states +sidebar_label: Lists LifecycleStates +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listLifecycleStates","tags":["Lifecycle States"],"description":"This end-point lists all the LifecycleStates associated with IdentityProfiles.\nA token with API, or ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:identity-profile-lifecycle-state:read"]}],"parameters":[{"in":"path","name":"identity-profile-id","description":"The IdentityProfile id","required":true,"schema":{"type":"string"},"example":"ef38f94347e94562b5bb8424a56397d8"},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"example":"created,modified","description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created, modified**"}],"responses":{"200":{"description":"List of LifecycleState objects","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true},"modified":{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}},{"type":"object","required":["technicalName"],"properties":{"enabled":{"type":"boolean","example":true,"description":"Whether the lifecycle state is enabled or disabled."},"technicalName":{"type":"string","example":"Technical Name","description":"The technical name for lifecycle state. This is for internal use."},"description":{"type":"string","example":"Lifecycle description","description":"Lifecycle state description."},"identityCount":{"type":"integer","format":"int32","example":42,"readOnly":true,"description":"Number of identities that have the lifecycle state."},"emailNotificationOption":{"type":"object","description":"This is used for representing email configuration for a lifecycle state","properties":{"notifyManagers":{"type":"boolean","example":true,"description":"If true, then the manager is notified of the lifecycle state change."},"notifyAllAdmins":{"type":"boolean","example":true,"description":"If true, then all the admins are notified of the lifecycle state change."},"notifySpecificUsers":{"type":"boolean","example":true,"description":"If true, then the users specified in \"emailAddressList\" below are notified of lifecycle state change."},"emailAddressList":{"type":"array","example":["test@test.com","test2@test.com"],"items":{"type":"string"},"description":"List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change."}}},"accountActions":{"type":"array","items":{"type":"object","description":"Object for specifying Actions to be performed on a specified list of sources' account.","properties":{"action":{"example":"ENABLE","type":"string","description":"Describes if action will be enabled or disabled","enum":["ENABLE","DISABLE"]},"sourceIds":{"type":"array","items":{"type":"string"},"uniqueItems":true,"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"],"description":"List of unique source IDs. The sources must have the ENABLE feature or flat file source. See \"/sources\" endpoint for source features."}}}},"accessProfileIds":{"type":"array","items":{"type":"string"},"uniqueItems":true,"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"],"description":"List of unique access-profile IDs that are associated with the lifecycle state."}}}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/identity-profiles/{identity-profile-id}/lifecycle-states","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Lists LifecycleStates","description":{"content":"This end-point lists all the LifecycleStates associated with IdentityProfiles.\nA token with API, or ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["identity-profiles",":identity-profile-id","lifecycle-states"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created, modified**","type":"text/plain"},"key":"sorters","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The IdentityProfile id","type":"text/plain"},"type":"any","value":"","key":"identity-profile-id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Lists LifecycleStates' (list-lifecycle-states)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Lists LifecycleStates + + + +This end-point lists all the LifecycleStates associated with IdentityProfiles. +A token with API, or ORG_ADMIN authority is required to call this API. + +
    Path Parameters
    Query Parameters
    + +List of LifecycleState objects + +
    Schema array
      emailNotificationOption object
      + +This is used for representing email configuration for a lifecycle state + +
      accountActions object[]
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-non-employee-approvals.api.mdx b/products/idn/api/v3/list-non-employee-approvals.api.mdx new file mode 100644 index 000000000..082fb9f7d --- /dev/null +++ b/products/idn/api/v3/list-non-employee-approvals.api.mdx @@ -0,0 +1,83 @@ +--- +id: list-non-employee-approvals +sidebar_label: Get List of Non-Employee Approval Requests +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listNonEmployeeApprovals","security":[{"oauth2":[]}],"tags":["Non-Employee Lifecycle Management"],"description":"This gets a list of non-employee approval requests.\nThere are two contextual uses for this endpoint:\n 1. The user has the role context of `idn:nesr:read`, in which case they\ncan list the approvals for any approver.\n 2. The user owns the requested approval.","parameters":[{"in":"query","name":"requested-for","schema":{"type":"string"},"description":"The identity for whom the request was made. *me* indicates the current user.","required":false,"example":"2c91808280430dfb0180431a59440460"},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* *Example:* approvalStatus eq \"PENDING\"","example":"approvalStatus eq \"Pending\"","required":false},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949) Sorting is supported for the following fields: **created, modified**","required":false,"example":"created"}],"responses":{"200":{"description":"List of approval items.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee approval item id","example":"2c1e388b-1e55-4b0a-ab5c-897f1204159c"},"approver":{"description":"Reference to the associated Identity","type":"object","properties":{"type":{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}},"accountName":{"type":"string","description":"Requested identity account name","example":"test.account"},"approvalStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status","example":"APPROVED"},"approvalOrder":{"type":"number","description":"Approval order","example":1,"format":"float"},"comment":{"type":"string","description":"comment of approver","example":"I approve"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}},{"type":"object","properties":{"nonEmployeeRequest":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee request id.","example":"ac110005-7156-1150-8171-5b292e3e0084"},"requester":{"type":"object","properties":{"type":{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}},"example":{"type":"IDENTITY","id":"2c9180866166b5b0016167c32ef31a66","name":"William Smith"}}}}}}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-approvals","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get List of Non-Employee Approval Requests","description":{"content":"This gets a list of non-employee approval requests.\nThere are two contextual uses for this endpoint:\n 1. The user has the role context of `idn:nesr:read`, in which case they\ncan list the approvals for any approver.\n 2. The user owns the requested approval.","type":"text/plain"},"url":{"path":["non-employee-approvals"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The identity for whom the request was made. *me* indicates the current user.","type":"text/plain"},"key":"requested-for","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* *Example:* approvalStatus eq \"PENDING\"","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949) Sorting is supported for the following fields: **created, modified**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get List of Non-Employee Approval Requests' (list-non-employee-approvals)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get List of Non-Employee Approval Requests + + + +This gets a list of non-employee approval requests. +There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they +can list the approvals for any approver. + 2. The user owns the requested approval. + +
    Query Parameters
    + +List of approval items. + +
    Schema array
      approver object
      + +Reference to the associated Identity + +
      nonEmployeeRequest object
      requester object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-non-employee-records.api.mdx b/products/idn/api/v3/list-non-employee-records.api.mdx new file mode 100644 index 000000000..138ab9c59 --- /dev/null +++ b/products/idn/api/v3/list-non-employee-records.api.mdx @@ -0,0 +1,81 @@ +--- +id: list-non-employee-records +sidebar_label: List Non-Employee Records +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listNonEmployeeRecords","security":[{"oauth2":[]}],"tags":["Non-Employee Lifecycle Management"],"description":"This gets a list of non-employee records. There are two contextual uses for this endpoint:\n 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees.\n 2. The user is an account manager, in which case they can get a list of the non-employees that they manage.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"example":"accountName,sourceId","description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified**"},{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"example":"sourceId eq \"2c91808568c529c60168cca6f90c1313\"","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407) Filtering is supported for the following fields and operators: **sourceId**: *eq* *Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\""}],"responses":{"200":{"description":"Non-Employee record objects","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee record id.","example":"ef38f94347e94562b5bb8424a56397d8"},"accountName":{"type":"string","description":"Requested identity account name.","example":"Abby.Smith"},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"sourceId":{"type":"string","description":"Non-Employee's source id.","example":"2c91808568c529c60168cca6f90c1313"},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee.","example":{"description":"Auditing"}},"startDate":{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2019-08-23T18:52:59.162Z"},"endDate":{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2020-08-23T18:52:59.162Z"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-records","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List Non-Employee Records","description":{"content":"This gets a list of non-employee records. There are two contextual uses for this endpoint:\n 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees.\n 2. The user is an account manager, in which case they can get a list of the non-employees that they manage.","type":"text/plain"},"url":{"path":["non-employee-records"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified**","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407) Filtering is supported for the following fields and operators: **sourceId**: *eq* *Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\"","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Non-Employee Records' (list-non-employee-records)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Non-Employee Records + + + +This gets a list of non-employee records. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. + 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. + +
    Query Parameters
    + +Non-Employee record objects + +
    Schema array
      data object
      + +Attribute blob/bag for a non-employee. + +
    • property name* string
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-non-employee-requests.api.mdx b/products/idn/api/v3/list-non-employee-requests.api.mdx new file mode 100644 index 000000000..f87cf1866 --- /dev/null +++ b/products/idn/api/v3/list-non-employee-requests.api.mdx @@ -0,0 +1,91 @@ +--- +id: list-non-employee-requests +sidebar_label: List Non-Employee Requests +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listNonEmployeeRequests","security":[{"oauth2":[]}],"tags":["Non-Employee Lifecycle Management"],"description":"This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter:\n 1. The user has the role context of `idn:nesr:read`, in which case he or\nshe may request a list non-employee requests assigned to a particular account manager by passing in that manager's id.\n 2. The current user is an account manager, in which case \"me\" should be\nprovided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"requested-for","required":true,"schema":{"type":"string"},"example":"e136567de87e4d029e60b3c3c55db56d","description":"The identity for whom the request was made. *me* indicates the current user."},{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"example":"created,approvalStatus","description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate**"},{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"example":"sourceId eq \"2c91808568c529c60168cca6f90c1313\"","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407) Filtering is supported for the following fields and operators: **sourceId**: *eq* *Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\""}],"responses":{"200":{"description":"List of non-employee request objects.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"},"sourceId":{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"},"description":{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}},{"type":"object","properties":{"accountName":{"type":"string","description":"Requested identity account name.","example":"william.smith"},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"nonEmployeeSource":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"},"sourceId":{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"},"description":{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee.","example":{"description":"Auditing"}},"approvalItems":{"description":"List of approval item for the request","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee approval item id","example":"2c1e388b-1e55-4b0a-ab5c-897f1204159c"},"approver":{"description":"Reference to the associated Identity","type":"object","properties":{"type":{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}},"accountName":{"type":"string","description":"Requested identity account name","example":"test.account"},"approvalStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status","example":"APPROVED"},"approvalOrder":{"type":"number","description":"Approval order","example":1,"format":"float"},"comment":{"type":"string","description":"comment of approver","example":"I approve"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}}},"approvalStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status","example":"APPROVED"},"comment":{"type":"string","description":"comment of requester","example":"approved"},"completionDate":{"type":"string","format":"date-time","description":"When the request was completely approved.","example":"2020-03-24T11:11:41.139-05:00"},"startDate":{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2020-03-24T00:00:00-05:00"},"endDate":{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2021-03-25T00:00:00-05:00"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2020-03-24T11:11:41.139-05:00"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2020-03-24T11:11:41.139-05:00"}}}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-requests","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List Non-Employee Requests","description":{"content":"This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter:\n 1. The user has the role context of `idn:nesr:read`, in which case he or\nshe may request a list non-employee requests assigned to a particular account manager by passing in that manager's id.\n 2. The current user is an account manager, in which case \"me\" should be\nprovided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages.","type":"text/plain"},"url":{"path":["non-employee-requests"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"(Required) The identity for whom the request was made. *me* indicates the current user.","type":"text/plain"},"key":"requested-for","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate**","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407) Filtering is supported for the following fields and operators: **sourceId**: *eq* *Example:* sourceId eq \"2c91808568c529c60168cca6f90c1313\"","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Non-Employee Requests' (list-non-employee-requests)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Non-Employee Requests + + + +This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a list non-employee requests assigned to a particular account manager by passing in that manager's id. + 2. The current user is an account manager, in which case "me" should be +provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. + +
    Query Parameters
    + +List of non-employee request objects. + +
    Schema array
      nonEmployeeSource object
      data object
      + +Attribute blob/bag for a non-employee. + +
    • property name* string
      • approvalItems object[]
      + +List of approval item for the request + +
      approver object
      + +Reference to the associated Identity + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-non-employee-sources.api.mdx b/products/idn/api/v3/list-non-employee-sources.api.mdx new file mode 100644 index 000000000..4c48cf4e2 --- /dev/null +++ b/products/idn/api/v3/list-non-employee-sources.api.mdx @@ -0,0 +1,87 @@ +--- +id: list-non-employee-sources +sidebar_label: List Non-Employee Sources +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listNonEmployeeSources","security":[{"oauth2":[]}],"tags":["Non-Employee Lifecycle Management"],"description":"This gets a list of non-employee sources. There are two contextual uses for the requested-for path parameter: \n 1. The user has the role context of `idn:nesr:read`, in which case he or\nshe may request a list sources assigned to a particular account manager by passing in that manager's id.\n 2. The current user is an account manager, in which case \"me\" should be\nprovided as the `requested-for` value. This will provide the user with a list of the sources that he or she owns.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"requested-for","required":true,"schema":{"type":"string"},"example":"me","description":"The identity for whom the request was made. *me* indicates the current user."},{"in":"query","name":"non-employee-count","required":false,"example":true,"schema":{"type":"boolean"},"description":"The flag to determine whether return a non-employee count associate with source."},{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"example":"name,created","description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949) Sorting is supported for the following fields: **name, created**"}],"responses":{"200":{"description":"List of non-employee sources objects.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"},"sourceId":{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"},"description":{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}},{"type":"object","properties":{"approvers":{"description":"List of approvers","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}}},"accountManagers":{"description":"List of account managers","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}}},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}}]},{"type":"object","properties":{"nonEmployeeCount":{"type":"integer","description":"Number of non-employee records associated with this source.","format":"int32","example":120}}}]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/non-employee-sources","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List Non-Employee Sources","description":{"content":"This gets a list of non-employee sources. There are two contextual uses for the requested-for path parameter: \n 1. The user has the role context of `idn:nesr:read`, in which case he or\nshe may request a list sources assigned to a particular account manager by passing in that manager's id.\n 2. The current user is an account manager, in which case \"me\" should be\nprovided as the `requested-for` value. This will provide the user with a list of the sources that he or she owns.","type":"text/plain"},"url":{"path":["non-employee-sources"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"(Required) The identity for whom the request was made. *me* indicates the current user.","type":"text/plain"},"key":"requested-for","value":""},{"disabled":false,"description":{"content":"The flag to determine whether return a non-employee count associate with source.","type":"text/plain"},"key":"non-employee-count","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949) Sorting is supported for the following fields: **name, created**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Non-Employee Sources' (list-non-employee-sources)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Non-Employee Sources + + + +This gets a list of non-employee sources. There are two contextual uses for the requested-for path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +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. + +
    Query Parameters
    + +List of non-employee sources objects. + +
    Schema array
      approvers object[]
      + +List of approvers + +
      accountManagers object[]
      + +List of account managers + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-oauth-clients.api.mdx b/products/idn/api/v3/list-oauth-clients.api.mdx new file mode 100644 index 000000000..ca93e8168 --- /dev/null +++ b/products/idn/api/v3/list-oauth-clients.api.mdx @@ -0,0 +1,75 @@ +--- +id: list-oauth-clients +sidebar_label: List OAuth Clients +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listOauthClients","security":[{"oauth2":["sp:oauth-client:manage"]}],"tags":["OAuth Clients"],"description":"This gets a list of OAuth clients.","parameters":[{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**lastUsed**: *le, isnull*","example":"lastUsed le 2023-02-05T10:59:27.214Z"}],"responses":{"200":{"description":"List of OAuth clients.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the OAuth client","example":"2c9180835d2e5168015d32f890ca1581"},"businessName":{"type":"string","nullable":true,"description":"The name of the business the API Client should belong to","example":"Acme-Solar"},"homepageUrl":{"type":"string","nullable":true,"description":"The homepage URL associated with the owner of the API Client","example":"http://localhost:12345"},"name":{"type":"string","description":"A human-readable name for the API Client","example":"Demo API Client"},"description":{"type":"string","nullable":true,"description":"A description of the API Client","example":"An API client used for the authorization_code, refresh_token, and client_credentials flows"},"accessTokenValiditySeconds":{"type":"integer","format":"int32","description":"The number of seconds an access token generated for this API Client is valid for","example":750},"refreshTokenValiditySeconds":{"type":"integer","format":"int32","description":"The number of seconds a refresh token generated for this API Client is valid for","example":86400},"redirectUris":{"type":"array","nullable":true,"items":{"type":"string"},"description":"A list of the approved redirect URIs used with the authorization_code flow","example":["http://localhost:12345"]},"grantTypes":{"type":"array","items":{"description":"OAuth2 Grant Type","type":"string","example":"CLIENT_CREDENTIALS","enum":["CLIENT_CREDENTIALS","AUTHORIZATION_CODE","REFRESH_TOKEN"]},"description":"A list of OAuth 2.0 grant types this API Client can be used with","example":["AUTHORIZATION_CODE","CLIENT_CREDENTIALS","REFRESH_TOKEN"]},"accessType":{"description":"The access type (online or offline) of this API Client","example":"OFFLINE","type":"string","enum":["ONLINE","OFFLINE"]},"type":{"description":"The type of the API Client (public or confidential)","example":"CONFIDENTIAL","type":"string","enum":["CONFIDENTIAL","PUBLIC"]},"internal":{"type":"boolean","description":"An indicator of whether the API Client can be used for requests internal to IDN","example":false},"enabled":{"type":"boolean","description":"An indicator of whether the API Client is enabled for use","example":true},"strongAuthSupported":{"type":"boolean","description":"An indicator of whether the API Client supports strong authentication","example":false},"claimsSupported":{"type":"boolean","description":"An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow","example":false},"created":{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when the API Client was created","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when the API Client was last updated","example":"2018-06-25T20:22:28.104Z"},"lastUsed":{"type":"string","nullable":true,"format":"date-time","description":"The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed.","example":"2017-07-11T18:45:37.098Z"},"scope":{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the API Client.","example":["demo:api-client-scope:first","demo:api-client-scope:second"]}},"required":["id","businessName","homepageUrl","name","description","accessTokenValiditySeconds","refreshTokenValiditySeconds","redirectUris","grantTypes","accessType","type","internal","enabled","strongAuthSupported","claimsSupported","created","modified","scope"]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/oauth-clients","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List OAuth Clients","description":{"content":"This gets a list of OAuth clients.","type":"text/plain"},"url":{"path":["oauth-clients"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**lastUsed**: *le, isnull*","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List OAuth Clients' (list-oauth-clients)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List OAuth Clients + + + +This gets a list of OAuth clients. + +
    Query Parameters
    + +List of OAuth clients. + +
    Schema array
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-pending-approvals.api.mdx b/products/idn/api/v3/list-pending-approvals.api.mdx new file mode 100644 index 000000000..08f41f53b --- /dev/null +++ b/products/idn/api/v3/list-pending-approvals.api.mdx @@ -0,0 +1,131 @@ +--- +id: list-pending-approvals +sidebar_label: Pending Access Request Approvals List +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listPendingApprovals","tags":["Access Request Approvals"],"description":"This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info.","parameters":[{"in":"query","name":"owner-id","schema":{"type":"string"},"description":"If present, the value returns only pending approvals for the specified identity.\n * ORG_ADMIN users can call this with any identity ID value.\n * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used.\n * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value.","example":"2c91808568c529c60168cca6f90c1313","required":false},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**requestedFor.id**: *eq, in*\n\n**modified**: *gt, lt, ge, le*","example":"id eq \"2c91808568c529c60168cca6f90c1313\""},{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created, modified**","example":"modified"}],"responses":{"200":{"description":"List of Pending Approvals.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The approval id.","example":"id12345"},"name":{"type":"string","description":"The name of the approval.","example":"aName"},"created":{"type":"string","format":"date-time","description":"When the approval was created.","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","description":"When the approval was modified last time.","example":"2018-07-25T20:22:28.104Z"},"requestCreated":{"type":"string","format":"date-time","description":"When the access-request was created.","example":"2017-07-11T18:45:35.098Z"},"requestType":{"type":"string","enum":["GRANT_ACCESS","REVOKE_ACCESS"],"description":"Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field.","example":"GRANT_ACCESS"},"requester":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The identity that requested the item."},"requestedFor":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The identity for whom the item is requested for."},"owner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The owner or approver of the approval."},"requestedObject":{"description":"The requested access item.","type":"object","properties":{"id":{"type":"string","description":"Id of the object.","example":"2c9180835d2e5168015d32f890ca1581"},"name":{"type":"string","description":"Name of the object.","example":"Applied Research Access"},"description":{"type":"string","description":"Description of the object.","example":"Access to research information, lab results, and schematics"},"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"Type of the object.","example":"ROLE"}}},"requesterComment":{"description":"The requester's comment.","type":"object","properties":{"comment":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat"},"author":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the author","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"}}},"created":{"type":"string","format":"date-time","description":"Date and time comment was created","example":"2017-07-11T18:45:37.098Z"}}},"previousReviewersComments":{"type":"array","items":{"type":"object","properties":{"comment":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat"},"author":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the author","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"}}},"created":{"type":"string","format":"date-time","description":"Date and time comment was created","example":"2017-07-11T18:45:37.098Z"}}},"description":"The history of the previous reviewers comments."},"forwardHistory":{"type":"array","items":{"type":"object","properties":{"oldApproverName":{"type":"string","description":"Display name of approver from whom the approval was forwarded.","example":"Frank Mir"},"newApproverName":{"type":"string","description":"Display name of approver to whom the approval was forwarded.","example":"Al Volta"},"comment":{"type":"string","nullable":true,"description":"Comment made while forwarding.","example":"Forwarding from Frank to Al"},"modified":{"type":"string","format":"date-time","description":"Time at which approval was forwarded.","example":"2019-08-23T18:52:57.398Z"},"forwarderName":{"type":"string","nullable":true,"description":"Display name of forwarder who forwarded the approval.","example":"William Wilson"},"reassignmentType":{"description":"The approval reassignment type. \n* MANUAL_REASSIGNMENT: An approval with this reassignment type has been specifically reassigned by the approval task's owner, from their queue to someone else's. \n* AUTOMATIC_REASSIGNMENT: An approval with this reassignment type has been automatically reassigned from another approver's queue, according to that approver's reassignment configuration. The approver's reassignment configuration may be set up to automatically reassign approval tasks for a defined (or possibly open-ended) period of time.\n* AUTO_ESCALATION: An approval with this reassignment type has been automatically reassigned from another approver's queue, according to the request's escalation configuration. For more information about escalation configuration, refer to [Setting Global Reminders and Escalation Policies](https://documentation.sailpoint.com/saas/help/requests/config_emails.html).\n* SELF_REVIEW_DELEGATION: An approval with this reassignment type has been automatically reassigned by the system to prevent self-review. This helps prevent situations like a requester being tasked with approving their own request. For more information about preventing self-review, refer to [Self-review Prevention](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html#self-review-prevention) and [Preventing Self-approval](https://documentation.sailpoint.com/saas/help/requests/config_ap_roles.html#preventing-self-approval).","example":"AUTOMATIC_REASSIGNMENT","type":"string","enum":["MANUAL_REASSIGNMENT","AUTOMATIC_REASSIGNMENT","AUTO_ESCALATION","SELF_REVIEW_DELEGATION"]}}},"description":"The history of approval forward action."},"commentRequiredWhenRejected":{"type":"boolean","description":"When true the rejector has to provide comments when rejecting","example":true},"actionInProcess":{"description":"Action that is performed on this approval, and system has not finished performing that action yet.","type":"string","enum":["APPROVED","REJECTED","FORWARDED"],"example":"APPROVED"},"removeDate":{"type":"string","description":"The date the role or access profile is no longer assigned to the specified identity.","format":"date-time","example":"2020-07-11T00:00:00Z"},"removeDateUpdateRequested":{"type":"boolean","description":"If true, then the request is to change the remove date or sunset date.","example":true},"currentRemoveDate":{"type":"string","description":"The remove date or sunset date that was assigned at the time of the request.","format":"date-time","example":"2020-07-11T00:00:00Z"},"sodViolationContext":{"description":"The details of the SOD violations for the associated approval.","type":"object","properties":{"state":{"type":"string","enum":["SUCCESS","ERROR"],"description":"The status of SOD violation check","example":"SUCCESS"},"uuid":{"description":"The id of the Violation check event","type":"string","example":"f73d16e9-a038-46c5-b217-1246e15fdbdd"},"violationCheckResult":{"description":"The inner object representing the completed SOD Violation check","type":"object","properties":{"message":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}},"description":"If the request failed, includes any error message that was generated.","example":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An error has occurred during the SOD violation check"}]},"clientMetadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check.","example":{"requestedAppName":"test-app","requestedAppId":"2c91808f7892918f0178b78da4a305a1"}},"violationContexts":{"type":"array","items":{"description":"The contextual information of the violated criteria","type":"object","properties":{"policy":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Reference to the Policy that is being violated."},"conflictingAccessCriteria":{"type":"object","description":"The object which contains the left and right hand side of the entitlements that got violated according to the policy.","properties":{"leftCriteria":{"type":"object","properties":{"criteriaList":{"type":"array","items":{"description":"Details of the Entitlement criteria","type":"object","properties":{"existing":{"type":"boolean","example":true,"description":"If the entitlement already belonged to the user or not."},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Entitlement ID","example":"2c918085771e9d3301773b3cb66f6398"},"name":{"type":"string","description":"Entitlement name","example":"My HR Entitlement"}}}}}},"rightCriteria":{"type":"object","properties":{"criteriaList":{"type":"array","items":{"description":"Details of the Entitlement criteria","type":"object","properties":{"existing":{"type":"boolean","example":true,"description":"If the entitlement already belonged to the user or not."},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Entitlement ID","example":"2c918085771e9d3301773b3cb66f6398"},"name":{"type":"string","description":"Entitlement name","example":"My HR Entitlement"}}}}}}}}}}},"violatedPolicies":{"type":"array","description":"A list of the Policies that were violated","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Reference to the policy that was violated","example":[{"type":"SOD_POLICY","id":"69129440-422d-4a23-aadd-35c828d5bfda","name":"HR Policy"}]}}}}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/access-request-approvals/pending","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Pending Access Request Approvals List","description":{"content":"This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info.","type":"text/plain"},"url":{"path":["access-request-approvals","pending"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If present, the value returns only pending approvals for the specified identity.\n * ORG_ADMIN users can call this with any identity ID value.\n * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used.\n * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value.","type":"text/plain"},"key":"owner-id","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**requestedFor.id**: *eq, in*\n\n**modified**: *gt, lt, ge, le*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created, modified**","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Pending Access Request Approvals List' (list-pending-approvals)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Pending Access Request Approvals List + + + +This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. + +
    Query Parameters
    + +List of Pending Approvals. + +
    Schema array
      requester object
      + +The identity that requested the item. + +
      requestedFor object
      + +The identity for whom the item is requested for. + +
      owner object
      + +The owner or approver of the approval. + +
      requestedObject object
      + +The requested access item. + +
      requesterComment object
      + +The requester's comment. + +
      author object
      previousReviewersComments object[]
      + +The history of the previous reviewers comments. + +
      author object
      forwardHistory object[]
      + +The history of approval forward action. + +
      sodViolationContext object
      + +The details of the SOD violations for the associated approval. + +
      violationCheckResult object
      + +The inner object representing the completed SOD Violation check + +
      message object
      + +If the request failed, includes any error message that was generated. + +
      clientMetadata object
      + +Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. + +
    • property name* string
      • violationContexts object[]
      policy object
      + +Reference to the Policy that is being violated. + +
      conflictingAccessCriteria object
      + +The object which contains the left and right hand side of the entitlements that got violated according to the policy. + +
      leftCriteria object
      criteriaList object[]
      rightCriteria object
      criteriaList object[]
      violatedPolicies object[]
      + +A list of the Policies that were violated + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-personal-access-tokens.api.mdx b/products/idn/api/v3/list-personal-access-tokens.api.mdx new file mode 100644 index 000000000..78d2058e7 --- /dev/null +++ b/products/idn/api/v3/list-personal-access-tokens.api.mdx @@ -0,0 +1,79 @@ +--- +id: list-personal-access-tokens +sidebar_label: List Personal Access Tokens +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listPersonalAccessTokens","security":[{"oauth2":["sp:my-personal-access-tokens:read","sp:my-personal-access-tokens:manage","sp:all-personal-access-tokens:read","sp:all-personal-access-tokens:manage"]}],"tags":["Personal Access Tokens"],"description":"This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right.","parameters":[{"in":"query","name":"owner-id","description":"The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read'\nIf an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. \nIf the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read'","required":false,"schema":{"type":"string","default":null,"example":"2c9180867b50d088017b554662fb281e"}},{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**lastUsed**: *le, isnull*","example":"lastUsed le 2023-02-05T10:59:27.214Z"}],"responses":{"200":{"description":"List of personal access tokens.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the personal access token (to be used as the username for Basic Auth).","example":"86f1dc6fe8f54414950454cbb11278fa"},"name":{"type":"string","description":"The name of the personal access token. Cannot be the same as other personal access tokens owned by a user.","example":"NodeJS Integration"},"scope":{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the personal access token.","example":["demo:personal-access-token-scope:first","demo:personal-access-token-scope:second"]},"owner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Details about the owner of the personal access token."},"created":{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when this personal access token was created.","example":"2017-07-11T18:45:37.098Z"},"lastUsed":{"type":"string","nullable":true,"format":"date-time","description":"The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed.","example":"2017-07-11T18:45:37.098Z"}},"required":["id","name","scope","owner","created"]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/personal-access-tokens","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List Personal Access Tokens","description":{"content":"This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right.","type":"text/plain"},"url":{"path":["personal-access-tokens"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read'\nIf an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. \nIf the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read'","type":"text/plain"},"key":"owner-id","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**lastUsed**: *le, isnull*","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Personal Access Tokens' (list-personal-access-tokens)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Personal Access Tokens + + + +This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. + +
    Query Parameters
    + +List of personal access tokens. + +
    Schema array
      owner object
      + +Details about the owner of the personal access token. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-provisioning-policies.api.mdx b/products/idn/api/v3/list-provisioning-policies.api.mdx new file mode 100644 index 000000000..4ab11ef42 --- /dev/null +++ b/products/idn/api/v3/list-provisioning-policies.api.mdx @@ -0,0 +1,88 @@ +--- +id: list-provisioning-policies +sidebar_label: Lists ProvisioningPolicies +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listProvisioningPolicies","tags":["Sources"],"description":"This end-point lists all the ProvisioningPolicies in IdentityNow.\nA token with API, or ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:provisioning-policy:read","idn:provisioning-policy:manage"]}],"parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source id","example":"2c9180835d191a86015d28455b4a2329"}],"responses":{"200":{"description":"List of ProvisioningPolicyDto objects","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"the provisioning policy name","example":"example provisioning policy for inactive identities"},"description":{"type":"string","description":"the description of the provisioning policy","example":"this provisioning policy creates access based on an identity going inactive"},"usageType":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"userName"},"transform":{"type":"object","description":"The transform to apply to the field","example":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"default":{}},"attributes":{"type":"object","description":"Attributes required for the transform","example":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"}},"isRequired":{"type":"boolean","readOnly":true,"description":"Flag indicating whether or not the attribute is required.","default":false,"example":false},"type":{"type":"string","description":"The type of the attribute.","example":"string"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","default":false,"example":false}}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sources/{sourceId}/provisioning-policies","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Lists ProvisioningPolicies","description":{"content":"This end-point lists all the ProvisioningPolicies in IdentityNow.\nA token with API, or ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":sourceId","provisioning-policies"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Lists ProvisioningPolicies' (list-provisioning-policies)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Lists ProvisioningPolicies + + + +This end-point lists all the ProvisioningPolicies in IdentityNow. +A token with API, or ORG_ADMIN authority is required to call this API. + +
    Path Parameters
    + +List of ProvisioningPolicyDto objects + +
    Schema array
      fields object[]
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-requestable-objects.api.mdx b/products/idn/api/v3/list-requestable-objects.api.mdx new file mode 100644 index 000000000..051a5e55a --- /dev/null +++ b/products/idn/api/v3/list-requestable-objects.api.mdx @@ -0,0 +1,76 @@ +--- +id: list-requestable-objects +sidebar_label: Requestable Objects List +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listRequestableObjects","tags":["Requestable Objects"],"description":"This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param.\nAny authenticated token can call this endpoint to see their requestable access items. A token with ORG_ADMIN authority is required to call this endpoint to return a list of all of the requestable access items for the org or for another identity.","parameters":[{"in":"query","name":"identity-id","required":false,"schema":{"type":"string"},"example":"e7eab60924f64aa284175b9fa3309599","description":"If present, the value returns only requestable objects for the specified identity.\n * Admin users can call this with any identity ID value.\n * Non-admin users can only specify *me* or pass their own identity ID value.\n * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result."},{"in":"query","name":"types","description":"Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"Enum represented the currently supported requestable object types. Additional values may be added in the future without notice.","example":"ACCESS_PROFILE"}},"example":"ROLE,ACCESS_PROFILE","explode":false},{"in":"query","name":"term","required":false,"schema":{"type":"string"},"example":"Finance Role","description":"It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored."},{"in":"query","name":"statuses","description":"Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["AVAILABLE","PENDING","ASSIGNED"],"description":"Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results.","example":"AVAILABLE"}},"explode":false,"example":["ASSIGNED","PENDING"]},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"example":"name sw \"bob\"","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n","required":false},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"required":false,"example":"name","description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**\n"}],"responses":{"200":{"description":"List of requestable objects","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the requestable object itself","example":"2c9180835d2e5168015d32f890ca1581"},"name":{"type":"string","description":"Human-readable display name of the requestable object","example":"Applied Research Access"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z","description":"The time when the requestable object was created"},"modified":{"nullable":true,"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"The time when the requestable object was last modified"},"description":{"type":"string","description":"Description of the requestable object.","example":"Access to research information, lab results, and schematics."},"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"Enum represented the currently supported requestable object types. Additional values may be added in the future without notice.","example":"ACCESS_PROFILE"},"requestStatus":{"type":"string","enum":["AVAILABLE","PENDING","ASSIGNED"],"description":"Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results.","example":"AVAILABLE"},"identityRequestId":{"type":"string","description":"If *requestStatus* is *PENDING*, indicates the id of the associated account activity.","nullable":true,"example":null},"ownerRef":{"type":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"},"id":{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"},"name":{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"},"email":{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}},"requestCommentsRequired":{"type":"boolean","description":"Whether the requester must provide comments when requesting the object.","example":false}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/requestable-objects","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Requestable Objects List","description":{"content":"This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param.\nAny authenticated token can call this endpoint to see their requestable access items. A token with ORG_ADMIN authority is required to call this endpoint to return a list of all of the requestable access items for the org or for another identity.","type":"text/plain"},"url":{"path":["requestable-objects"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If present, the value returns only requestable objects for the specified identity.\n * Admin users can call this with any identity ID value.\n * Non-admin users can only specify *me* or pass their own identity ID value.\n * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result.","type":"text/plain"},"key":"identity-id","value":""},{"disabled":false,"description":{"content":"Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice.","type":"text/plain"},"key":"types","value":""},{"disabled":false,"description":{"content":"It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored.","type":"text/plain"},"key":"term","value":""},{"disabled":false,"description":{"content":"Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice.","type":"text/plain"},"key":"statuses","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, in, sw*\n","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**\n","type":"text/plain"},"key":"sorters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Requestable Objects List' (list-requestable-objects)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Requestable Objects List + + + +This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param. +Any authenticated token can call this endpoint to see their requestable access items. A token with ORG_ADMIN authority is required to call this endpoint to return a list of all of the requestable access items for the org or for another identity. + +
    Query Parameters
    + +List of requestable objects + +
    Schema array
      ownerRef object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-roles.api.mdx b/products/idn/api/v3/list-roles.api.mdx new file mode 100644 index 000000000..11438e012 --- /dev/null +++ b/products/idn/api/v3/list-roles.api.mdx @@ -0,0 +1,133 @@ +--- +id: list-roles +sidebar_label: List Roles +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listRoles","tags":["Roles"],"description":"This API returns a list of Roles.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.","parameters":[{"in":"query","name":"for-subadmin","schema":{"type":"string"},"description":"If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.","example":"5168015d32f890ca15812c9180835d2e","required":false},{"in":"query","name":"limit","description":"Note that for this API the maximum value for limit is 50.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":50,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":50,"default":50}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"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:\n**id**: *eq, in* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*","example":"requestable eq false","required":false},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"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, modified**","example":"name,-modified","required":false},{"in":"query","name":"for-segment-ids","schema":{"type":"string","format":"comma-separated"},"description":"If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.","example":"0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d","required":false},{"in":"query","name":"include-unsegmented","schema":{"type":"boolean","default":true},"description":"Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.","example":false,"required":false}],"responses":{"200":{"description":"List of Roles","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"A Role","properties":{"id":{"type":"string","description":"The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.","example":"2c918086749d78830174a1a40e121518"},"name":{"type":"string","description":"The human-readable display name of the Role","maxLength":128,"example":"Role 2567"},"created":{"type":"string","description":"Date the Role was created","format":"date-time","example":"2021-03-01T22:32:58.104Z","readOnly":true},"modified":{"type":"string","description":"Date the Role was last modified.","format":"date-time","example":"2021-03-02T20:22:28.104Z","readOnly":true},"description":{"type":"string","nullable":true,"description":"A human-readable description of the Role","example":"Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor."},"owner":{"type":"object","nullable":true,"description":"The owner of this object.","properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"accessProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the Access Profile","example":"ff808081751e6e129f1518161919ecca"},"type":{"type":"string","description":"Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result.","enum":["ACCESS_PROFILE"],"example":"ACCESS_PROFILE"},"name":{"type":"string","description":"Human-readable display name of the Access Profile. This field is ignored on input.","example":"Access Profile 2567"}}},"nullable":true},"membership":{"nullable":true,"type":"object","description":"When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.","properties":{"type":{"type":"string","enum":["STANDARD","IDENTITY_LIST"],"description":"This enum characterizes the type of a Role's membership selector. Only the following two are fully supported:\n\nSTANDARD: Indicates that Role membership is defined in terms of a criteria expression\n\nIDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed","example":"IDENTITY_LIST"},"criteria":{"nullable":true,"type":"object","description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","nullable":true,"description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","nullable":true,"description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","nullable":true,"description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa."}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa."}}},"identities":{"type":"array","items":{"type":"object","description":"A reference to an Identity in an IDENTITY_LIST role membership criteria.","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY","nullable":true},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","nullable":true,"description":"Human-readable display name of the Identity.","example":"Thomas Edison"},"aliasName":{"type":"string","nullable":true,"description":"User name of the Identity","example":"t.edison"}}},"nullable":true,"description":"Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST."}}},"legacyMembershipInfo":{"type":"object","nullable":true,"description":"This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.","example":{"type":"IDENTITY_LIST"},"additionalProperties":true},"enabled":{"type":"boolean","description":"Whether the Role is enabled or not.","example":true,"default":false},"requestable":{"type":"boolean","description":"Whether the Role can be the target of access requests.","example":true,"default":false},"accessRequestConfig":{"nullable":true,"description":"Access request configuration for this object","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":true,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":true,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n\n**OWNER**: Owner of the associated Role\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"revocationRequestConfig":{"nullable":true,"default":null,"description":"Revocation request configuration for this object.","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":false,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":false,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the revocation request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"segments":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of IDs of segments, if any, to which this Role is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]}},"required":["name","owner"]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:role-unchecked:read","idn:role-unchecked:manage","idn:role-checked:manage","idn:role-checked:read"]}],"method":"get","path":"/roles","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List Roles","description":{"content":"This API returns a list of Roles.\n\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["roles"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.","type":"text/plain"},"key":"for-subadmin","value":""},{"disabled":false,"description":{"content":"Note that for this API the maximum value for limit is 50.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"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:\n**id**: *eq, in* **name**: *eq, sw* **created, modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"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, modified**","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.","type":"text/plain"},"key":"for-segment-ids","value":""},{"disabled":false,"description":{"content":"Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.","type":"text/plain"},"key":"include-unsegmented","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Roles' (list-roles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Roles + + + +This API returns a list of Roles. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + +
    Query Parameters
    + +List of Roles + +
    Schema array
      owner object
      + +The owner of this object. + +
      accessProfiles object[]
      membership object
      + +When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities. + +
      criteria object
      + +Defines STANDARD type Role membership + +
      key object
      + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
      children object[]
      + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + +
      key object
      + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
      children object[]
      + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + +
      key object
      + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
      identities object[]
      + +Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. + +
      legacyMembershipInfo object
      + +This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. + +
      accessRequestConfig object
      + +Access request configuration for this object + +
      approvalSchemes object[]
      + +List describing the steps in approving the request + +
      revocationRequestConfig object
      + +Revocation request configuration for this object. + +
      approvalSchemes object[]
      + +List describing the steps in approving the revocation request + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-saved-searches.api.mdx b/products/idn/api/v3/list-saved-searches.api.mdx new file mode 100644 index 000000000..d961e25c4 --- /dev/null +++ b/products/idn/api/v3/list-saved-searches.api.mdx @@ -0,0 +1,88 @@ +--- +id: list-saved-searches +sidebar_label: Return a list of Saved Searches +hide_title: true +hide_table_of_contents: true +api: {"tags":["Saved Search"],"description":"Returns a list of saved searches.\n","operationId":"listSavedSearches","parameters":[{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"name":"filters","in":"query","schema":{"type":"string"},"description":"An expression used to constrain the result set using the filtering syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results).\n\nAllowed filter properties: *owner.id*, *public*\n\nAllowed filter operator: *eq*\n\n**Example filters**:\n\n```owner.id eq \"0de46054-fe90-434a-b84e-c6b3359d0c64\"``` -- returns saved searches for the specified owner ID\n\n```public eq true``` -- returns all public saved searches\n\n```owner.id eq me or public eq true``` -- returns all of the current user's saved searches as well as all public saved searches belonging to other users in the current org\n","example":"public eq true"}],"responses":{"200":{"description":"The list of requested saved searches.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","allOf":[{"type":"object","properties":{"id":{"description":"The saved search ID.\n","type":"string","example":"0de46054-fe90-434a-b84e-c6b3359d0c64"},"owner":{"description":"The owner of the saved search.\n","type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"description":"The id of the object.\n","type":"string","example":"2c91808568c529c60168cca6f90c1313"}},"required":["type","id"]}}},{"type":"object","properties":{"name":{"description":"The name of the saved search.\n","type":"string","example":"Disabled accounts"},"description":{"description":"The description of the saved search.\n","type":"string","nullable":true,"example":"Disabled accounts"}}},{"type":"object","properties":{"public":{"description":"Indicates if the saved search is public.\n","type":"boolean","default":false,"example":false},"created":{"description":"The date the saved search was initially created.\n","type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"},"modified":{"description":"The last date the saved search was modified.\n","type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"},"indices":{"description":"The names of the Elasticsearch indices in which to search.\n","type":"array","items":{"description":"Enum representing the currently supported indices.\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofiles","accountactivities","entitlements","events","identities","roles","*"],"example":"identities"},"example":["identities"]},"columns":{"description":"The columns to be returned (specifies the order in which they will be presented) for each document type.\n\nThe currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_.\n","type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"field":{"description":"The name of the field.\n","type":"string","example":"email"},"header":{"description":"The value of the header.\n","type":"string","example":"Work Email"}},"required":["field"]}},"example":{"identity":[{"field":"displayName","header":"Display Name"},{"field":"e-mail","header":"Work Email"}]}},"query":{"description":"The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL.\n","type":"string","example":"@accounts(disabled:true)"},"fields":{"description":"The fields to be searched against in a multi-field query.\n","type":"array","nullable":true,"items":{"type":"string"},"example":["disabled"]},"sort":{"description":"The fields to be used to sort the search results.\n","type":"array","items":{"type":"string"},"example":["displayName"]},"filters":{"nullable":true,"allOf":[{"type":"object","description":"The filters to be applied for each filtered field name.","example":{"attributes.cloudAuthoritativeSource":{"type":"EXISTS","exclude":true},"accessCount":{"type":"RANGE","range":{"lower":{"value":"3"}}},"created":{"type":"RANGE","range":{"lower":{"value":"2019-12-01","inclusive":true},"upper":{"value":"2020-01-01"}}},"source.name":{"type":"TERMS","terms":["HR Employees","Corporate Active Directory"],"exclude":true},"protected":{"type":"TERMS","terms":["true"]}}},{"type":"object","properties":{"type":{"description":"Enum representing the currently supported filter types.\nAdditional values may be added in the future without notice.","type":"string","enum":["EXISTS","RANGE","TERMS"],"example":"RANGE"},"range":{"type":"object","description":"The range of values to be filtered.","properties":{"lower":{"description":"The lower bound of the range.","type":"object","required":["value"],"properties":{"value":{"description":"The value of the range's endpoint.","type":"string","example":"1"},"inclusive":{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}},"upper":{"description":"The upper bound of the range.","type":"object","required":["value"],"properties":{"value":{"description":"The value of the range's endpoint.","type":"string","example":"1"},"inclusive":{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}}}},"terms":{"description":"The terms to be filtered.","type":"array","items":{"type":"string","example":"account_count"}},"exclude":{"description":"Indicates if the filter excludes results.","type":"boolean","default":false,"example":false}}}]}},"required":["indices","query"]}]}}}},"headers":{"X-Total-Count":{"description":"The total result count (returned only if the *count* parameter is specified as *true*).","schema":{"type":"integer"},"example":5}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}}},"method":"get","path":"/saved-searches","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Return a list of Saved Searches","description":{"content":"Returns a list of saved searches.\n","type":"text/plain"},"url":{"path":["saved-searches"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"An expression used to constrain the result set using the filtering syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results).\n\nAllowed filter properties: *owner.id*, *public*\n\nAllowed filter operator: *eq*\n\n**Example filters**:\n\n```owner.id eq \"0de46054-fe90-434a-b84e-c6b3359d0c64\"``` -- returns saved searches for the specified owner ID\n\n```public eq true``` -- returns all public saved searches\n\n```owner.id eq me or public eq true``` -- returns all of the current user's saved searches as well as all public saved searches belonging to other users in the current org\n","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Return a list of Saved Searches' (list-saved-searches)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Return a list of Saved Searches + + + +Returns a list of saved searches. + + +
    Query Parameters
    + +The list of requested saved searches. + +
    Response Headers
    • X-Total-Count integer
      Example: 5 + +The total result count (returned only if the *count* parameter is specified as *true*). + +
    Schema array
      owner object
      + +The owner of the saved search. + + +
      columns object
      + +The columns to be returned (specifies the order in which they will be presented) for each document type. + +The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. + + +
      items object
      filters object
      + +The filters to be applied for each filtered field name. + +
      range object
      + +The range of values to be filtered. + +
      lower object
      + +The lower bound of the range. + +
      upper object
      + +The upper bound of the range. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-scheduled-search.api.mdx b/products/idn/api/v3/list-scheduled-search.api.mdx new file mode 100644 index 000000000..d8589d909 --- /dev/null +++ b/products/idn/api/v3/list-scheduled-search.api.mdx @@ -0,0 +1,117 @@ +--- +id: list-scheduled-search +sidebar_label: List scheduled searches +hide_title: true +hide_table_of_contents: true +api: {"tags":["Scheduled Search"],"description":"Returns a list of scheduled searches.\n","operationId":"listScheduledSearch","parameters":[{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"name":"filters","in":"query","schema":{"type":"string"},"description":"An expression used to constrain the result set using the filtering syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results).\n\nAllowed filter properties: *owner.id*, *savedSearchId*\n\nAllowed filter operator: *eq*\n\n**Example filters**:\n\n```owner.id eq \"0de46054-fe90-434a-b84e-c6b3359d0c64\"``` -- returns scheduled searches for the specified owner ID\n\n```savedSearchId eq \"6cc0945d-9eeb-4948-9033-72d066e1153e\"``` -- returns scheduled searches that reference the specified saved search\n\n```owner.id eq me or savedSearchId eq \"6cc0945d-9eeb-4948-9033-72d066e1153e\"``` -- returns all of the current user's scheduled searches as well as all scheduled searches that reference the specified saved search\n","example":"savedSearchId eq \"6cc0945d-9eeb-4948-9033-72d066e1153e\""}],"responses":{"200":{"description":"The list of requested scheduled searches.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","allOf":[{"type":"object","properties":{"id":{"description":"The scheduled search ID.","type":"string","example":"0de46054-fe90-434a-b84e-c6b3359d0c64","readOnly":true},"owner":{"description":"The owner of the scheduled search","readOnly":true,"type":"object","properties":{"type":{"type":"string","description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"The ID of the referenced object","example":"2c9180867624cbd7017642d8c8c81f67"}},"required":["type","id"]},"ownerId":{"description":"The ID of the scheduled search owner.\n\nPlease use the `id` in the `owner` object instead.\n","type":"string","example":"2c9180867624cbd7017642d8c8c81f67","readOnly":true,"deprecated":true}}},{"type":"object","properties":{"name":{"description":"The name of the scheduled search.\n","type":"string","example":"Daily disabled accounts","nullable":true},"description":{"description":"The description of the scheduled search.\n","type":"string","nullable":true,"example":"Daily disabled accounts"}}},{"type":"object","properties":{"savedSearchId":{"description":"The ID of the saved search that will be executed.","type":"string","example":"554f1511-f0a1-4744-ab14-599514d3e57c"},"created":{"allOf":[{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}],"description":"The date the scheduled search was initially created.","readOnly":true},"modified":{"allOf":[{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}],"description":"The last date the scheduled search was modified.","readOnly":true},"schedule":{"type":"object","description":"The schedule information.","properties":{"type":{"description":"Enum representing the currently supported schedule types.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["DAILY","WEEKLY","MONTHLY","CALENDAR"],"example":"WEEKLY"},"days":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The days to execute the search.\n\nIf `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`.\n\nIf `type` is `MONTHLY`, the values will be a number in double quotes, like `\"1\"`, `\"10\"`, or `\"28\"`. Optionally, the value `\"L\"` can be used to refer to the last day of the month.\n","example":{"type":"LIST","values":["MON","WED","FRI"]},"nullable":true}]},"hours":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The hours selected.","example":{"type":"RANGE","values":["9","18"],"interval":3}}]},"expiration":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"timeZoneId":{"description":"The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org's default timezone is used.","nullable":true,"type":"string","example":"GMT-06:00"}},"required":["type","hours"]},"recipients":{"description":"A list of identities that should receive the scheduled search report via email.","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"The ID of the referenced object","example":"2c9180867624cbd7017642d8c8c81f67"}},"required":["type","id"]}},"enabled":{"description":"Indicates if the scheduled search is enabled.\n","type":"boolean","default":false,"example":false},"emailEmptyResults":{"description":"Indicates if email generation should not be suppressed if search returns no results.\n","type":"boolean","default":false,"example":false},"displayQueryDetails":{"description":"Indicates if the generated email should include the query and search results preview (which could include PII).\n","type":"boolean","default":false,"example":false}},"required":["savedSearchId","schedule","recipients"]}],"required":["id","owner","ownerId"]}}}},"headers":{"X-Total-Count":{"description":"The total result count (returned only if the *count* parameter is specified as *true*).","schema":{"type":"integer"},"example":5}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/scheduled-searches","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List scheduled searches","description":{"content":"Returns a list of scheduled searches.\n","type":"text/plain"},"url":{"path":["scheduled-searches"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"An expression used to constrain the result set using the filtering syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results).\n\nAllowed filter properties: *owner.id*, *savedSearchId*\n\nAllowed filter operator: *eq*\n\n**Example filters**:\n\n```owner.id eq \"0de46054-fe90-434a-b84e-c6b3359d0c64\"``` -- returns scheduled searches for the specified owner ID\n\n```savedSearchId eq \"6cc0945d-9eeb-4948-9033-72d066e1153e\"``` -- returns scheduled searches that reference the specified saved search\n\n```owner.id eq me or savedSearchId eq \"6cc0945d-9eeb-4948-9033-72d066e1153e\"``` -- returns all of the current user's scheduled searches as well as all scheduled searches that reference the specified saved search\n","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List scheduled searches' (list-scheduled-search)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List scheduled searches + + + +Returns a list of scheduled searches. + + +
    Query Parameters
    + +The list of requested scheduled searches. + +
    Response Headers
    • X-Total-Count integer
      Example: 5 + +The total result count (returned only if the *count* parameter is specified as *true*). + +
    Schema array
      owner object
      + +The owner of the scheduled search + +
      schedule object
      + +The schedule information. + +
      days object
      + +The days to execute the search. + +If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. + +If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. + + +
      hours object
      + +The hours selected. + +
      recipients object[]
      + +A list of identities that should receive the scheduled search report via email. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-segments.api.mdx b/products/idn/api/v3/list-segments.api.mdx new file mode 100644 index 000000000..0b2ffe454 --- /dev/null +++ b/products/idn/api/v3/list-segments.api.mdx @@ -0,0 +1,84 @@ +--- +id: list-segments +sidebar_label: List Segments +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listSegments","security":[{"oauth2":["idn:segment:read","idn:segment:manage"]}],"tags":["Segments"],"description":"This API returns a list of all segments.\nA token with ORG_ADMIN or API authority is required to call this API.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"List of all Segments","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Segment.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"name":{"type":"string","description":"Segment Business Name","example":"segment-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this Segment is created","example":"2020-01-01T00:00:00.000000Z"},"modified":{"type":"string","format":"date-time","description":"The time when this Segment is modified","example":"2020-01-01T00:00:00.000000Z"},"description":{"type":"string","description":"Optional description of the Segment","example":"This segment represents xyz"},"owner":{"type":"object","nullable":true,"description":"The owner of this object.","properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"visibilityCriteria":{"type":"object","properties":{"expression":{"type":"object","properties":{"operator":{"type":"string","description":"Operator for the expression","enum":["AND","EQUALS"],"example":"EQUALS"},"attribute":{"type":"string","description":"Name for the attribute","example":"location"},"value":{"type":"object","properties":{"type":{"type":"string","description":"The type of attribute value","example":"STRING"},"value":{"type":"string","description":"The attribute value","example":"Austin"}}},"children":{"type":"array","nullable":true,"description":"List of expressions","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of attribute value","example":"STRING"},"value":{"type":"string","description":"The attribute value","example":"Austin"}}},"example":[]}}}}},"active":{"type":"boolean","description":"Whether the Segment is currently active. Inactive segments have no effect.","default":false,"example":true}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/segments","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List Segments","description":{"content":"This API returns a list of all segments.\nA token with ORG_ADMIN or API authority is required to call this API.","type":"text/plain"},"url":{"path":["segments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Segments' (list-segments)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Segments + + + +This API returns a list of all segments. +A token with ORG_ADMIN or API authority is required to call this API. + +
    Query Parameters
    + +List of all Segments + +
    Schema array
      owner object
      + +The owner of this object. + +
      visibilityCriteria object
      expression object
      value object
      children object[]
      + +List of expressions + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-sod-policies.api.mdx b/products/idn/api/v3/list-sod-policies.api.mdx new file mode 100644 index 000000000..ade97684d --- /dev/null +++ b/products/idn/api/v3/list-sod-policies.api.mdx @@ -0,0 +1,92 @@ +--- +id: list-sod-policies +sidebar_label: List SOD policies +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:sod-policy:read"]}],"operationId":"listSodPolicies","tags":["SOD Policy"],"description":"This gets list of all SOD policies.\nRequires role of ORG_ADMIN","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq*\n\n**name**: *eq*\n\n**state**: *eq*","example":"id eq \"bc693f07e7b645539626c25954c58554\"","required":false}],"responses":{"200":{"description":"List of all SOD policies.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy id","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"name":{"type":"string","description":"Policy Business Name","example":"policy-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this SOD policy is created.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"modified":{"type":"string","format":"date-time","description":"The time when this SOD policy is modified.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"description":{"type":"string","description":"Optional description of the SOD policy","example":"This policy ensures compliance of xyz","nullable":true},"ownerRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"externalPolicyReference":{"type":"string","description":"Optional External Policy Reference","example":"XYZ policy","nullable":true},"policyQuery":{"type":"string","description":"Search query of the SOD policy","example":"@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)"},"compensatingControls":{"type":"string","description":"Optional compensating controls(Mitigating Controls)","example":"Have a manager review the transaction decisions for their \"out of compliance\" employee","nullable":true},"correctionAdvice":{"type":"string","description":"Optional correction advice","example":"Based on the role of the employee, managers should remove access that is not required for their job function.","nullable":true},"state":{"type":"string","description":"whether the policy is enforced or not","enum":["ENFORCED","NOT_ENFORCED"],"example":"ENFORCED"},"tags":{"type":"array","description":"tags for this policy object","example":["TAG1","TAG2"],"items":{"type":"string"}},"creatorId":{"type":"string","description":"Policy's creator ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"modifierId":{"type":"string","description":"Policy's modifier ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","nullable":true,"readOnly":true},"violationOwnerAssignmentConfig":{"nullable":true,"type":"object","properties":{"assignmentRule":{"type":"string","enum":["MANAGER","STATIC",null],"description":"Details about the violations owner.\nMANAGER - identity's manager\nSTATIC - Governance Group or Identity","example":"MANAGER","nullable":true},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"nullable":true}]}}},"scheduled":{"type":"boolean","description":"defines whether a policy has been scheduled or not","example":true,"default":false},"type":{"type":"string","description":"whether a policy is query based or conflicting access based","default":"GENERAL","enum":["GENERAL","CONFLICTING_ACCESS_BASED"],"example":"GENERAL"},"conflictingAccessCriteria":{"allOf":[{"type":"object","properties":{"leftCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","minItems":1,"maxItems":50,"items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"Type of the propery to which this reference applies to","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}},"rightCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","minItems":1,"maxItems":50,"items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"Type of the propery to which this reference applies to","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}}}},{"nullable":true}]}}}},"example":[{"id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"Conflicting-Policy-Name","created":"2020-01-01T00:00:00.000000Z","modified":"2020-01-01T00:00:00.000000Z","description":"This policy ensures compliance of xyz","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Owner Name"},"externalPolicyReference":"XYZ policy","policyQuery":"@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)","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":["string"],"creatorId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","modifierId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","violationOwnerAssignmentConfig":{"assignmentRule":"MANAGER","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Violation Owner Name"}},"scheduled":true,"type":"CONFLICTING_ACCESS_BASED","conflictingAccessCriteria":{"leftCriteria":{"name":"money-in","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67"}]},"rightCriteria":{"name":"money-out","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a68"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a69"}]}}},{"description":"Description","ownerRef":{"type":"IDENTITY","id":"2c918087682f9a86016839c05e8f1aff","name":"Owner Name"},"externalPolicyReference":"New policy","policyQuery":"policy query implementation","compensatingControls":"Compensating controls","correctionAdvice":"Correction advice","tags":[],"state":"ENFORCED","scheduled":false,"creatorId":"2c918087682f9a86016839c05e8f1aff","modifierId":null,"violationOwnerAssignmentConfig":null,"type":"GENERAL","conflictingAccessCriteria":null,"id":"52c11db4-733e-4c31-949a-766c95ec95f1","name":"General-Policy-Name","created":"2020-05-12T19:47:38Z","modified":"2020-05-12T19:47:38Z"}]}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sod-policies","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List SOD policies","description":{"content":"This gets list of all SOD policies.\nRequires role of ORG_ADMIN","type":"text/plain"},"url":{"path":["sod-policies"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq*\n\n**name**: *eq*\n\n**state**: *eq*","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List SOD policies' (list-sod-policies)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List SOD policies + + + +This gets list of all SOD policies. +Requires role of ORG_ADMIN + +
    Query Parameters
    + +List of all SOD policies. + +
    Schema array
      ownerRef object
      violationOwnerAssignmentConfig object
      ownerRef object
      conflictingAccessCriteria object
      leftCriteria object
      criteriaList object[]
      + +**Possible values:** `>= 1`, `<= 50` + +
      + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
      rightCriteria object
      criteriaList object[]
      + +**Possible values:** `>= 1`, `<= 50` + +
      + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-source-schemas.api.mdx b/products/idn/api/v3/list-source-schemas.api.mdx new file mode 100644 index 000000000..910a9660f --- /dev/null +++ b/products/idn/api/v3/list-source-schemas.api.mdx @@ -0,0 +1,96 @@ +--- +id: list-source-schemas +sidebar_label: List Schemas on a Source +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listSourceSchemas","tags":["Sources"],"description":"Lists the Schemas that exist on the specified Source in IdentityNow.\n","parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source ID.","example":"2c9180835d191a86015d28455b4a2329"},{"in":"query","name":"include-types","required":false,"schema":{"type":"string"},"description":"If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized.","example":"group"}],"responses":{"200":{"description":"The Schemas were successfully retrieved.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Schema.","example":"2c9180835d191a86015d28455b4a2329"},"name":{"type":"string","description":"The name of the Schema.","example":"account"},"nativeObjectType":{"type":"string","description":"The name of the object type on the native system that the schema represents.","example":"User"},"identityAttribute":{"type":"string","description":"The name of the attribute used to calculate the unique identifier for an object in the schema.","example":"sAMAccountName"},"displayAttribute":{"type":"string","description":"The name of the attribute used to calculate the display value for an object in the schema.","example":"distinguishedName"},"hierarchyAttribute":{"type":"string","description":"The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.","example":"memberOf"},"includePermissions":{"type":"boolean","description":"Flag indicating whether or not the include permissions with the object data when aggregating the schema.","example":false},"features":{"type":"array","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.","example":"AUTHENTICATE"},"description":"The features that the schema supports.","example":["PROVISIONING","NO_PERMISSIONS_PROVISIONING","GROUPS_HAVE_MEMBERS"]},"configuration":{"type":"object","description":"Holds any extra configuration data that the schema may require.","example":{"groupMemberAttribute":"member"}},"attributes":{"type":"array","description":"The attribute definitions which form the schema.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"sAMAccountName"},"type":{"description":"The type of the attribute.","example":"STRING","type":"string","enum":["STRING","LONG","INT","BOOLEAN"]},"schema":{"description":"A reference to the schema on the source to the attribute values map to.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"The object ID this reference applies to.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The human-readable display name of the object.","example":"group"}}},"description":{"type":"string","description":"A human-readable description of the attribute.","example":"SAM Account Name"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","example":false},"isEntitlement":{"type":"boolean","description":"Flag indicating whether or not the attribute is an entitlement.","example":false},"isGroup":{"type":"boolean","description":"Flag indicating whether or not the attribute represents a group.\nThis can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute..\n","example":false}}},"example":[{"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":{"type":"string","description":"The date the Schema was created.","format":"date-time","example":"2019-12-24T22:32:58.104Z"},"modified":{"type":"string","description":"The date the Schema was last modified.","format":"date-time","example":"2019-12-31T20:22:28.104Z"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sources/{sourceId}/schemas","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List Schemas on a Source","description":{"content":"Lists the Schemas that exist on the specified Source in IdentityNow.\n","type":"text/plain"},"url":{"path":["sources",":sourceId","schemas"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized.","type":"text/plain"},"key":"include-types","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The Source ID.","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Schemas on a Source' (list-source-schemas)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Schemas on a Source + + + +Lists the Schemas that exist on the specified Source in IdentityNow. + + +
    Path Parameters
    Query Parameters
    + +The Schemas were successfully retrieved. + +
    Schema array
      attributes object[]
      + +The attribute definitions which form the schema. + +
      schema object
      + +A reference to the schema on the source to the attribute values map to. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-sources.api.mdx b/products/idn/api/v3/list-sources.api.mdx new file mode 100644 index 000000000..694acdc7a --- /dev/null +++ b/products/idn/api/v3/list-sources.api.mdx @@ -0,0 +1,128 @@ +--- +id: list-sources +sidebar_label: Lists all sources in IdentityNow. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listSources","security":[{"oauth2":["idn:sources:read"]}],"tags":["Sources"],"description":"This end-point lists all the sources in IdentityNow.\nA token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"example":"name eq \"#Employees\"","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n **id**: *eq, in*\n **name**: *co, eq, in, sw*\n **type**: *eq, in*\n **owner.id**: *eq, in*\n **features**: *ca, co*\n **created**: *eq*\n **modified**: *eq*\n **managementWorkgroup.id**: *eq*\n **description**: *eq*\n **authoritative**: *eq*\n **healthy**: *eq*\n **status**: *eq, in*\n **connectionType**: *eq*\n **connectorName**: *eq*"},{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"example":"name","description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status**"},{"in":"query","name":"for-subadmin","schema":{"type":"string"},"example":"name","description":"Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user.\nSubadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned."}],"responses":{"200":{"description":"List of Source objects","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"the id of the Source","example":"2c91808568c529c60168cca6f90c1324"},"name":{"type":"string","description":"Human-readable name of the source","example":"My Source"},"description":{"type":"string","description":"Human-readable description of the source","example":"This is the corporate directory."},"owner":{"description":"Reference to an owning Identity Object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity","example":"MyName"}}},"cluster":{"description":"Reference to the associated Cluster","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"type":"string","description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"accountCorrelationConfig":{"description":"Reference to an Account Correlation Config object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG"],"example":"ACCOUNT_CORRELATION_CONFIG"},"id":{"type":"string","description":"ID of the account correlation config","example":"2c9180855d191c59015d28583727245a"},"name":{"type":"string","description":"Human-readable display name of the account correlation config","example":"Directory [source-62867] Account Correlation"}}},"accountCorrelationRule":{"description":"Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"managerCorrelationMapping":{"description":"Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity","type":"object","properties":{"accountAttribute":{"type":"string","description":"Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.","example":"manager"},"identityAttribute":{"type":"string","description":"Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.","example":"manager"}}},"managerCorrelationRule":{"description":"Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"beforeProvisioningRule":{"description":"Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"schemas":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"ID of the schema","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the schema","example":"MySchema"}}},"description":"List of references to Schema objects","example":[{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232a","name":"account"},{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232b","name":"group"}]},"passwordPolicies":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["PASSWORD_POLICY"],"example":"PASSWORD_POLICY"},"id":{"type":"string","description":"ID of the policy","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the policy","example":"My Password Policy"}}},"description":"List of references to the associated PasswordPolicy objects.","example":[{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb053980","name":"Corporate Password Policy"},{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb057777","name":"Vendor Password Policy"}]},"features":{"type":"array","description":"Optional features that can be supported by a source.","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.","example":"AUTHENTICATE"},"example":["SYNC_PROVISIONING","MANAGER_LOOKUP","SEARCH","PROVISIONING","AUTHENTICATE","GROUP_PROVISIONING","PASSWORD"]},"type":{"type":"string","description":"Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ","example":"OpenLDAP - Direct"},"connector":{"type":"string","description":"Connector script name.","example":"active-directory"},"connectorClass":{"type":"string","description":"The fully qualified name of the Java class that implements the connector interface.","example":"sailpoint.connector.LDAPConnector"},"connectorAttributes":{"type":"object","description":"Connector specific configuration; will differ from type to type.","example":{"healthCheckTimeout":30,"authSearchAttributes":["cn","uid","mail"]}},"deleteThreshold":{"type":"integer","format":"int32","description":"Number from 0 to 100 that specifies when to skip the delete phase.","example":10},"authoritative":{"type":"boolean","description":"When true indicates the source is referenced by an IdentityProfile.","example":false},"managementWorkgroup":{"description":"Reference to Management Workgroup for this Source","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["GOVERNANCE_GROUP"],"example":"GOVERNANCE_GROUP"},"id":{"type":"string","description":"ID of the management workgroup","example":"2c91808568c529c60168cca6f90c2222"},"name":{"type":"string","description":"Human-readable display name of the management workgroup","example":"My Management Workgroup"}}},"healthy":{"type":"boolean","description":"When true indicates a healthy source","example":true},"status":{"type":"string","description":"A status identifier, giving specific information on why a source is healthy or not","example":"SOURCE_STATE_HEALTHY"},"since":{"type":"string","description":"Timestamp showing when a source health check was last performed","example":"2021-09-28T15:48:29.3801666300Z"},"connectorId":{"type":"string","description":"The id of connector","example":"active-directory"},"connectorName":{"type":"string","description":"The name of the connector that was chosen on source creation","example":"Active Directory"},"connectionType":{"type":"string","description":"The type of connection (direct or file)","example":"file"},"connectorImplementstionId":{"type":"string","description":"The connector implementstion id","example":"delimited-file"}},"required":["name","owner","connector"]}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/sources","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Lists all sources in IdentityNow.","description":{"content":"This end-point lists all the sources in IdentityNow.\nA token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n **id**: *eq, in*\n **name**: *co, eq, in, sw*\n **type**: *eq, in*\n **owner.id**: *eq, in*\n **features**: *ca, co*\n **created**: *eq*\n **modified**: *eq*\n **managementWorkgroup.id**: *eq*\n **description**: *eq*\n **authoritative**: *eq*\n **healthy**: *eq*\n **status**: *eq, in*\n **connectionType**: *eq*\n **connectorName**: *eq*","type":"text/plain"},"key":"filters","value":""},{"disabled":false,"description":{"content":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status**","type":"text/plain"},"key":"sorters","value":""},{"disabled":false,"description":{"content":"Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user.\nSubadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned.","type":"text/plain"},"key":"for-subadmin","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Lists all sources in IdentityNow.' (list-sources)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Lists all sources in IdentityNow. + + + +This end-point lists all the sources in IdentityNow. +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API. + +
    Query Parameters
    + +List of Source objects + +
    Schema array
      owner object
      + +Reference to an owning Identity Object + +
      cluster object
      + +Reference to the associated Cluster + +
      accountCorrelationConfig object
      + +Reference to an Account Correlation Config object + +
      accountCorrelationRule object
      + +Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used. + +
      managerCorrelationMapping object
      + +Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + +
      managerCorrelationRule object
      + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
      beforeProvisioningRule object
      + +Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + +
      schemas object[]
      + +List of references to Schema objects + +
      passwordPolicies object[]
      + +List of references to the associated PasswordPolicy objects. + +
      managementWorkgroup object
      + +Reference to Management Workgroup for this Source + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-tagged-objects-by-type.api.mdx b/products/idn/api/v3/list-tagged-objects-by-type.api.mdx new file mode 100644 index 000000000..d712ad4f4 --- /dev/null +++ b/products/idn/api/v3/list-tagged-objects-by-type.api.mdx @@ -0,0 +1,77 @@ +--- +id: list-tagged-objects-by-type +sidebar_label: List Tagged Objects +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listTaggedObjectsByType","security":[{"oauth2":["idn:tag:read","idn:tag:manage"]}],"tags":["Tagged Objects"],"description":"This API returns a list of all tagged objects by type.\n\nAny authenticated token may be used to call this API.","parameters":[{"in":"path","name":"type","schema":{"type":"string","enum":["ROLE","IDENTITY","SOD_POLICY"]},"required":true,"description":"The type of tagged object to retrieve.","example":"ROLE"},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**objectRef.id**: *eq*\n\n**objectRef.type**: *eq*","example":"objectRef.id eq \"2c91808568c529c60168cca6f90c1313\"","required":false}],"responses":{"200":{"description":"List of all tagged objects for specified type.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"objectRef":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","nullable":true,"description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"tags":{"type":"array","items":{"type":"string"},"description":"Labels to be applied to an Object","example":["BU_FINANCE","PCI"]}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/tagged-objects/{type}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List Tagged Objects","description":{"content":"This API returns a list of all tagged objects by type.\n\nAny authenticated token may be used to call this API.","type":"text/plain"},"url":{"path":["tagged-objects",":type"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**objectRef.id**: *eq*\n\n**objectRef.type**: *eq*","type":"text/plain"},"key":"filters","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The type of tagged object to retrieve.","type":"text/plain"},"type":"any","value":"","key":"type"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Tagged Objects' (list-tagged-objects-by-type)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Tagged Objects + + + +This API returns a list of all tagged objects by type. + +Any authenticated token may be used to call this API. + +
    Path Parameters
    Query Parameters
    + +List of all tagged objects for specified type. + +
    Schema array
      objectRef object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-tagged-objects.api.mdx b/products/idn/api/v3/list-tagged-objects.api.mdx new file mode 100644 index 000000000..2e523a818 --- /dev/null +++ b/products/idn/api/v3/list-tagged-objects.api.mdx @@ -0,0 +1,77 @@ +--- +id: list-tagged-objects +sidebar_label: List Tagged Objects +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listTaggedObjects","security":[{"oauth2":["idn:tag:read","idn:tag:manage"]}],"tags":["Tagged Objects"],"description":"This API returns a list of all tagged objects.\n\nAny authenticated token may be used to call this API.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**objectRef.id**: *eq, in*\n\n**objectRef.type**: *eq, in*\n\n**tagName**: *eq, in*","example":"tagName eq \"BU_FINANCE\"","required":false}],"responses":{"200":{"description":"List of all tagged objects.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"objectRef":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","nullable":true,"description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"tags":{"type":"array","items":{"type":"string"},"description":"Labels to be applied to an Object","example":["BU_FINANCE","PCI"]}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/tagged-objects","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List Tagged Objects","description":{"content":"This API returns a list of all tagged objects.\n\nAny authenticated token may be used to call this API.","type":"text/plain"},"url":{"path":["tagged-objects"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**objectRef.id**: *eq, in*\n\n**objectRef.type**: *eq, in*\n\n**tagName**: *eq, in*","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Tagged Objects' (list-tagged-objects)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Tagged Objects + + + +This API returns a list of all tagged objects. + +Any authenticated token may be used to call this API. + +
    Query Parameters
    + +List of all tagged objects. + +
    Schema array
      objectRef object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-transforms.api.mdx b/products/idn/api/v3/list-transforms.api.mdx new file mode 100644 index 000000000..82b11a429 --- /dev/null +++ b/products/idn/api/v3/list-transforms.api.mdx @@ -0,0 +1,494 @@ +--- +id: list-transforms +sidebar_label: List transforms +hide_title: true +hide_table_of_contents: true +api: {"tags":["Transforms"],"description":"Gets a list of all saved transform objects.\nA token with transforms-list read authority is required to call this API.","operationId":"listTransforms","parameters":[{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"name":"name","in":"query","description":"Name of the transform to retrieve from the list.","required":false,"style":"form","schema":{"type":"string","example":"ExampleTransformName123"}},{"name":"filters","in":"query","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n**internal**: *eq*\n**name**: *eq*, *sw*","required":false,"style":"form","explode":true,"example":"name eq \"Uppercase\"","schema":{"type":"string"}}],"responses":{"200":{"description":"A list of transforms matching the given criteria.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"The representation of an internally- or customer-defined transform.","required":["name","type","attributes"],"properties":{"id":{"type":"string","readOnly":true,"description":"Unique ID of this transform","example":"2cd78adghjkja34jh2b1hkjhasuecd"},"name":{"type":"string","description":"Unique name of this transform","example":"Timestamp To Date","minLength":1,"maxLength":50},"type":{"type":"string","description":"The type of transform operation","enum":["accountAttribute","base64Decode","base64Encode","concat","conditional","dateCompare","dateFormat","dateMath","decomposeDiacriticalMarks","e164phone","firstValid","rule","identityAttribute","indexOf","iso3166","lastIndexOf","leftPad","lookup","lower","normalizeNames","randomAlphaNumeric","randomNumeric","reference","replaceAll","replace","rightPad","split","static","substring","trim","upper","usernameGenerator","uuid"],"example":"dateFormat","externalDocs":{"description":"Transform Operations","url":"https://developer.sailpoint.com/idn/docs/transforms/operations"}},"attributes":{"description":"Meta-data about the transform. Values in this list are specific to the type of transform to be executed.","oneOf":[{"title":"accountAttribute","type":"object","required":["sourceName","attributeName"],"properties":{"sourceName":{"type":"string","description":"A reference to the source to search for the account","example":"Workday"},"attributeName":{"type":"string","description":"The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.","example":"DEPARTMENT"},"accountSortAttribute":{"type":"string","description":"The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries","example":"created"},"accountSortDescending":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)","example":false},"accountReturnFirstLink":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false","example":false},"accountFilter":{"type":"string","description":"This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria.\nOnly certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements","example":"!(nativeIdentity.startsWith(\"*DELETED*\"))"},"accountPropertyFilter":{"type":"string","description":"This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.\n\nAll account attributes are available for filtering as this operation is performed in memory.","example":"(groups.containsAll({'Admin'}) || location == 'Austin')"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"base64Decode","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"base64Encode","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"concat","type":"object","required":["values"],"properties":{"values":{"type":"array","items":{"type":"object"},"description":"An array of items to join together","example":["John"," ","Smith"]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"conditional","type":"object","required":["expression","positiveCondition","negativeCondition"],"properties":{"expression":{"type":"string","description":"A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. \n\nThe `eq` operator is the only valid comparison","example":"ValueA eq ValueB"},"positiveCondition":{"type":"string","description":"The output of the transform if the expression evalutes to true","example":"true"},"negativeCondition":{"type":"string","description":"The output of the transform if the expression evalutes to false","example":"false"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateCompare","type":"object","required":["firstDate","secondDate","operator","positiveCondition","negativeCondition"],"properties":{"firstDate":{"description":"This is the first date to consider (The date that would be on the left hand side of the comparison operation).","oneOf":[{"title":"accountAttribute","type":"object","required":["sourceName","attributeName"],"properties":{"sourceName":{"type":"string","description":"A reference to the source to search for the account","example":"Workday"},"attributeName":{"type":"string","description":"The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.","example":"DEPARTMENT"},"accountSortAttribute":{"type":"string","description":"The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries","example":"created"},"accountSortDescending":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)","example":false},"accountReturnFirstLink":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false","example":false},"accountFilter":{"type":"string","description":"This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria.\nOnly certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements","example":"!(nativeIdentity.startsWith(\"*DELETED*\"))"},"accountPropertyFilter":{"type":"string","description":"This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.\n\nAll account attributes are available for filtering as this operation is performed in memory.","example":"(groups.containsAll({'Admin'}) || location == 'Austin')"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateFormat","type":"object","properties":{"inputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"outputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}}]},"secondDate":{"description":"This is the second date to consider (The date that would be on the right hand side of the comparison operation).","oneOf":[{"title":"accountAttribute","type":"object","required":["sourceName","attributeName"],"properties":{"sourceName":{"type":"string","description":"A reference to the source to search for the account","example":"Workday"},"attributeName":{"type":"string","description":"The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.","example":"DEPARTMENT"},"accountSortAttribute":{"type":"string","description":"The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries","example":"created"},"accountSortDescending":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)","example":false},"accountReturnFirstLink":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false","example":false},"accountFilter":{"type":"string","description":"This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria.\nOnly certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements","example":"!(nativeIdentity.startsWith(\"*DELETED*\"))"},"accountPropertyFilter":{"type":"string","description":"This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.\n\nAll account attributes are available for filtering as this operation is performed in memory.","example":"(groups.containsAll({'Admin'}) || location == 'Austin')"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateFormat","type":"object","properties":{"inputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"outputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}}]},"operator":{"type":"string","description":"This is the comparison to perform.\n| Operation | Description |\n| --------- | ------- |\n| LT | Strictly less than: firstDate < secondDate |\n| LTE | Less than or equal to: firstDate <= secondDate |\n| GT | Strictly greater than: firstDate > secondDate |\n| GTE | Greater than or equal to: firstDate >= secondDate |\n","enum":["LT","LTE","GT","GTE"],"example":"LT"},"positiveCondition":{"type":"string","description":"The output of the transform if the expression evalutes to true","example":"true"},"negativeCondition":{"type":"string","description":"The output of the transform if the expression evalutes to false","example":false},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateFormat","type":"object","properties":{"inputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"outputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateMath","type":"object","required":["expression"],"properties":{"expression":{"type":"string","description":"A string value of the date and time components to operation on, along with the math operations to execute.\n","externalDocs":{"description":"Date Math Expressions","url":"https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure"},"example":"now+1w"},"roundUp":{"type":"boolean","description":"A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. \n\n\nIf not provided, the transform will default to `false`\n\n\n`true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component)\n\n\n`false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated)\n","example":false},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"decomposeDiacriticalMarks","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"e164phone","type":"object","properties":{"defaultRegion":{"type":"string","description":"This is an optional attribute that can be used to define the region of the phone number to format into.\n\n\nIf defaultRegion is not provided, it will take US as the default country.\n\n\nThe format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\n","example":"US"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"firstValid","type":"object","required":["values"],"properties":{"values":{"type":"array","items":{"type":"object"},"description":"An array of attributes to evaluate for existence.","example":[{"attributes":{"sourceName":"Active Directory","attributeName":"sAMAccountName"},"type":"accountAttribute"},{"attributes":{"sourceName":"Okta","attributeName":"login"},"type":"accountAttribute"},{"attributes":{"sourceName":"HR Source","attributeName":"employeeID"},"type":"accountAttribute"}]},"ignoreErrors":{"type":"boolean","description":"a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur.","example":false},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false}}},{"title":"rule","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"This is the name of the Generic rule that needs to be invoked by the transform","example":"Generic Calculation Rule"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false}}},{"type":"object","required":["name","operation","includeNumbers","includeSpecialChars","length"],"properties":{"name":{"type":"string","description":"This must always be set to \"Cloud Services Deployment Utility\"","example":"Cloud Services Deployment Utility"},"operation":{"type":"string","description":"The operation to perform `generateRandomString`","example":"generateRandomString"},"includeNumbers":{"type":"boolean","description":"This must be either \"true\" or \"false\" to indicate whether the generator logic should include numbers","example":true},"includeSpecialChars":{"type":"boolean","description":"This must be either \"true\" or \"false\" to indicate whether the generator logic should include special characters","example":true},"length":{"type":"string","description":"This specifies how long the randomly generated string needs to be\n\n\n>NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters\n","example":"10"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false}}},{"type":"object","required":["name","operation","uid"],"properties":{"name":{"type":"string","description":"This must always be set to \"Cloud Services Deployment Utility\"","example":"Cloud Services Deployment Utility"},"operation":{"type":"string","description":"The operation to perform `getReferenceIdentityAttribute`","example":"getReferenceIdentityAttribute"},"uid":{"type":"string","description":"This is the SailPoint User Name (uid) value of the identity whose attribute is desired\n\nAs a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute.\n","example":"2c91808570313110017040b06f344ec9"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false}}}]},{"title":"identityAttribute","type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The system (camel-cased) name of the identity attribute to bring in","example":"email"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"indexOf","type":"object","required":["substring"],"properties":{"substring":{"type":"string","description":"A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.","example":"admin_"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"iso3166","type":"object","properties":{"format":{"type":"string","description":"An optional value to denote which ISO 3166 format to return. Valid values are:\n\n\n`alpha2` - Two-character country code (e.g., \"US\"); this is the default value if no format is supplied\n\n\n`alpha3` - Three-character country code (e.g., \"USA\")\n\n\n`numeric` - The numeric country code (e.g., \"840\")\n","example":"alpha2"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"leftPad","type":"object","required":["length"],"properties":{"length":{"type":"string","description":"An integer value for the desired length of the final output string","example":"4"},"padding":{"type":"string","description":"A string value representing the character that the incoming data should be padded with to get to the desired length\n\n\nIf not provided, the transform will default to a single space (\" \") character for padding\n","example":"0"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"lookup","type":"object","required":["table"],"properties":{"table":{"type":"object","additionalProperties":true,"description":"This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched\n\n\n>**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return \"Unknown Region\" for the attribute that is mapped to this transform.\n","example":{"USA":"Americas","FRA":"EMEA","AUS":"APAC","default":"Unknown Region"}},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"lower","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"nameNormalizer","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"randomAlphaNumeric","type":"object","properties":{"length":{"type":"string","description":"This is an integer value specifying the size/number of characters the random string must contain\n\n\n* This value must be a positive number and cannot be blank\n\n\n* If no length is provided, the transform will default to a value of `32`\n\n\n* Due to identity attribute data constraints, the maximum allowable value is `450` characters\n","example":"10"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"randomNumeric","type":"object","properties":{"length":{"type":"string","description":"This is an integer value specifying the size/number of characters the random string must contain\n\n\n* This value must be a positive number and cannot be blank\n\n\n* If no length is provided, the transform will default to a value of `32`\n\n\n* Due to identity attribute data constraints, the maximum allowable value is `450` characters\n","example":"10"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"reference","type":"object","required":["id"],"properties":{"id":{"type":"string","description":"This ID specifies the name of the pre-existing transform which you want to use within your current transform","example":"Existing Transform"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"replaceAll","type":"object","required":["table"],"properties":{"table":{"type":"object","additionalProperties":true,"description":"An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.","example":{"-":" ","\"":"'","ñ":"n"}},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"replace","type":"object","required":["regex","replacement"],"properties":{"regex":{"type":"string","description":"This can be a string or a regex pattern in which you want to replace.","example":"[^a-zA-Z]","externalDocs":{"description":"Regex Builder","url":"https://regex101.com/"}},"replacement":{"type":"string","description":"This is the replacement string that should be substituded wherever the string or pattern is found.","example":" "},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"rightPad","type":"object","required":["length"],"properties":{"length":{"type":"string","description":"An integer value for the desired length of the final output string","example":"4"},"padding":{"type":"string","description":"A string value representing the character that the incoming data should be padded with to get to the desired length\n\n\nIf not provided, the transform will default to a single space (\" \") character for padding\n","example":"0"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"split","type":"object","required":["delimiter","index"],"properties":{"delimiter":{"type":"string","description":"This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data","example":","},"index":{"type":"string","description":"An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.","example":"5"},"throws":{"type":"boolean","description":"A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array)\n\n\n`true` - The transform should return \"IndexOutOfBoundsException\"\n\n\n`false` - The transform should return null\n\n\nIf not provided, the transform will default to false and return a null\n","example":true},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"static","type":"object","required":["values"],"properties":{"values":{"type":"string","description":"This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.","example":"string$variable","externalDocs":{"description":"Static Transform Documentation","url":"https://developer.sailpoint.com/idn/docs/transforms/operations/static"}},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false}}},{"title":"substring","type":"object","required":["begin"],"properties":{"begin":{"type":"integer","description":"The index of the first character to include in the returned substring.\n\n\nIf `begin` is set to -1, the transform will begin at character 0 of the input data\n","example":1,"format":"int32"},"beginOffset":{"type":"integer","description":"This integer value is the number of characters to add to the begin attribute when returning a substring. \n\nThis attribute is only used if begin is not -1.\n","example":3,"format":"int32"},"end":{"type":"integer","description":"The index of the first character to exclude from the returned substring.\n\nIf end is -1 or not provided at all, the substring transform will return everything up to the end of the input string.\n","example":6,"format":"int32"},"endOffset":{"type":"integer","description":"This integer value is the number of characters to add to the end attribute when returning a substring. \n\nThis attribute is only used if end is provided and is not -1.\n","example":1,"format":"int32"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"trim","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"upper","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"uuid","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false}}}]},"internal":{"type":"boolean","readOnly":true,"description":"Indicates whether this is an internal SailPoint-created transform or a customer-created transform","example":false}}}},"example":[{"id":"2cd78adghjkja34jh2b1hkjhasuecd","name":"Timestamp To Date","type":"dateFormat","attributes":{"inputFormat":"MMM-dd-yyyy, HH:mm:ss.SSS","outputFormat":"yyyy/dd/MM"},"internal":false},{"id":"2lkas8dhj4bkuakja77giih7l4ashh","name":"PrefixSubstring","type":"substring","attributes":{"begin":0,"end":3},"internal":true}]}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:transform:read"]}],"method":"get","path":"/transforms","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List transforms","description":{"content":"Gets a list of all saved transform objects.\nA token with transforms-list read authority is required to call this API.","type":"text/plain"},"url":{"path":["transforms"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Name of the transform to retrieve from the list.","type":"text/plain"},"key":"name","value":""},{"disabled":false,"description":{"content":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n**internal**: *eq*\n**name**: *eq*, *sw*","type":"text/plain"},"key":"filters","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List transforms' (list-transforms)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List transforms + + + +Gets a list of all saved transform objects. +A token with transforms-list read authority is required to call this API. + +
    Query Parameters
    + +A list of transforms matching the given criteria. + +
    Schema array
      attributes object
      + +Meta-data about the transform. Values in this list are specific to the type of transform to be executed. + +
      oneOf
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      firstDate object
      + +This is the first date to consider (The date that would be on the left hand side of the comparison operation). + +
      oneOf
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      inputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • outputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      secondDate object
      + +This is the second date to consider (The date that would be on the right hand side of the comparison operation). + +
      oneOf
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      inputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • outputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
       secondDate |\n| GTE | Greater than or equal to: firstDate >= secondDate |\n"} schemaName={"string"} qualifierMessage={"**Possible values:** [`LT`, `LTE`, `GT`, `GTE`]"} defaultValue={undefined}>
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      inputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • outputFormat object
      + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
      oneOf
    • string
      + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
      + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
    • string
      + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
      • input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      table object
      + +This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched + + +>**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. + + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      table object
      + +An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      input object
      + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/list-work-items.api.mdx b/products/idn/api/v3/list-work-items.api.mdx new file mode 100644 index 000000000..aff7cc505 --- /dev/null +++ b/products/idn/api/v3/list-work-items.api.mdx @@ -0,0 +1,75 @@ +--- +id: list-work-items +sidebar_label: List Work Items +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listWorkItems","tags":["Work Items"],"description":"This gets a collection of work items belonging to either the specified user(admin required), or the current user.","parameters":[{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}},{"in":"query","name":"ownerId","schema":{"type":"string"},"description":"ID of the work item owner.","required":false,"example":"1211bcaa32112bcef6122adb21cef1ac"}],"responses":{"200":{"description":"List of work items","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the work item","example":"2c9180835d2e5168015d32f890ca1581"},"requesterId":{"type":"string","description":"ID of the requester","example":"2c9180835d2e5168015d32f890ca1581"},"requesterDisplayName":{"type":"string","description":"The displayname of the requester","example":"John Smith"},"ownerId":{"type":"string","description":"The ID of the owner","example":"2c9180835d2e5168015d32f890ca1581"},"ownerName":{"type":"string","description":"The name of the owner","example":"Jason Smith"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z","description":"Time when the work item was created"},"modified":{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"Time when the work item was last updated"},"description":{"type":"string","description":"The description of the work item","example":"Create account on source 'AD'"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"},"type":{"type":"string","enum":["UNKNOWN","GENERIC","CERTIFICATION","REMEDIATION","DELEGATION","APPROVAL","VIOLATIONREVIEW","FORM","POLICYVIOLATION","CHALLENGE","IMPACTANALYSIS","SIGNOFF","EVENT","MANUALACTION","TEST"],"example":"GENERIC","description":"The type of the work item"},"remediationItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the certification","example":"2c9180835d2e5168015d32f890ca1581"},"targetId":{"type":"string","description":"The ID of the certification target","example":"2c9180835d2e5168015d32f890ca1581"},"targetName":{"type":"string","description":"The name of the certification target","example":"john.smith"},"targetDisplayName":{"type":"string","description":"The display name of the certification target","example":"emailAddress"},"applicationName":{"type":"string","description":"The name of the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute being certified","example":"phoneNumber"},"attributeOperation":{"type":"string","description":"The operation of the certification on the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute being certified","example":"512-555-1212"},"nativeIdentity":{"type":"string","description":"The native identity of the target","example":"jason.smith2"}}},"approvalItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the approval item","example":"2c9180835d2e5168015d32f890ca1581"},"account":{"type":"string","description":"The account referenced by the approval item","example":"john.smith"},"application":{"type":"string","description":"The name the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute","example":"emailAddress"},"attributeOperation":{"type":"string","description":"The operation of the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute","example":"a@b.com"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"}}},"name":{"type":"string","description":"The work item name","example":"Account Create"},"completed":{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z","description":"The time at which the work item completed"},"numItems":{"type":"integer","format":"int32","description":"The number of items in the work item","example":19},"form":{"type":"object","properties":{"id":{"type":"string","description":"ID of the form","example":"2c9180835d2e5168015d32f890ca1581"},"name":{"type":"string","description":"Name of the form","example":"AccountSelection Form"},"title":{"type":"string","description":"The form title","example":"Account Selection for John.Doe"},"subtitle":{"type":"string","description":"The form subtitle.","example":"Please select from the following"},"targetUser":{"type":"string","description":"The name of the user that should be shown this form","example":"Jane.Doe"},"sections":{"type":"object","allOf":[{"type":"object","properties":{"name":{"type":"string","description":"Name of the FormItem","example":"Field1"}}},{"type":"object","properties":{"label":{"type":"string","description":"Label of the section","example":"Section 1"},"formItems":{"type":"array","items":{"type":"object"},"description":"List of FormItems. FormItems can be SectionDetails and/or FieldDetails","example":[]}}}]}}},"errors":{"type":"array","items":{"type":"string"},"example":["The work item ID that was specified was not found."],"description":"An array of errors that ocurred during the work item"}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/work-items","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"List Work Items","description":{"content":"This gets a collection of work items belonging to either the specified user(admin required), or the current user.","type":"text/plain"},"url":{"path":["work-items"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"ID of the work item owner.","type":"text/plain"},"key":"ownerId","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Work Items' (list-work-items)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## List Work Items + + + +This gets a collection of work items belonging to either the specified user(admin required), or the current user. + +
    Query Parameters
    + +List of work items + +
    Schema array
      remediationItems object
      approvalItems object
      form object
      sections object
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/make-identity-decision.api.mdx b/products/idn/api/v3/make-identity-decision.api.mdx new file mode 100644 index 000000000..386572d65 --- /dev/null +++ b/products/idn/api/v3/make-identity-decision.api.mdx @@ -0,0 +1,91 @@ +--- +id: make-identity-decision +sidebar_label: Decide on a Certification Item +hide_title: true +hide_table_of_contents: true +api: {"operationId":"makeIdentityDecision","tags":["Certifications"],"description":"The API makes a decision to approve or revoke one or more identity campaign certification items. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the identity campaign certification on which to make decisions","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"description":"A non-empty array of decisions to be made.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the review decision","example":"ef38f94347e94562b5bb8424a56397d8"},"decision":{"type":"string","description":"The decision to approve or revoke the review item","enum":["APPROVE","REVOKE"],"example":"APPROVE"},"proposedEndDate":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z","description":"The date at which a user's access should be taken away. Should only be set for `REVOKE` decisions."},"bulk":{"type":"boolean","description":"Indicates whether decision should be marked as part of a larger bulk decision","example":true},"recommendation":{"nullable":true,"type":"object","properties":{"recommendation":{"type":"string","description":"The recommendation from IAI at the time of the decision. This field will be null if no recommendation was made.","example":null,"nullable":true},"reasons":{"type":"array","items":{"type":"string"},"description":"A list of reasons for the recommendation.","example":["Reason 1","Reason 2"]},"timestamp":{"type":"string","format":"date-time","description":"The time at which the recommendation was recorded.","example":"2020-06-01T13:49:37.385Z"}}},"comments":{"type":"string","description":"Comments recorded when the decision was made","example":"This user no longer needs access to this source"}},"required":["id","decision","bulk"]},"minItems":1,"maxItems":250},"example":[{"id":"ef38f94347e94562b5bb8424a56396b5","decision":"APPROVE","bulk":true,"comments":"This user still needs access to this source."},{"id":"ef38f94347e94562b5bb8424a56397d8","decision":"APPROVE","bulk":true,"comments":"This user still needs access to this source too."}]}}},"responses":{"200":{"description":"An identity campaign certification object","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"example":"2c9180835d2e5168015d32f890ca1581","type":"string","description":"id of the certification"},"name":{"example":"Source Owner Access Review for Employees [source]","type":"string","description":"name of the certification"},"campaign":{"type":"object","required":["id","name","type","campaignType","description","correlatedStatus","mandatoryCommentRequirement"],"properties":{"id":{"type":"string","description":"The unique ID of the campaign.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the campaign.","example":"Campaign Name"},"type":{"type":"string","enum":["CAMPAIGN"],"description":"The type of object that is being referenced.","example":"CAMPAIGN"},"campaignType":{"type":"string","enum":["MANAGER","SOURCE_OWNER","SEARCH"],"description":"The type of the campaign.","example":"MANAGER"},"description":{"type":"string","description":"The description of the campaign set by the admin who created it.","nullable":true,"example":"A description of the campaign"},"correlatedStatus":{"description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"},"mandatoryCommentRequirement":{"type":"string","description":"Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.","enum":["ALL_DECISIONS","REVOKE_ONLY_DECISIONS","NO_DECISIONS"],"example":"NO_DECISIONS"}}},"completed":{"type":"boolean","description":"Have all decisions been made?","example":true},"identitiesCompleted":{"type":"integer","description":"The number of identities for whom all decisions have been made and are complete.","example":5,"format":"int32"},"identitiesTotal":{"type":"integer","description":"The total number of identities in the Certification, both complete and incomplete.","example":10,"format":"int32"},"created":{"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"created date"},"modified":{"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"modified date"},"decisionsMade":{"type":"integer","description":"The number of approve/revoke/acknowledge decisions that have been made.","example":20,"format":"int32"},"decisionsTotal":{"type":"integer","description":"The total number of approve/revoke/acknowledge decisions.","example":40,"format":"int32"},"due":{"type":"string","format":"date-time","description":"The due date of the certification.","example":"2018-10-19T13:49:37.385Z"},"signed":{"type":"string","format":"date-time","nullable":true,"description":"The date the reviewer signed off on the Certification.","example":"2018-10-19T13:49:37.385Z"},"reviewer":{"type":"object","properties":{"id":{"type":"string","description":"The id of the reviewer.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the reviewer.","example":"Reviewer Name"},"email":{"type":"string","description":"The email of the reviewing identity.","example":"reviewer@test.com"},"type":{"type":"string","enum":["IDENTITY"],"description":"The type of the reviewing identity.","example":"IDENTITY"},"created":{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The created date of the reviewing identity."},"modified":{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The modified date of the reviewing identity."}}},"reassignment":{"type":"object","nullable":true,"properties":{"from":{"type":"object","properties":{"id":{"type":"string","description":"The id of the certification.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the certification.","example":"Certification Name"},"type":{"type":"string","enum":["CERTIFICATION"],"example":"CERTIFICATION"},"reviewer":{"type":"object","properties":{"id":{"type":"string","description":"The id of the reviewer.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the reviewer.","example":"Reviewer Name"},"email":{"type":"string","description":"The email of the reviewing identity.","example":"reviewer@test.com"},"type":{"type":"string","enum":["IDENTITY"],"description":"The type of the reviewing identity.","example":"IDENTITY"},"created":{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The created date of the reviewing identity."},"modified":{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The modified date of the reviewing identity."}}}}},"comment":{"type":"string","description":"The comment entered when the Certification was reassigned","example":"Reassigned for a reason"}}},"hasErrors":{"description":"Identifies if the certification has an error","type":"boolean","example":false},"errorMessage":{"description":"Description of the certification error","nullable":true,"type":"string","example":"The certification has an error"},"phase":{"type":"string","description":"The current phase of the campaign.\n* `STAGED`: The campaign is waiting to be activated.\n* `ACTIVE`: The campaign is active.\n* `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete.\n","enum":["STAGED","ACTIVE","SIGNED"],"example":"ACTIVE"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/certifications/{id}/decide","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"id":"ef38f94347e94562b5bb8424a56397d8","decision":"APPROVE","proposedEndDate":"2017-07-11T18:45:37.098Z","bulk":true,"recommendation":{"recommendation":null,"reasons":["Reason 1","Reason 2"],"timestamp":"2020-06-01T13:49:37.385Z"},"comments":"This user no longer needs access to this source"}],"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Decide on a Certification Item","description":{"content":"The API makes a decision to approve or revoke one or more identity campaign certification items. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.","type":"text/plain"},"url":{"path":["certifications",":id","decide"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the identity campaign certification on which to make decisions","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Decide on a Certification Item' (make-identity-decision)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Decide on a Certification Item + + + +The API makes a decision to approve or revoke one or more identity campaign certification items. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +
    Path Parameters
    Request Body array required
    + +A non-empty array of decisions to be made. + +
      recommendation object
    + +An identity campaign certification object + +
    Schema
      campaign object
      reviewer object
      reassignment object
      from object
      reviewer object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/move.api.mdx b/products/idn/api/v3/move.api.mdx new file mode 100644 index 000000000..88324aa84 --- /dev/null +++ b/products/idn/api/v3/move.api.mdx @@ -0,0 +1,95 @@ +--- +id: move +sidebar_label: Reassign Certifications +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:certification:write"]}],"operationId":"move","tags":["Certification Campaigns"],"description":"This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The certification campaign ID","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"certificationIds":{"description":"List of certification IDs to reassign","type":"array","items":{"type":"string"},"minItems":1,"maxItems":250,"example":["af3859464779471211bb8424a563abc1","af3859464779471211bb8424a563abc2","af3859464779471211bb8424a563abc3"]},"reassignTo":{"type":"object","properties":{"id":{"type":"string","description":"The identity ID to which the review is being assigned.","example":"ef38f94347e94562b5bb8424a56397d8"},"type":{"type":"string","description":"The type of the ID provided.","enum":["IDENTITY"],"example":"IDENTITY"}}},"reason":{"type":"string","description":"Comment to explain why the certification was reassigned","example":"reassigned for some reason"}}}}}},"responses":{"202":{"description":"The reassign task that has been submitted.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the certification task.","example":"2c918086719eec070171a7e3355a360a"},"type":{"type":"string","description":"The type of the certification task. More values may be added in the future.","enum":["REASSIGN","ADMIN_REASSIGN","COMPLETE_CERTIFICATION","FINISH_CERTIFICATION","COMPLETE_CAMPAIGN","ACTIVATE_CAMPAIGN","CAMPAIGN_CREATE","CAMPAIGN_DELETE"],"example":"ADMIN_REASSIGN"},"targetType":{"type":"string","description":"The type of item that is being operated on by this task whose ID is stored in the targetId field.","enum":["CERTIFICATION","CAMPAIGN"],"example":"CAMPAIGN"},"targetId":{"type":"string","description":"The ID of the item being operated on by this task.","example":"2c918086719eec070171a7e3355a834c"},"status":{"type":"string","description":"The status of the task.","enum":["QUEUED","IN_PROGRESS","SUCCESS","ERROR"],"example":"QUEUED"},"errors":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}},"description":"A list of errors that have been encountered by the task."},"reassignmentTrailDTOs":{"description":"Reassignment trails that lead to self certification identity","type":"array","items":{"type":"object","properties":{"previousOwner":{"type":"string","description":"The ID of previous owner identity.","example":"ef38f94347e94562b5bb8424a56397d8"},"newOwner":{"type":"string","description":"The ID of new owner identity.","example":"ef38f94347e94562b5bb8424a56397a3"},"reassignmentType":{"type":"string","description":"The type of reassignment.","example":"AUTOMATIC_REASSIGNMENT"}}},"example":{"previousOwner":"ef38f94347e94562b5bb8424a56397d8","newOwner":"ef38f94347e94562b5bb8424a56397a3","reassignmentType":"AUTOMATIC_REASSIGNMENT"}},"created":{"type":"string","description":"The date and time on which this task was created.","format":"date-time","example":"2020-09-24T18:10:47.693Z"}}},"example":{"id":"2c918086719eec070171a7e3355a360a","type":"ADMIN_REASSIGN","targetType":"CAMPAIGN","targetId":"2c918086719eec070171a7e3355a834c","status":"QUEUED","errors":[],"created":"2020-09-24T18:10:47.693Z"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/campaigns/{id}/reassign","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"certificationIds":["af3859464779471211bb8424a563abc1","af3859464779471211bb8424a563abc2","af3859464779471211bb8424a563abc3"],"reassignTo":{"id":"ef38f94347e94562b5bb8424a56397d8","type":"IDENTITY"},"reason":"reassigned for some reason"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Reassign Certifications","description":{"content":"This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["campaigns",":id","reassign"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The certification campaign ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Reassign Certifications' (move)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Reassign Certifications + + + +This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + +
    Path Parameters
    Request Body required
      = 1`, `<= 250`"} defaultValue={undefined}>
      reassignTo object
    + +The reassign task that has been submitted. + +
    Schema
      errors object[]
      + +A list of errors that have been encountered by the task. + +
      reassignmentTrailDTOs object[]
      + +Reassignment trails that lead to self certification identity + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/non-employee-lifecycle-management.tag.mdx b/products/idn/api/v3/non-employee-lifecycle-management.tag.mdx new file mode 100644 index 000000000..ef17bfca1 --- /dev/null +++ b/products/idn/api/v3/non-employee-lifecycle-management.tag.mdx @@ -0,0 +1,51 @@ +--- +id: non-employee-lifecycle-management +title: "Non-Employee Lifecycle Management" +description: "Non-Employee Lifecycle Management" +custom_edit_url: null +--- + + + +Use this API to implement non-employee lifecycle management functionality. +With this functionality in place, administrators can create non-employee records and configure them for use in their organizations. +This allows organizations to provide secure access to non-employees and control that access. + +The 'non-employee' term refers to any consultant, contractor, intern, or other user in an organization who is not a full-time permanent employee. +Organizations can track non-employees' access and activity in IdentityNow by creating and maintaining non-employee sources. +Organizations can have a maximum of 50 non-employee sources. + +By using SailPoint's Non-Employee Lifecycle Management functionality, you agree to the following: + +- SailPoint is not responsible for storing sensitive data. +You may only add account attributes to non-employee identities that are necessary for business operations and are consistent with your contractual limitations on data that may be sent or stored in IdentityNow. + +- You are responsible for regularly downloading your list of non-employee accounts for all the sources you create and storing this list of accounts in a managed location to maintain an authoritative system of record and backup data for these accounts. + +To manage non-employees in IdentityNow, administrators must create a non-employee source and add accounts to the source. + +To create a non-employee source in IdentityNow, administrators must use the Admin panel to go to Connections > Sources. +They must then specify 'Non-Employee' in the 'Source Type' field. +Refer to [Creating a Non-Employee Source](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#creating-a-non-employee-source) for more details about how to create non-employee sources. + +To add accounts to a non-employee source in IdentityNow, administrators can select the non-employee source and add the accounts. +They can also use the 'Manage Non-Employees' widget on their user dashboards to reach the list of sources and then select the non-employee source they want to add the accounts to. + +Administrators can either add accounts individually or in bulk. Each non-employee source can have a maximum of 20,000 accounts. +To add accounts in bulk, they must select the 'Bulk Upload' option and upload a CSV file. +Refer to [Adding Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#adding-accounts) for more details about how to add accounts to non-employee sources. + +Once administrators have created the non-employee source and added accounts to it, they can create identity profiles to generate identities for the non-employee accounts and manage the non-employee identities the same way they would any other identities. + +Refer to [Managing Non-Employee Sources and Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html) for more information about non-employee lifecycle management. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/o-auth-clients.tag.mdx b/products/idn/api/v3/o-auth-clients.tag.mdx new file mode 100644 index 000000000..083ee4da1 --- /dev/null +++ b/products/idn/api/v3/o-auth-clients.tag.mdx @@ -0,0 +1,23 @@ +--- +id: o-auth-clients +title: "OAuth Clients" +description: "OAuth Clients" +custom_edit_url: null +--- + + + +Use this API to implement OAuth client functionality. +With this functionality in place, users with the appropriate security scopes can create and configure OAuth clients to use as a way to obtain authorization to use the IdentityNow REST API. +Refer to [Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information about OAuth and how it works with the IdentityNow REST API. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/password-configuration.tag.mdx b/products/idn/api/v3/password-configuration.tag.mdx new file mode 100644 index 000000000..ff8c62bb3 --- /dev/null +++ b/products/idn/api/v3/password-configuration.tag.mdx @@ -0,0 +1,26 @@ +--- +id: password-configuration +title: "Password Configuration" +description: "Password Configuration" +custom_edit_url: null +--- + + + +Use this API to implement organization password configuration functionality. +With this functionality in place, organization administrators can create organization-specific password configurations. + +These configurations include details like custom password instructions, as well as digit token length and duration. + +Refer to [Configuring User Authentication for Password Resets](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html) for more information about organization password configuration functionality. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/password-dictionary.tag.mdx b/products/idn/api/v3/password-dictionary.tag.mdx new file mode 100644 index 000000000..3217e5cf9 --- /dev/null +++ b/products/idn/api/v3/password-dictionary.tag.mdx @@ -0,0 +1,67 @@ +--- +id: password-dictionary +title: "Password Dictionary" +description: "Password Dictionary" +custom_edit_url: null +--- + + + +Use this API to implement password dictionary functionality. +With this functionality in place, administrators can create password dictionaries to prevent users from using certain words or characters in their passwords. + +A password dictionary is a list of words or characters that users are prevented from including in their passwords. +This can help protect users from themselves and force them to create passwords that are not easy to break. + +A password dictionary must meet the following requirements to for the API to handle them correctly: + +- It must be in .txt format. + +- All characters must be UTF-8 characters. + +- Each line must contain a single word or character with no spaces or whitespace characters. + +- It must contain at least one line other than the locale string. + +- Each line must not exceed 128 characters. + +- The file must not exceed 2500 lines. + +Administrators should also consider the following when they create their dictionaries: + +- Lines starting with a # represent comments. + +- All words in the password dictionary are case-insensitive. +For example, adding the word "password" to the dictionary also disallows the following: PASSWORD, Password, and PassWord. + +- The dictionary uses substring matching. +For example, adding the word "spring" to the dictionary also disallows the following: Spring124, 345SprinG, and 8spring. +Users can then select 'Change Password' to update their passwords. + +Administrators must do the following to create a password dictionary: + +- Create the text file that will contain the prohibited password values. + +- If the dictionary is not in English, they must add a locale string to the top line: locale:`languageCode`_`countryCode` + +The languageCode value refers to the language's 2-letter ISO 639-1 code. +The countryCode value refers to the country's 2-letter ISO 3166-1 code. + +Refer to this list https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html to see all the available ISO 639-1 language codes and ISO 3166-1 country codes. + +- Upload the .txt file to IdentityNow with [Update Password Dictionary](https://developer.sailpoint.com/idn/api/v3/update-password-dictionary). Uploading a new file always overwrites the previous dictionary file. + +Administrators can then specify which password policies check new passwords against the password dictionary by doing the following: In the Admin panel, they can use the Password Mgmt dropdown menu to select Policies, select the policy, and select the 'Prevent use of words in this site's password dictionary' checkbox beside it. + +Refer to [Configuring Advanced Password Management Options](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html) for more information about password dictionaries. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/password-management.tag.mdx b/products/idn/api/v3/password-management.tag.mdx new file mode 100644 index 000000000..c28a7194c --- /dev/null +++ b/products/idn/api/v3/password-management.tag.mdx @@ -0,0 +1,44 @@ +--- +id: password-management +title: "Password Management" +description: "Password Management" +custom_edit_url: null +--- + + + +Use this API to implement password management functionality. +With this functionality in place, users can manage their identity passwords for all their applications. + +In IdentityNow, users can select their names in the upper right corner of the page and use the drop-down menu to select Password Manager. +Password Manager lists the user's identity's applications, possibly grouped to share passwords. +Users can then select 'Change Password' to update their passwords. + +Grouping passwords allows users to update their passwords more broadly, rather than requiring them to update each password individually. +Password Manager may list the applications and sources in the following groups: + +- Password Group: This refers to a group of applications that share a password. +For example, a user can use the same password for Google Drive, Google Mail, and YouTube. +Updating the password for the password group updates the password for all its included applications. + +- Multi-Application Source: This refers to a source with multiple applications that share a password. +For example, a user can have a source, G Suite, that includes the Google Calendar, Google Drive, and Google Mail applications. +Updating the password for the multi-application source updates the password for all its included applications. + +- Applications: These are applications that do not share passwords with other applications. + +An organization may require some authentication for users to update their passwords. +Users may be required to answer security questions or use a third-party authenticator before they can confirm their updates. + +Refer to [Managing Passwords](https://documentation.sailpoint.com/saas/user-help/accounts/passwords.html) for more information about password management. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/password-sync-groups.tag.mdx b/products/idn/api/v3/password-sync-groups.tag.mdx new file mode 100644 index 000000000..801def7f9 --- /dev/null +++ b/products/idn/api/v3/password-sync-groups.tag.mdx @@ -0,0 +1,52 @@ +--- +id: password-sync-groups +title: "Password Sync Groups" +description: "Password Sync Groups" +custom_edit_url: null +--- + + + +Use this API to implement password sync group functionality. +With this functionality in place, administrators can group sources into password sync groups so that all their applications share the same password. +This allows users to update the password for all the applications in a sync group if they want, rather than updating each password individually. + +A password sync group is a group of applications that shares a password. +Administrators create these groups by grouping the applications' sources. +For example, an administrator can group the ActiveDirectory, GitHub, and G Suite sources together so that all those sources' applications can also be grouped to share a password. +A user can then update his or her password for ActiveDirectory, GitHub, Gmail, Google Drive, and Google Calendar all at once, rather then updating each one individually. + +The following are required for administrators to create a password sync group in IdentityNow: + +- At least two direct connect sources connected to IdentityNow and configured for Password Management. + +- Each authentication source in a sync group must have at least one application. Refer to [Adding and Resetting Application Passwords](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html#adding-and-resetting-application-passwords) for more information about adding applications to sources. + +- At least one password policy. Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/policies.html) for more information about password policies. + +In the Admin panel in IdentityNow, administrators can use the Password Mgmt dropdown menu to select Sync Groups. +To create a sync group, administrators must provide a name, choose a password policy to be enforced across the sources in the sync group, and select the sources to include in the sync group. + +Administrators can also delete sync groups in IdentityNow, but they should know the following before they do: + +- Passwords related to the associated sources will become independent, so changing one will not change the others anymore. + +- Passwords for the sources' connected applications will also become independent. + +- Password policies assigned to the sync group are then assigned directly to the associated sources. +To change the password policy for a source, administrators must edit it directly. + +Once the password sync group has been created, users can update the password for the group in Password Manager. + +Refer to [Managing Password Sync Groups](https://documentation.sailpoint.com/saas/help/pwd/sync_grps.html) for more information about password sync groups. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/patch-access-profile.api.mdx b/products/idn/api/v3/patch-access-profile.api.mdx new file mode 100644 index 000000000..2ab8a5abb --- /dev/null +++ b/products/idn/api/v3/patch-access-profile.api.mdx @@ -0,0 +1,122 @@ +--- +id: patch-access-profile +sidebar_label: Patch a specified Access Profile +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchAccessProfile","tags":["Access Profiles"],"description":"This API updates an existing Access Profile. The following fields are patchable:\n**name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria**\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer.\n> The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters.\n\n> You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source.\n\n> Patching the value of the **requestable** field is only supported for customers enabled with the new Request Center. Otherwise, attempting to modify this field results in a 400 error.","parameters":[{"name":"id","in":"path","description":"ID of the Access Profile to patch","required":true,"schema":{"type":"string","example":"2c91808a7813090a017814121919ecca"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"examples":{"Add Entitlements":{"description":"Add one or more entitlements to the end of the list","value":[{"op":"add","path":"/entitlements","value":[{"id":"2c9180857725c14301772a93bb77242d","type":"ENTITLEMENT","name":"AD User Group"}]}]},"Insert Entitlement":{"description":"Add an entitlement at the beginning of the entitlement list","value":[{"op":"add","path":"/entitlements/0","value":{"id":"2c9180857725c14301772a93bb77242d","type":"ENTITLEMENT","name":"AD User Group"}}]},"Replace Entitlements":{"description":"Replace all entitlements with a new list of entitlements","value":[{"op":"replace","path":"/entitlements","value":[{"id":"2c9180857725c14301772a93bb77242d","type":"ENTITLEMENT","name":"AD User Group"}]}]},"Remove Entitlement":{"description":"Remove the first entitlement in the list","value":[{"op":"remove","path":"/entitlements/0"}]}}}},"required":true},"responses":{"200":{"description":"Responds with the Access Profile as updated.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Access Profile","example":"2c91808a7190d06e01719938fcd20792","readOnly":true},"name":{"type":"string","description":"Name of the Access Profile","example":"Employee-database-read-write"},"description":{"type":"string","nullable":true,"description":"Information about the Access Profile","example":"Collection of entitlements to read/write the employee database"},"created":{"type":"string","description":"Date the Access Profile was created","format":"date-time","example":"2021-03-01T22:32:58.104Z","readOnly":true},"modified":{"type":"string","description":"Date the Access Profile was last modified.","format":"date-time","example":"2021-03-02T20:22:28.104Z","readOnly":true},"enabled":{"type":"boolean","description":"Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement.","example":true},"owner":{"description":"Owner of the Access Profile","type":"object","nullable":true,"properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"source":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Source with with which the Access Profile is associated","example":"2c91809773dee3610173fdb0b6061ef4"},"type":{"type":"string","enum":["SOURCE"],"description":"The type of the Source, will always be SOURCE","example":"SOURCE"},"name":{"type":"string","description":"The display name of the associated Source","example":"ODS-AD-SOURCE"}}},"entitlements":{"type":"array","description":"A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement.","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Entitlement","example":"2c91809773dee32014e13e122092014e"},"type":{"type":"string","enum":["ENTITLEMENT"],"description":"The type of the Entitlement, will always be ENTITLEMENT","example":"ENTITLEMENT"},"name":{"type":"string","description":"The display name of the Entitlement","example":"CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"}}}},"requestable":{"type":"boolean","description":"Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error.","example":true},"accessRequestConfig":{"nullable":true,"description":"Access request configuration for this object","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":true},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":true},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"revocationRequestConfig":{"nullable":true,"description":"Revocation request configuration for this object.","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":false,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":false,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the revocation request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"segments":{"type":"array","nullable":true,"items":{"type":"string"},"description":"List of IDs of segments, if any, to which this Access Profile is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]},"provisioningCriteria":{"description":"When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression is evaluated against those Accounts to choose one to provision with the Access Profile.","nullable":true,"example":{"operation":"OR","children":[{"operation":"AND","children":[{"attribute":"dn","operation":"CONTAINS","value":"useast"},{"attribute":"manager","operation":"CONTAINS","value":"Scott.Clark"}]},{"operation":"AND","children":[{"attribute":"dn","operation":"EQUALS","value":"Gibson"},{"attribute":"telephoneNumber","operation":"CONTAINS","value":"512"}]}]},"type":"object","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","nullable":true,"description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines matching criteria for an Account to be provisioned with a specific Access Profile","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","nullable":true,"description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines matching criteria for an Account to be provisioned with a specific Access Profile","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS"},"attribute":{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true},"value":{"type":"string","description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.","example":null}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.","example":null}}}},"required":["owner","name","source"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:access-profile:manage"]}],"method":"patch","path":"/access-profiles/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Patch a specified Access Profile","description":{"content":"This API updates an existing Access Profile. The following fields are patchable:\n**name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria**\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer.\n> The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters.\n\n> You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source.\n\n> Patching the value of the **requestable** field is only supported for customers enabled with the new Request Center. Otherwise, attempting to modify this field results in a 400 error.","type":"text/plain"},"url":{"path":["access-profiles",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Access Profile to patch","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch a specified Access Profile' (patch-access-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch a specified Access Profile + + + +This API updates an existing Access Profile. The following fields are patchable: +**name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** +A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. +> The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. + +> You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source. + +> Patching the value of the **requestable** field is only supported for customers enabled with the new Request Center. Otherwise, attempting to modify this field results in a 400 error. + +
    Path Parameters
    Request Body array required
      value object
      + +The value to be used for the operation, required for "add" and "replace" operations + +
      anyOf
    • string
    • integer
      • anyOf
    • string
    • integer
    + +Responds with the Access Profile as updated. + +
    Schema
      owner object
      + +Owner of the Access Profile + +
      source object
      entitlements object[]
      + +A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. + +
      accessRequestConfig object
      + +Access request configuration for this object + +
      approvalSchemes object[]
      + +List describing the steps in approving the request + +
      revocationRequestConfig object
      + +Revocation request configuration for this object. + +
      approvalSchemes object[]
      + +List describing the steps in approving the revocation request + +
      provisioningCriteria object
      + +When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression is evaluated against those Accounts to choose one to provision with the Access Profile. + +
      children object[]
      + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + +
      children object[]
      + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/patch-non-employee-record.api.mdx b/products/idn/api/v3/patch-non-employee-record.api.mdx new file mode 100644 index 000000000..5d124c6e6 --- /dev/null +++ b/products/idn/api/v3/patch-non-employee-record.api.mdx @@ -0,0 +1,103 @@ +--- +id: patch-non-employee-record +sidebar_label: Patch Non-Employee Record +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchNonEmployeeRecord","security":[{"oauth2":[]}],"tags":["Non-Employee Lifecycle Management"],"description":"This request will patch a non-employee record. There are two contextual uses for this endpoint:\n 1. The user has the role context of `idn:nesr:update`, in which case they\nupdate all available fields.\n 2. The user is owner of the source, in this case they can only update the\nend date.","parameters":[{"in":"path","name":"id","description":"Non-employee record id (UUID)","example":"ef38f94347e94562b5bb8424a56397d8","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.","required":true,"content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"example":[{"op":"replace","path":"/endDate","value":"2019-08-23T18:40:35.772Z"}]}}},"responses":{"200":{"description":"A patched non-employee record.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee record id.","example":"ef38f94347e94562b5bb8424a56397d8"},"accountName":{"type":"string","description":"Requested identity account name.","example":"Abby.Smith"},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"sourceId":{"type":"string","description":"Non-Employee's source id.","example":"2c91808568c529c60168cca6f90c1313"},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee.","example":{"description":"Auditing"}},"startDate":{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2019-08-23T18:52:59.162Z"},"endDate":{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2020-08-23T18:52:59.162Z"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/non-employee-records/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Patch Non-Employee Record","description":{"content":"This request will patch a non-employee record. There are two contextual uses for this endpoint:\n 1. The user has the role context of `idn:nesr:update`, in which case they\nupdate all available fields.\n 2. The user is owner of the source, in this case they can only update the\nend date.","type":"text/plain"},"url":{"path":["non-employee-records",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Non-employee record id (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch Non-Employee Record' (patch-non-employee-record)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch Non-Employee Record + + + +This request will patch a non-employee record. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:update`, in which case they +update all available fields. + 2. The user is owner of the source, in this case they can only update the +end date. + +
    Path Parameters
    Request Body array required
    + +A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + +
      value object
      + +The value to be used for the operation, required for "add" and "replace" operations + +
      anyOf
    • string
    • integer
      • anyOf
    • string
    • integer
    + +A patched non-employee record. + +
    Schema
      data object
      + +Attribute blob/bag for a non-employee. + +
    • property name* string
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/patch-non-employee-schema-attribute.api.mdx b/products/idn/api/v3/patch-non-employee-schema-attribute.api.mdx new file mode 100644 index 000000000..f930c81fc --- /dev/null +++ b/products/idn/api/v3/patch-non-employee-schema-attribute.api.mdx @@ -0,0 +1,97 @@ +--- +id: patch-non-employee-schema-attribute +sidebar_label: Patch a Schema Attribute for Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchNonEmployeeSchemaAttribute","tags":["Non-Employee Lifecycle Management"],"description":"This end-point patches a specific schema attribute for a non-employee SourceId.\nRequires role context of `idn:nesr:update`\n","parameters":[{"in":"path","name":"attributeId","schema":{"type":"string"},"required":true,"description":"The Schema Attribute Id (UUID)","example":"ef38f94347e94562b5bb8424a56397d8"},{"in":"path","name":"sourceId","schema":{"type":"string"},"required":true,"description":"The Source id","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"description":"A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'.","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"example":[{"op":"replace","path":"/label","value":{"new attribute label":null}}]}},"required":true},"responses":{"200":{"description":"The Schema Attribute was successfully patched.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"UUID","example":"ac110005-7156-1150-8171-5b292e3e0084","description":"Schema Attribute Id"},"system":{"type":"boolean","description":"True if this schema attribute is mandatory on all non-employees sources.","example":true},"modified":{"type":"string","format":"date-time","description":"When the schema attribute was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the schema attribute was created.","example":"2019-08-23T18:40:35.772Z"},"type":{"type":"string","enum":["TEXT","DATE","IDENTITY"],"description":"Enum representing the type of data a schema attribute accepts.","example":"TEXT"},"label":{"type":"string","description":"Label displayed on the UI for this schema attribute.","example":"Account Name"},"technicalName":{"type":"string","description":"The technical name of the attribute. Must be unique per source.","example":"account.name"},"helpText":{"type":"string","description":"help text displayed by UI.","example":"The unique identifier for the account"},"placeholder":{"type":"string","description":"Hint text that fills UI box.","example":"Enter a unique user name for this account."},"required":{"type":"boolean","description":"If true, the schema attribute is required for all non-employees in the source","example":true}},"required":["type","technicalName","label"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/non-employee-sources/{sourceId}/schema-attributes/{attributeId}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Patch a Schema Attribute for Non-Employee Source","description":{"content":"This end-point patches a specific schema attribute for a non-employee SourceId.\nRequires role context of `idn:nesr:update`\n","type":"text/plain"},"url":{"path":["non-employee-sources",":sourceId","schema-attributes",":attributeId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Schema Attribute Id (UUID)","type":"text/plain"},"type":"any","value":"","key":"attributeId"},{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch a Schema Attribute for Non-Employee Source' (patch-non-employee-schema-attribute)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch a Schema Attribute for Non-Employee Source + + + +This end-point patches a specific schema attribute for a non-employee SourceId. +Requires role context of `idn:nesr:update` + + +
    Path Parameters
    Request Body array required
    + +A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. + +
      value object
      + +The value to be used for the operation, required for "add" and "replace" operations + +
      anyOf
    • string
    • integer
      • anyOf
    • string
    • integer
    + +The Schema Attribute was successfully patched. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/patch-non-employee-source.api.mdx b/products/idn/api/v3/patch-non-employee-source.api.mdx new file mode 100644 index 000000000..4466bf5b1 --- /dev/null +++ b/products/idn/api/v3/patch-non-employee-source.api.mdx @@ -0,0 +1,91 @@ +--- +id: patch-non-employee-source +sidebar_label: Patch a Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchNonEmployeeSource","tags":["Non-Employee Lifecycle Management"],"description":"patch a non-employee source. (partial update)
    Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`.","parameters":[{"in":"path","name":"sourceId","description":"Source Id","required":true,"schema":{"type":"string"},"example":"e136567de87e4d029e60b3c3c55db56d"}],"requestBody":{"description":"A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.","required":true,"content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"example":[{"op":"replace","path":"/name","value":{"new name":null}},{"op":"replace","path":"/approvers","value":["2c91809f703bb37a017040a2fe8748c7","48b1f463c9e8427db5a5071bd81914b8"]}]}}},"responses":{"200":{"description":"A patched non-employee source object.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"},"sourceId":{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"},"description":{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}},{"type":"object","properties":{"approvers":{"description":"List of approvers","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}}},"accountManagers":{"description":"List of account managers","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}}},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/non-employee-sources/{sourceId}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Patch a Non-Employee Source","description":{"content":"patch a non-employee source. (partial update)
    Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`.","type":"text/plain"},"url":{"path":["non-employee-sources",":sourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Source Id","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch a Non-Employee Source' (patch-non-employee-source)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch a Non-Employee Source + + + +patch a non-employee source. (partial update)
    Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. + +
    Path Parameters
    Request Body array required
    + +A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +
      value object
      + +The value to be used for the operation, required for "add" and "replace" operations + +
      anyOf
    • string
    • integer
      • anyOf
    • string
    • integer
    + +A patched non-employee source object. + +
    Schema
      approvers object[]
      + +List of approvers + +
      accountManagers object[]
      + +List of account managers + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/patch-oauth-client.api.mdx b/products/idn/api/v3/patch-oauth-client.api.mdx new file mode 100644 index 000000000..a9c876c98 --- /dev/null +++ b/products/idn/api/v3/patch-oauth-client.api.mdx @@ -0,0 +1,111 @@ +--- +id: patch-oauth-client +sidebar_label: Patch OAuth Client +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchOauthClient","security":[{"oauth2":["sp:oauth-client:manage"]}],"tags":["OAuth Clients"],"description":"This performs a targeted update to the field(s) of an OAuth client.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The OAuth client id","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"description":"A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nThe following fields are patchable:\n* tenant\n* businessName\n* homepageUrl\n* name\n* description\n* accessTokenValiditySeconds\n* refreshTokenValiditySeconds\n* redirectUris\n* grantTypes\n* accessType\n* enabled\n* strongAuthSupported\n* claimsSupported\n","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"example":[{"op":"replace","path":"/strongAuthSupported","value":true},{"op":"replace","path":"/businessName","value":"acme-solar"}]}}},"responses":{"200":{"description":"Indicates the PATCH operation succeeded, and returns the OAuth client's new representation.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the OAuth client","example":"2c9180835d2e5168015d32f890ca1581"},"businessName":{"type":"string","nullable":true,"description":"The name of the business the API Client should belong to","example":"Acme-Solar"},"homepageUrl":{"type":"string","nullable":true,"description":"The homepage URL associated with the owner of the API Client","example":"http://localhost:12345"},"name":{"type":"string","description":"A human-readable name for the API Client","example":"Demo API Client"},"description":{"type":"string","nullable":true,"description":"A description of the API Client","example":"An API client used for the authorization_code, refresh_token, and client_credentials flows"},"accessTokenValiditySeconds":{"type":"integer","format":"int32","description":"The number of seconds an access token generated for this API Client is valid for","example":750},"refreshTokenValiditySeconds":{"type":"integer","format":"int32","description":"The number of seconds a refresh token generated for this API Client is valid for","example":86400},"redirectUris":{"type":"array","nullable":true,"items":{"type":"string"},"description":"A list of the approved redirect URIs used with the authorization_code flow","example":["http://localhost:12345"]},"grantTypes":{"type":"array","items":{"description":"OAuth2 Grant Type","type":"string","example":"CLIENT_CREDENTIALS","enum":["CLIENT_CREDENTIALS","AUTHORIZATION_CODE","REFRESH_TOKEN"]},"description":"A list of OAuth 2.0 grant types this API Client can be used with","example":["AUTHORIZATION_CODE","CLIENT_CREDENTIALS","REFRESH_TOKEN"]},"accessType":{"description":"The access type (online or offline) of this API Client","example":"OFFLINE","type":"string","enum":["ONLINE","OFFLINE"]},"type":{"description":"The type of the API Client (public or confidential)","example":"CONFIDENTIAL","type":"string","enum":["CONFIDENTIAL","PUBLIC"]},"internal":{"type":"boolean","description":"An indicator of whether the API Client can be used for requests internal to IDN","example":false},"enabled":{"type":"boolean","description":"An indicator of whether the API Client is enabled for use","example":true},"strongAuthSupported":{"type":"boolean","description":"An indicator of whether the API Client supports strong authentication","example":false},"claimsSupported":{"type":"boolean","description":"An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow","example":false},"created":{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when the API Client was created","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when the API Client was last updated","example":"2018-06-25T20:22:28.104Z"},"lastUsed":{"type":"string","nullable":true,"format":"date-time","description":"The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed.","example":"2017-07-11T18:45:37.098Z"},"scope":{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the API Client.","example":["demo:api-client-scope:first","demo:api-client-scope:second"]}},"required":["id","businessName","homepageUrl","name","description","accessTokenValiditySeconds","refreshTokenValiditySeconds","redirectUris","grantTypes","accessType","type","internal","enabled","strongAuthSupported","claimsSupported","created","modified","scope"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/oauth-clients/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Patch OAuth Client","description":{"content":"This performs a targeted update to the field(s) of an OAuth client.","type":"text/plain"},"url":{"path":["oauth-clients",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The OAuth client id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch OAuth Client' (patch-oauth-client)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch OAuth Client + + + +This performs a targeted update to the field(s) of an OAuth client. + +
    Path Parameters
    Request Body array required
    + +A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +The following fields are patchable: +* tenant +* businessName +* homepageUrl +* name +* description +* accessTokenValiditySeconds +* refreshTokenValiditySeconds +* redirectUris +* grantTypes +* accessType +* enabled +* strongAuthSupported +* claimsSupported + + +
      value object
      + +The value to be used for the operation, required for "add" and "replace" operations + +
      anyOf
    • string
    • integer
      • anyOf
    • string
    • integer
    + +Indicates the PATCH operation succeeded, and returns the OAuth client's new representation. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/patch-personal-access-token.api.mdx b/products/idn/api/v3/patch-personal-access-token.api.mdx new file mode 100644 index 000000000..b025c1b60 --- /dev/null +++ b/products/idn/api/v3/patch-personal-access-token.api.mdx @@ -0,0 +1,104 @@ +--- +id: patch-personal-access-token +sidebar_label: Patch Personal Access Token +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchPersonalAccessToken","security":[{"oauth2":["sp:my-personal-access-tokens:manage"]}],"tags":["Personal Access Tokens"],"description":"This performs a targeted update to the field(s) of a Personal Access Token.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Personal Access Token id","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"description":"A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nThe following fields are patchable:\n* name\n* scope\n","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"example":[{"op":"replace","path":"/name","value":"New name"},{"op":"replace","path":"/scope","value":["sp:scopes:all"]}]}}},"responses":{"200":{"description":"Indicates the PATCH operation succeeded, and returns the PAT's new representation.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the personal access token (to be used as the username for Basic Auth).","example":"86f1dc6fe8f54414950454cbb11278fa"},"name":{"type":"string","description":"The name of the personal access token. Cannot be the same as other personal access tokens owned by a user.","example":"NodeJS Integration"},"scope":{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the personal access token.","example":["demo:personal-access-token-scope:first","demo:personal-access-token-scope:second"]},"owner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Details about the owner of the personal access token."},"created":{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when this personal access token was created.","example":"2017-07-11T18:45:37.098Z"},"lastUsed":{"type":"string","nullable":true,"format":"date-time","description":"The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed.","example":"2017-07-11T18:45:37.098Z"}},"required":["id","name","scope","owner","created"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/personal-access-tokens/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Patch Personal Access Token","description":{"content":"This performs a targeted update to the field(s) of a Personal Access Token.","type":"text/plain"},"url":{"path":["personal-access-tokens",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Personal Access Token id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch Personal Access Token' (patch-personal-access-token)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch Personal Access Token + + + +This performs a targeted update to the field(s) of a Personal Access Token. + +
    Path Parameters
    Request Body array required
    + +A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +The following fields are patchable: +* name +* scope + + +
      value object
      + +The value to be used for the operation, required for "add" and "replace" operations + +
      anyOf
    • string
    • integer
      • anyOf
    • string
    • integer
    + +Indicates the PATCH operation succeeded, and returns the PAT's new representation. + +
    Schema
      owner object
      + +Details about the owner of the personal access token. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/patch-role.api.mdx b/products/idn/api/v3/patch-role.api.mdx new file mode 100644 index 000000000..ea272526b --- /dev/null +++ b/products/idn/api/v3/patch-role.api.mdx @@ -0,0 +1,139 @@ +--- +id: patch-role +sidebar_label: Patch a specified Role +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchRole","tags":["Roles"],"description":"This API updates an existing Role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.\n\nThe following fields are patchable: **name**, **description**, **enabled**, **owner**, **accessProfiles**, **membership**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.\nThe maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.","parameters":[{"name":"id","in":"path","description":"ID of the Role to patch","required":true,"schema":{"type":"string","example":"2c91808a7813090a017814121e121518"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"examples":{"Make a Role Requestable and Enable it in One Call":{"description":"This example shows how multiple fields may be updated with a single patch call.","value":[{"op":"replace","path":"/requestable","value":true},{"op":"replace","path":"/enabled","value":true}]},"Assign a Role to a Segment":{"description":"This example illustrates the use of patch to assign a Role to a Segment by adding the Segment's ID to the Role's segments array.","value":[{"op":"add","path":"/segments/-","value":"f7b1b8a3-5fed-4fd4-ad29-82014e137e19"}]},"Set the Membership Selection Criteria to a List of Identities":{"description":"This example shows how to define a Role's membershp by providing a list of Identities, referenced by their IDs.","value":[{"op":"replace","path":"/membership","value":{"type":"IDENTITY_LIST","identities":[{"id":"2c91808973fe906c0174262092014ed9"},{"id":"2c918086262092014ed94fb8a47612f3"}]}}]},"Set the Membership Selection Criteria to a Standard Expression":{"description":"This example shows how to define a Role's membership using STANDARD criteria. In this case, the Role will be granted to all Identities which have the *Engineering* attribute from the indicated Source.","value":[{"op":"replace","path":"/membership","value":{"type":"STANDARD","criteria":{"operation":"OR","children":[{"operation":"EQUALS","key":{"type":"ENTITLEMENT","property":"attribute.memberOf","sourceId":"2c9180887701fb2014213e122092014e"},"stringValue":"Engineering"}]}}}]},"Add a New Clause as the Child of an Existing Standard Expression":{"description":"This example shows how to add a child clause to an existing STANDARD criteria expression.","value":[{"op":"add","path":"/membership/criteria/children/-","value":{"operation":"ENDS_WITH","key":{"type":"IDENTITY","property":"attribute.email"},"stringValue":"@identitynow.com"}}]}}}},"required":true},"responses":{"200":{"description":"Responds with the Role as updated.","content":{"application/json":{"schema":{"type":"object","description":"A Role","properties":{"id":{"type":"string","description":"The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.","example":"2c918086749d78830174a1a40e121518"},"name":{"type":"string","description":"The human-readable display name of the Role","maxLength":128,"example":"Role 2567"},"created":{"type":"string","description":"Date the Role was created","format":"date-time","example":"2021-03-01T22:32:58.104Z","readOnly":true},"modified":{"type":"string","description":"Date the Role was last modified.","format":"date-time","example":"2021-03-02T20:22:28.104Z","readOnly":true},"description":{"type":"string","nullable":true,"description":"A human-readable description of the Role","example":"Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor."},"owner":{"type":"object","nullable":true,"description":"The owner of this object.","properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"accessProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the Access Profile","example":"ff808081751e6e129f1518161919ecca"},"type":{"type":"string","description":"Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result.","enum":["ACCESS_PROFILE"],"example":"ACCESS_PROFILE"},"name":{"type":"string","description":"Human-readable display name of the Access Profile. This field is ignored on input.","example":"Access Profile 2567"}}},"nullable":true},"membership":{"nullable":true,"type":"object","description":"When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.","properties":{"type":{"type":"string","enum":["STANDARD","IDENTITY_LIST"],"description":"This enum characterizes the type of a Role's membership selector. Only the following two are fully supported:\n\nSTANDARD: Indicates that Role membership is defined in terms of a criteria expression\n\nIDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed","example":"IDENTITY_LIST"},"criteria":{"nullable":true,"type":"object","description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","nullable":true,"description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","nullable":true,"description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","nullable":true,"description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"},"children":{"type":"array","items":{"type":"object","description":"Defines STANDARD type Role membership","properties":{"operation":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS"},"key":{"type":"object","nullable":true,"description":"Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria","properties":{"type":{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT"},"property":{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"},"sourceId":{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}},"required":["type","property"]},"stringValue":{"type":"string","description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa."}}},"nullable":true,"description":"Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa."}}},"identities":{"type":"array","items":{"type":"object","description":"A reference to an Identity in an IDENTITY_LIST role membership criteria.","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY","nullable":true},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","nullable":true,"description":"Human-readable display name of the Identity.","example":"Thomas Edison"},"aliasName":{"type":"string","nullable":true,"description":"User name of the Identity","example":"t.edison"}}},"nullable":true,"description":"Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST."}}},"legacyMembershipInfo":{"type":"object","nullable":true,"description":"This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.","example":{"type":"IDENTITY_LIST"},"additionalProperties":true},"enabled":{"type":"boolean","description":"Whether the Role is enabled or not.","example":true,"default":false},"requestable":{"type":"boolean","description":"Whether the Role can be the target of access requests.","example":true,"default":false},"accessRequestConfig":{"nullable":true,"description":"Access request configuration for this object","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":true,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":true,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n\n**OWNER**: Owner of the associated Role\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"revocationRequestConfig":{"nullable":true,"default":null,"description":"Revocation request configuration for this object.","type":"object","properties":{"commentsRequired":{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":false,"nullable":true,"default":false},"denialCommentsRequired":{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":false,"nullable":true,"default":false},"approvalSchemes":{"type":"array","description":"List describing the steps in approving the revocation request","items":{"type":"object","properties":{"approverType":{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"},"approverId":{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}}}}},"segments":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of IDs of segments, if any, to which this Role is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]}},"required":["name","owner"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:role-unchecked:manage","idn:role-checked:manage"]}],"method":"patch","path":"/roles/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Patch a specified Role","description":{"content":"This API updates an existing Role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.\n\nThe following fields are patchable: **name**, **description**, **enabled**, **owner**, **accessProfiles**, **membership**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**\nA token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.\nThe maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.","type":"text/plain"},"url":{"path":["roles",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Role to patch","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch a specified Role' (patch-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch a specified Role + + + +This API updates an existing Role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: **name**, **description**, **enabled**, **owner**, **accessProfiles**, **membership**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments** +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +
    Path Parameters
    Request Body array required
      value object
      + +The value to be used for the operation, required for "add" and "replace" operations + +
      anyOf
    • string
    • integer
      • anyOf
    • string
    • integer
    + +Responds with the Role as updated. + +
    Schema
      owner object
      + +The owner of this object. + +
      accessProfiles object[]
      membership object
      + +When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities. + +
      criteria object
      + +Defines STANDARD type Role membership + +
      key object
      + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
      children object[]
      + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + +
      key object
      + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
      children object[]
      + +Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + +
      key object
      + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
      identities object[]
      + +Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. + +
      legacyMembershipInfo object
      + +This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. + +
      accessRequestConfig object
      + +Access request configuration for this object + +
      approvalSchemes object[]
      + +List describing the steps in approving the request + +
      revocationRequestConfig object
      + +Revocation request configuration for this object. + +
      approvalSchemes object[]
      + +List describing the steps in approving the revocation request + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/patch-segment.api.mdx b/products/idn/api/v3/patch-segment.api.mdx new file mode 100644 index 000000000..fcd72101c --- /dev/null +++ b/products/idn/api/v3/patch-segment.api.mdx @@ -0,0 +1,112 @@ +--- +id: patch-segment +sidebar_label: Update a Segment +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchSegment","security":[{"oauth2":["idn:segment:manage"]}],"tags":["Segments"],"description":"Allows updating Segment fields using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nNote that changes to a segment may take some time to propagate to all identities, and that segments will have no effect if segmentation is not enabled for your org.\n\nA token with ORG_ADMIN or API authority is required to call this API.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the Segment being modified.","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"description":"A list of Segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\n\nThe following fields are patchable:\n* name\n* description\n* owner\n* visibilityCriteria\n* active\n","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Set Visibility Criteria":{"description":"Set the visibility criteria","value":[{"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"}}]}}}]}}}}},"responses":{"200":{"description":"Indicates the PATCH operation succeeded, and returns the Segment's new representation.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Segment.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"},"name":{"type":"string","description":"Segment Business Name","example":"segment-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this Segment is created","example":"2020-01-01T00:00:00.000000Z"},"modified":{"type":"string","format":"date-time","description":"The time when this Segment is modified","example":"2020-01-01T00:00:00.000000Z"},"description":{"type":"string","description":"Optional description of the Segment","example":"This segment represents xyz"},"owner":{"type":"object","nullable":true,"description":"The owner of this object.","properties":{"type":{"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"]},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}},"visibilityCriteria":{"type":"object","properties":{"expression":{"type":"object","properties":{"operator":{"type":"string","description":"Operator for the expression","enum":["AND","EQUALS"],"example":"EQUALS"},"attribute":{"type":"string","description":"Name for the attribute","example":"location"},"value":{"type":"object","properties":{"type":{"type":"string","description":"The type of attribute value","example":"STRING"},"value":{"type":"string","description":"The attribute value","example":"Austin"}}},"children":{"type":"array","nullable":true,"description":"List of expressions","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of attribute value","example":"STRING"},"value":{"type":"string","description":"The attribute value","example":"Austin"}}},"example":[]}}}}},"active":{"type":"boolean","description":"Whether the Segment is currently active. Inactive segments have no effect.","default":false,"example":true}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/segments/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{}],"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Update a Segment","description":{"content":"Allows updating Segment fields using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nNote that changes to a segment may take some time to propagate to all identities, and that segments will have no effect if segmentation is not enabled for your org.\n\nA token with ORG_ADMIN or API authority is required to call this API.","type":"text/plain"},"url":{"path":["segments",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the Segment being modified.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a Segment' (patch-segment)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a Segment + + + +Allows updating Segment fields using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +Note that changes to a segment may take some time to propagate to all identities, and that segments will have no effect if segmentation is not enabled for your org. + +A token with ORG_ADMIN or API authority is required to call this API. + +
    Path Parameters
    Request Body array required
    + +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 + + +
    + +Indicates the PATCH operation succeeded, and returns the Segment's new representation. + +
    Schema
      owner object
      + +The owner of this object. + +
      visibilityCriteria object
      expression object
      value object
      children object[]
      + +List of expressions + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/patch-service-desk-integration.api.mdx b/products/idn/api/v3/patch-service-desk-integration.api.mdx new file mode 100644 index 000000000..75fc62519 --- /dev/null +++ b/products/idn/api/v3/patch-service-desk-integration.api.mdx @@ -0,0 +1,135 @@ +--- +id: patch-service-desk-integration +sidebar_label: Service Desk Integration Update PATCH +hide_title: true +hide_table_of_contents: true +api: {"operationId":"patchServiceDeskIntegration","tags":["Service Desk Integration"],"description":"Update an existing ServiceDeskIntegration by ID with a PATCH request.","parameters":[{"name":"id","in":"path","description":"ID of the Service Desk integration to update","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"anId"}}],"requestBody":{"required":true,"description":"A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nPATCH can only be applied to the following fields:\n * `beforeProvisioningRule`\n * `description`\n * `ownerRef`\n\nA 403 Forbidden Error indicates that you attempted to PATCH a field that is not allowed.\n","content":{"application/json-patch+json":{"schema":{"type":"object","description":"A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","properties":{"operations":{"description":"Operations to be applied","type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}}}},"example":[{"op":"replace","path":"/ownerRef","value":{"id":"2c9180867d05b227017d09921a205b4d","type":"IDENTITY","name":"Angelo2 tester"}}]}}},"responses":{"200":{"description":"ServiceDeskIntegrationDto as updated","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true},"modified":{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}},{"type":"object","description":"Specification of a Service Desk integration","required":["description","type","attributes"],"properties":{"description":{"description":"Description of the Service Desk integration","type":"string","example":"A very nice Service Desk integration"},"type":{"description":"Service Desk integration types\n\n- ServiceNowSDIM\n- ServiceNow\n","type":"string","default":"ServiceNowSDIM","example":"ServiceNowSDIM"},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the identity that is the owner of this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the identity","example":"MyName"}}},"clusterRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the source cluster for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"cluster":{"description":"ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)","type":"string","example":"xyzzy999","deprecated":true},"managedSources":{"description":"Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)","type":"array","items":{"type":"string"},"deprecated":true,"example":["2c9180835d191a86015d28455b4a2329","2c5680835d191a85765d28455b4a9823"]},"provisioningConfig":{"description":"The 'provisioningConfig' property specifies the configuration used to provision integrations.","type":"object","properties":{"universalManager":{"description":"Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.","type":"boolean","readOnly":true,"example":true},"managedResourceRefs":{"description":"References to sources for the Service Desk integration template. May only be specified if universalManager is false.","type":"array","items":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"properties":{"type":{"description":"The type of object being referenced","enum":["SOURCE"],"example":"SOURCE"},"id":{"description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the source","example":"My Source"}}},"example":[{"type":"SOURCE","id":"2c9180855d191c59015d291ceb051111","name":"My Source 1"},{"type":"SOURCE","id":"2c9180855d191c59015d291ceb052222","name":"My Source 2"}]},"planInitializerScript":{"description":"This is a reference to a plan initializer script.","type":"object","properties":{"source":{"description":"This is a Rule that allows provisioning instruction changes.","type":"string","example":"\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n"}}},"noProvisioningRequests":{"description":"Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.","type":"boolean","example":true},"provisioningRequestExpiration":{"description":"When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.","type":"integer","format":"int32","example":7}}},"attributes":{"description":"Attributes of the Service Desk integration. Validation constraints enforced by the implementation.","type":"object","additionalProperties":true,"example":{"property":"value","key":"value"}},"beforeProvisioningRule":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to beforeProvisioningRule for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["RULE"],"example":"RULE"},"id":{"description":"ID of the rule","example":"2c91808568c529c60168cca6f90c1333"},"name":{"description":"Human-readable display name of the rule","example":"Example Rule"}}}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:service-desk-admin:manage","idn:service-desk-integration:manage"]}],"method":"patch","path":"/service-desk-integrations/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"operations":[{"op":"replace","path":"/description","value":"string"}]},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Service Desk Integration Update PATCH","description":{"content":"Update an existing ServiceDeskIntegration by ID with a PATCH request.","type":"text/plain"},"url":{"path":["service-desk-integrations",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Service Desk integration to update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Service Desk Integration Update PATCH' (patch-service-desk-integration)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Service Desk Integration Update PATCH + + + +Update an existing ServiceDeskIntegration by ID with a PATCH request. + +
    Path Parameters
    Request Body required
    + +A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +PATCH can only be applied to the following fields: + * `beforeProvisioningRule` + * `description` + * `ownerRef` + +A 403 Forbidden Error indicates that you attempted to PATCH a field that is not allowed. + + +
      operations object[]
      + +Operations to be applied + +
      value object
      + +The value to be used for the operation, required for "add" and "replace" operations + +
      anyOf
    • string
    • integer
      • anyOf
    • string
    • integer
    + +ServiceDeskIntegrationDto as updated + +
    Schema
      ownerRef object
      + +Reference to the identity that is the owner of this Service Desk integration + +
      clusterRef object
      + +Reference to the source cluster for this Service Desk integration + +
      provisioningConfig object
      + +The 'provisioningConfig' property specifies the configuration used to provision integrations. + +
      managedResourceRefs object[]
      + +References to sources for the Service Desk integration template. May only be specified if universalManager is false. + +
      planInitializerScript object
      + +This is a reference to a plan initializer script. + +
      attributes object
      + +Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + +
      beforeProvisioningRule object
      + +Reference to beforeProvisioningRule for this Service Desk integration + +
    \\\\r\\\\n\\\\r\\\\n\\\\r\\\\n Before Provisioning Rule which changes disables and enables to a modify.\\\\r\\\\n \\n\"\n },\n \"noProvisioningRequests\": true,\n \"provisioningRequestExpiration\": 7\n },\n \"attributes\": {\n \"property\": \"value\",\n \"key\": \"value\"\n },\n \"beforeProvisioningRule\": {\n \"type\": true,\n \"id\": true,\n \"name\": true\n }\n}"} language={"json"}>
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/patch-sod-policy.api.mdx b/products/idn/api/v3/patch-sod-policy.api.mdx new file mode 100644 index 000000000..d734e15f7 --- /dev/null +++ b/products/idn/api/v3/patch-sod-policy.api.mdx @@ -0,0 +1,127 @@ +--- +id: patch-sod-policy +sidebar_label: Patch SOD policy by ID +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:sod-policy:write"]}],"operationId":"patchSodPolicy","tags":["SOD Policy"],"description":"Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\nRequires role of ORG_ADMIN.\nThis endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. ","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the SOD policy being modified.","example":"2c918083-5d19-1a86-015d-28455b4a2329"}],"requestBody":{"required":true,"description":"A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nThe following fields are patchable:\n* name\n* description\n* ownerRef\n* externalPolicyReference\n* compensatingControls\n* correctionAdvice\n* state\n* tags\n* violationOwnerAssignmentConfig\n* scheduled\n* conflictingAccessCriteria\n","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"examples":{"Conflicting Access Based Policy":{"value":[{"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"}]}}]},"General Policy":{"value":[{"op":"replace","path":"/description","value":"Modified description"}]}}}}},"responses":{"200":{"description":"Indicates the PATCH operation succeeded, and returns the SOD policy's new representation.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Policy id","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"name":{"type":"string","description":"Policy Business Name","example":"policy-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this SOD policy is created.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"modified":{"type":"string","format":"date-time","description":"The time when this SOD policy is modified.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"description":{"type":"string","description":"Optional description of the SOD policy","example":"This policy ensures compliance of xyz","nullable":true},"ownerRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"externalPolicyReference":{"type":"string","description":"Optional External Policy Reference","example":"XYZ policy","nullable":true},"policyQuery":{"type":"string","description":"Search query of the SOD policy","example":"@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)"},"compensatingControls":{"type":"string","description":"Optional compensating controls(Mitigating Controls)","example":"Have a manager review the transaction decisions for their \"out of compliance\" employee","nullable":true},"correctionAdvice":{"type":"string","description":"Optional correction advice","example":"Based on the role of the employee, managers should remove access that is not required for their job function.","nullable":true},"state":{"type":"string","description":"whether the policy is enforced or not","enum":["ENFORCED","NOT_ENFORCED"],"example":"ENFORCED"},"tags":{"type":"array","description":"tags for this policy object","example":["TAG1","TAG2"],"items":{"type":"string"}},"creatorId":{"type":"string","description":"Policy's creator ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"modifierId":{"type":"string","description":"Policy's modifier ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","nullable":true,"readOnly":true},"violationOwnerAssignmentConfig":{"nullable":true,"type":"object","properties":{"assignmentRule":{"type":"string","enum":["MANAGER","STATIC",null],"description":"Details about the violations owner.\nMANAGER - identity's manager\nSTATIC - Governance Group or Identity","example":"MANAGER","nullable":true},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"nullable":true}]}}},"scheduled":{"type":"boolean","description":"defines whether a policy has been scheduled or not","example":true,"default":false},"type":{"type":"string","description":"whether a policy is query based or conflicting access based","default":"GENERAL","enum":["GENERAL","CONFLICTING_ACCESS_BASED"],"example":"GENERAL"},"conflictingAccessCriteria":{"allOf":[{"type":"object","properties":{"leftCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","minItems":1,"maxItems":50,"items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"Type of the propery to which this reference applies to","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}},"rightCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","minItems":1,"maxItems":50,"items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"Type of the propery to which this reference applies to","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}}}},{"nullable":true}]}}},"examples":{"Conflicting Access Based Policy":{"value":{"id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"Conflicting-Policy-Name","created":"2020-01-01T00:00:00.000000Z","modified":"2020-01-01T00:00:00.000000Z","description":"Modified description","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Owner Name"},"externalPolicyReference":"XYZ policy","policyQuery":"@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c918087682f9a86016839c0509c1ab2)","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":["string"],"creatorId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","modifierId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","violationOwnerAssignmentConfig":{"assignmentRule":"MANAGER","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Violation Owner Name"}},"scheduled":true,"type":"CONFLICTING_ACCESS_BASED","conflictingAccessCriteria":{"leftCriteria":{"name":"money-in-modified","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67"}]},"rightCriteria":{"name":"money-out-modified","criteriaList":[{"type":"ENTITLEMENT","id":"2c918087682f9a86016839c0509c1ab2"}]}}}},"General Policy":{"value":{"description":"Modified description","ownerRef":{"type":"IDENTITY","id":"2c918087682f9a86016839c05e8f1aff","name":"Owner Name"},"externalPolicyReference":"New policy","policyQuery":"policy query implementation","compensatingControls":"Compensating controls","correctionAdvice":"Correction advice","tags":[],"state":"ENFORCED","scheduled":false,"creatorId":"2c918087682f9a86016839c05e8f1aff","modifierId":null,"violationOwnerAssignmentConfig":null,"type":"GENERAL","conflictingAccessCriteria":null,"id":"52c11db4-733e-4c31-949a-766c95ec95f1","name":"General-Policy-Name","created":"2020-05-12T19:47:38Z","modified":"2020-05-12T19:47:38Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/sod-policies/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Patch SOD policy by ID","description":{"content":"Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\nRequires role of ORG_ADMIN.\nThis endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. ","type":"text/plain"},"url":{"path":["sod-policies",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the SOD policy being modified.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Patch SOD policy by ID' (patch-sod-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Patch SOD policy by ID + + + +Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Requires role of ORG_ADMIN. +This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. + +
    Path Parameters
    Request Body array required
    + +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 + + +
      value object
      + +The value to be used for the operation, required for "add" and "replace" operations + +
      anyOf
    • string
    • integer
      • anyOf
    • string
    • integer
    + +Indicates the PATCH operation succeeded, and returns the SOD policy's new representation. + +
    Schema
      ownerRef object
      violationOwnerAssignmentConfig object
      ownerRef object
      conflictingAccessCriteria object
      leftCriteria object
      criteriaList object[]
      + +**Possible values:** `>= 1`, `<= 50` + +
      + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
      rightCriteria object
      criteriaList object[]
      + +**Possible values:** `>= 1`, `<= 50` + +
      + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/personal-access-tokens.tag.mdx b/products/idn/api/v3/personal-access-tokens.tag.mdx new file mode 100644 index 000000000..c900226ad --- /dev/null +++ b/products/idn/api/v3/personal-access-tokens.tag.mdx @@ -0,0 +1,31 @@ +--- +id: personal-access-tokens +title: "Personal Access Tokens" +description: "Personal Access Tokens" +custom_edit_url: null +--- + + + +Use this API to implement personal access token (PAT) functionality. +With this functionality in place, users can use PATs as an alternative to passwords for authentication in IdentityNow. + +PATs embed user information into the client ID and secret. +This replaces the API clients' need to store and provide a username and password to establish a connection, improving IdentityNow organizations' integration security. + +In IdentityNow, users can do the following to create and manage their PATs: Select the dropdown menu under their names, select Preferences, and then select Personal Access Tokens. +They must then provide a description about the token's purpose. +They can then select 'Create Token' at the bottom of the page to generate and view the Secret and Client ID. + +Refer to [Managing Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/generate_tokens.html) for more information about PATs. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/public-identities-config.tag.mdx b/products/idn/api/v3/public-identities-config.tag.mdx new file mode 100644 index 000000000..3fa00fe5b --- /dev/null +++ b/products/idn/api/v3/public-identities-config.tag.mdx @@ -0,0 +1,30 @@ +--- +id: public-identities-config +title: "Public Identities Config" +description: "Public Identities Config" +custom_edit_url: null +--- + + + +Use this API to implement public identity configuration functionality. +With this functionality in place, administrators can make up to 5 identity attributes publicly visible so other non-administrator users can see the relevant information they need to make decisions. +This can be helpful for approvers making approvals, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. + +By default, non-administrators can select an identity and view the following attributes: email, lifecycle state, and manager. +However, it may be helpful for a non-administrator reviewer to see other identity attributes like department, region, title, etc. +Administrators can use this API to make those necessary identity attributes public to non-administrators. + +For example, a non-administrator deciding whether to approve another identity's request for access to the Workday application, whose access may be restricted to members of the HR department, would want to know whether the identity is a member of the HR department. +If an administrator has used [Update Public Identity Config](https://developer.sailpoint.com/idn/api/v3/update-public-identity-config) to make the "department" attribute public, the approver can see the department and make a decision without requesting any more information. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/public-identities.tag.mdx b/products/idn/api/v3/public-identities.tag.mdx new file mode 100644 index 000000000..0e011f83d --- /dev/null +++ b/products/idn/api/v3/public-identities.tag.mdx @@ -0,0 +1,23 @@ +--- +id: public-identities +title: "Public Identities" +description: "Public Identities" +custom_edit_url: null +--- + + + +Use this API in conjunction with [Public Identites Config](https://developer.sailpoint.com/idn/api/v3/public-identities-config) to enable non-administrators to view identities' publicly visible attributes. +With this functionality in place, non-administrators can view identity attributes other than the default attributes (email, lifecycle state, and manager), depending on which identity attributes their organization administrators have made public. +This can be helpful for access approvers, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/put-account.api.mdx b/products/idn/api/v3/put-account.api.mdx new file mode 100644 index 000000000..1a234c6bf --- /dev/null +++ b/products/idn/api/v3/put-account.api.mdx @@ -0,0 +1,93 @@ +--- +id: put-account +sidebar_label: Update Account +hide_title: true +hide_table_of_contents: true +api: {"operationId":"putAccount","tags":["Accounts"],"description":"This API submits an account update task and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API.\n>**NOTE: The PUT Account API is designated only for Delimited File sources.**","security":[{"oauth2":["idn:accounts:manage"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The account ID","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["attributes"],"properties":{"attributes":{"description":"The schema attribute values for the account","type":"object","additionalProperties":true,"example":{"city":"Austin","displayName":"John Doe","userName":"jdoe","sAMAccountName":"jDoe","mail":"john.doe@sailpoint.com"}}}}}}},"responses":{"202":{"description":"Async task details","content":{"application/json":{"schema":{"description":"Accounts async response containing details on started async process","required":["id"],"type":"object","properties":{"id":{"description":"id of the task","type":"string","example":"2c91808474683da6017468693c260195"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/accounts/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"attributes":{"city":"Austin","displayName":"John Doe","userName":"jdoe","sAMAccountName":"jDoe","mail":"john.doe@sailpoint.com"}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Update Account","description":{"content":"This API submits an account update task and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API.\n>**NOTE: The PUT Account API is designated only for Delimited File sources.**","type":"text/plain"},"url":{"path":["accounts",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The account ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Account' (put-account)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Account + + + +This API submits an account update task and returns the task ID. +A token with ORG_ADMIN authority is required to call this API. +>**NOTE: The PUT Account API is designated only for Delimited File sources.** + +
    Path Parameters
    Request Body required
      attributes object required
      + +The schema attribute values for the account + +
    + +Async task details + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/put-provisioning-policy.api.mdx b/products/idn/api/v3/put-provisioning-policy.api.mdx new file mode 100644 index 000000000..41f941ba3 --- /dev/null +++ b/products/idn/api/v3/put-provisioning-policy.api.mdx @@ -0,0 +1,90 @@ +--- +id: put-provisioning-policy +sidebar_label: Update Provisioning Policy by UsageType +hide_title: true +hide_table_of_contents: true +api: {"operationId":"putProvisioningPolicy","tags":["Sources"],"description":"This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow.\nTransforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.\nRefer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","security":[{"oauth2":["idn:provisioning-policy:manage","idn:provisioning-policy-source-admin-operations:manage"]}],"parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source ID.","example":"2c9180835d191a86015d28455b4a2329"},{"in":"path","name":"usageType","required":true,"schema":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"description":"The type of ProvisioningPolicy usage."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"the provisioning policy name","example":"example provisioning policy for inactive identities"},"description":{"type":"string","description":"the description of the provisioning policy","example":"this provisioning policy creates access based on an identity going inactive"},"usageType":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"userName"},"transform":{"type":"object","description":"The transform to apply to the field","example":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"default":{}},"attributes":{"type":"object","description":"Attributes required for the transform","example":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"}},"type":{"type":"string","description":"The type of the attribute.","example":"string"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","default":false,"example":false}}}}}}}}},"responses":{"200":{"description":"The ProvisioningPolicyDto was successfully replaced.","content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"the provisioning policy name","example":"example provisioning policy for inactive identities"},"description":{"type":"string","description":"the description of the provisioning policy","example":"this provisioning policy creates access based on an identity going inactive"},"usageType":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"userName"},"transform":{"type":"object","description":"The transform to apply to the field","example":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"default":{}},"attributes":{"type":"object","description":"Attributes required for the transform","example":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"}},"isRequired":{"type":"boolean","readOnly":true,"description":"Flag indicating whether or not the attribute is required.","default":false,"example":false},"type":{"type":"string","description":"The type of the attribute.","example":"string"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","default":false,"example":false}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/sources/{sourceId}/provisioning-policies/{usageType}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"example provisioning policy for inactive identities","description":"this provisioning policy creates access based on an identity going inactive","usageType":"CREATE","fields":[{"name":"userName","transform":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"attributes":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"},"type":"string","isMultiValued":false}]},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Update Provisioning Policy by UsageType","description":{"content":"This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow.\nTransforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.\nRefer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":sourceId","provisioning-policies",":usageType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source ID.","type":"text/plain"},"type":"any","value":"","key":"sourceId"},{"disabled":false,"description":{"content":"(Required) The type of ProvisioningPolicy usage.","type":"text/plain"},"type":"any","value":"","key":"usageType"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Provisioning Policy by UsageType' (put-provisioning-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Provisioning Policy by UsageType + + + +This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. +A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +
    Path Parameters
    Request Body required
      fields object[]
    + +The ProvisioningPolicyDto was successfully replaced. + +
    Schema
      fields object[]
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/put-saved-search.api.mdx b/products/idn/api/v3/put-saved-search.api.mdx new file mode 100644 index 000000000..b85ffd684 --- /dev/null +++ b/products/idn/api/v3/put-saved-search.api.mdx @@ -0,0 +1,141 @@ +--- +id: put-saved-search +sidebar_label: Updates an existing saved search + +hide_title: true +hide_table_of_contents: true +api: {"tags":["Saved Search"],"description":"Updates an existing saved search. \n\n>**NOTE: You cannot update the `owner` of the saved search.**\n","operationId":"putSavedSearch","parameters":[{"in":"path","name":"id","description":"ID of the requested document.","schema":{"type":"string"},"required":true,"example":"2c91808568c529c60168cca6f90c1313"}],"requestBody":{"description":"The saved search to persist.","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"id":{"description":"The saved search ID.\n","type":"string","example":"0de46054-fe90-434a-b84e-c6b3359d0c64"},"owner":{"description":"The owner of the saved search.\n","type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"description":"The id of the object.\n","type":"string","example":"2c91808568c529c60168cca6f90c1313"}},"required":["type","id"]}}},{"type":"object","properties":{"name":{"description":"The name of the saved search.\n","type":"string","example":"Disabled accounts"},"description":{"description":"The description of the saved search.\n","type":"string","nullable":true,"example":"Disabled accounts"}}},{"type":"object","properties":{"public":{"description":"Indicates if the saved search is public.\n","type":"boolean","default":false,"example":false},"created":{"description":"The date the saved search was initially created.\n","type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"},"modified":{"description":"The last date the saved search was modified.\n","type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"},"indices":{"description":"The names of the Elasticsearch indices in which to search.\n","type":"array","items":{"description":"Enum representing the currently supported indices.\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofiles","accountactivities","entitlements","events","identities","roles","*"],"example":"identities"},"example":["identities"]},"columns":{"description":"The columns to be returned (specifies the order in which they will be presented) for each document type.\n\nThe currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_.\n","type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"field":{"description":"The name of the field.\n","type":"string","example":"email"},"header":{"description":"The value of the header.\n","type":"string","example":"Work Email"}},"required":["field"]}},"example":{"identity":[{"field":"displayName","header":"Display Name"},{"field":"e-mail","header":"Work Email"}]}},"query":{"description":"The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL.\n","type":"string","example":"@accounts(disabled:true)"},"fields":{"description":"The fields to be searched against in a multi-field query.\n","type":"array","nullable":true,"items":{"type":"string"},"example":["disabled"]},"sort":{"description":"The fields to be used to sort the search results.\n","type":"array","items":{"type":"string"},"example":["displayName"]},"filters":{"nullable":true,"allOf":[{"type":"object","description":"The filters to be applied for each filtered field name.","example":{"attributes.cloudAuthoritativeSource":{"type":"EXISTS","exclude":true},"accessCount":{"type":"RANGE","range":{"lower":{"value":"3"}}},"created":{"type":"RANGE","range":{"lower":{"value":"2019-12-01","inclusive":true},"upper":{"value":"2020-01-01"}}},"source.name":{"type":"TERMS","terms":["HR Employees","Corporate Active Directory"],"exclude":true},"protected":{"type":"TERMS","terms":["true"]}}},{"type":"object","properties":{"type":{"description":"Enum representing the currently supported filter types.\nAdditional values may be added in the future without notice.","type":"string","enum":["EXISTS","RANGE","TERMS"],"example":"RANGE"},"range":{"type":"object","description":"The range of values to be filtered.","properties":{"lower":{"description":"The lower bound of the range.","type":"object","required":["value"],"properties":{"value":{"description":"The value of the range's endpoint.","type":"string","example":"1"},"inclusive":{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}},"upper":{"description":"The upper bound of the range.","type":"object","required":["value"],"properties":{"value":{"description":"The value of the range's endpoint.","type":"string","example":"1"},"inclusive":{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}}}},"terms":{"description":"The terms to be filtered.","type":"array","items":{"type":"string","example":"account_count"}},"exclude":{"description":"Indicates if the filter excludes results.","type":"boolean","default":false,"example":false}}}]}},"required":["indices","query"]}]}}},"required":true},"responses":{"200":{"description":"The persisted saved search.","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"id":{"description":"The saved search ID.\n","type":"string","example":"0de46054-fe90-434a-b84e-c6b3359d0c64"},"owner":{"description":"The owner of the saved search.\n","type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"description":"The id of the object.\n","type":"string","example":"2c91808568c529c60168cca6f90c1313"}},"required":["type","id"]}}},{"type":"object","properties":{"name":{"description":"The name of the saved search.\n","type":"string","example":"Disabled accounts"},"description":{"description":"The description of the saved search.\n","type":"string","nullable":true,"example":"Disabled accounts"}}},{"type":"object","properties":{"public":{"description":"Indicates if the saved search is public.\n","type":"boolean","default":false,"example":false},"created":{"description":"The date the saved search was initially created.\n","type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"},"modified":{"description":"The last date the saved search was modified.\n","type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"},"indices":{"description":"The names of the Elasticsearch indices in which to search.\n","type":"array","items":{"description":"Enum representing the currently supported indices.\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofiles","accountactivities","entitlements","events","identities","roles","*"],"example":"identities"},"example":["identities"]},"columns":{"description":"The columns to be returned (specifies the order in which they will be presented) for each document type.\n\nThe currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_.\n","type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"field":{"description":"The name of the field.\n","type":"string","example":"email"},"header":{"description":"The value of the header.\n","type":"string","example":"Work Email"}},"required":["field"]}},"example":{"identity":[{"field":"displayName","header":"Display Name"},{"field":"e-mail","header":"Work Email"}]}},"query":{"description":"The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL.\n","type":"string","example":"@accounts(disabled:true)"},"fields":{"description":"The fields to be searched against in a multi-field query.\n","type":"array","nullable":true,"items":{"type":"string"},"example":["disabled"]},"sort":{"description":"The fields to be used to sort the search results.\n","type":"array","items":{"type":"string"},"example":["displayName"]},"filters":{"nullable":true,"allOf":[{"type":"object","description":"The filters to be applied for each filtered field name.","example":{"attributes.cloudAuthoritativeSource":{"type":"EXISTS","exclude":true},"accessCount":{"type":"RANGE","range":{"lower":{"value":"3"}}},"created":{"type":"RANGE","range":{"lower":{"value":"2019-12-01","inclusive":true},"upper":{"value":"2020-01-01"}}},"source.name":{"type":"TERMS","terms":["HR Employees","Corporate Active Directory"],"exclude":true},"protected":{"type":"TERMS","terms":["true"]}}},{"type":"object","properties":{"type":{"description":"Enum representing the currently supported filter types.\nAdditional values may be added in the future without notice.","type":"string","enum":["EXISTS","RANGE","TERMS"],"example":"RANGE"},"range":{"type":"object","description":"The range of values to be filtered.","properties":{"lower":{"description":"The lower bound of the range.","type":"object","required":["value"],"properties":{"value":{"description":"The value of the range's endpoint.","type":"string","example":"1"},"inclusive":{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}},"upper":{"description":"The upper bound of the range.","type":"object","required":["value"],"properties":{"value":{"description":"The value of the range's endpoint.","type":"string","example":"1"},"inclusive":{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}}}},"terms":{"description":"The terms to be filtered.","type":"array","items":{"type":"string","example":"account_count"}},"exclude":{"description":"Indicates if the filter excludes results.","type":"boolean","default":false,"example":false}}}]}},"required":["indices","query"]}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/saved-searches/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"id":"0de46054-fe90-434a-b84e-c6b3359d0c64","owner":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313"},"name":"Disabled accounts","description":"Disabled accounts","public":false,"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"}]},"query":"@accounts(disabled:true)","fields":["disabled"],"sort":["displayName"],"filters":{"attributes.cloudAuthoritativeSource":{"type":"EXISTS","exclude":true},"accessCount":{"type":"RANGE","range":{"lower":{"value":"3"}}},"created":{"type":"RANGE","range":{"lower":{"value":"2019-12-01","inclusive":true},"upper":{"value":"2020-01-01"}}},"source.name":{"type":"TERMS","terms":["HR Employees","Corporate Active Directory"],"exclude":true},"protected":{"type":"TERMS","terms":["true"]}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Updates an existing saved search\n","description":{"content":"Updates an existing saved search. \n\n>**NOTE: You cannot update the `owner` of the saved search.**\n","type":"text/plain"},"url":{"path":["saved-searches",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the requested document.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "put api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Updates an existing saved search +' (put-saved-search)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Updates an existing saved search + + + + +Updates an existing saved search. + +>**NOTE: You cannot update the `owner` of the saved search.** + + +
    Path Parameters
    Request Body required
    + +The saved search to persist. + +
      owner object
      + +The owner of the saved search. + + +
      columns object
      + +The columns to be returned (specifies the order in which they will be presented) for each document type. + +The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. + + +
      items object
      filters object
      + +The filters to be applied for each filtered field name. + +
      range object
      + +The range of values to be filtered. + +
      lower object
      + +The lower bound of the range. + +
      upper object
      + +The upper bound of the range. + +
    + +The persisted saved search. + +
    Schema
      owner object
      + +The owner of the saved search. + + +
      columns object
      + +The columns to be returned (specifies the order in which they will be presented) for each document type. + +The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. + + +
      items object
      filters object
      + +The filters to be applied for each filtered field name. + +
      range object
      + +The range of values to be filtered. + +
      lower object
      + +The lower bound of the range. + +
      upper object
      + +The upper bound of the range. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/put-service-desk-integration.api.mdx b/products/idn/api/v3/put-service-desk-integration.api.mdx new file mode 100644 index 000000000..86f499974 --- /dev/null +++ b/products/idn/api/v3/put-service-desk-integration.api.mdx @@ -0,0 +1,147 @@ +--- +id: put-service-desk-integration +sidebar_label: Update a Service Desk integration +hide_title: true +hide_table_of_contents: true +api: {"tags":["Service Desk Integration"],"description":"Update an existing Service Desk integration by ID with updated value in JSON form as the request body. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","operationId":"putServiceDeskIntegration","parameters":[{"name":"id","in":"path","description":"ID of the Service Desk integration to update","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"anId"}}],"requestBody":{"description":"The specifics of the integration to update","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true},"modified":{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}},{"type":"object","description":"Specification of a Service Desk integration","required":["description","type","attributes"],"properties":{"description":{"description":"Description of the Service Desk integration","type":"string","example":"A very nice Service Desk integration"},"type":{"description":"Service Desk integration types\n\n- ServiceNowSDIM\n- ServiceNow\n","type":"string","default":"ServiceNowSDIM","example":"ServiceNowSDIM"},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the identity that is the owner of this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the identity","example":"MyName"}}},"clusterRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the source cluster for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"cluster":{"description":"ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)","type":"string","example":"xyzzy999","deprecated":true},"managedSources":{"description":"Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)","type":"array","items":{"type":"string"},"deprecated":true,"example":["2c9180835d191a86015d28455b4a2329","2c5680835d191a85765d28455b4a9823"]},"provisioningConfig":{"description":"The 'provisioningConfig' property specifies the configuration used to provision integrations.","type":"object","properties":{"universalManager":{"description":"Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.","type":"boolean","readOnly":true,"example":true},"managedResourceRefs":{"description":"References to sources for the Service Desk integration template. May only be specified if universalManager is false.","type":"array","items":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"properties":{"type":{"description":"The type of object being referenced","enum":["SOURCE"],"example":"SOURCE"},"id":{"description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the source","example":"My Source"}}},"example":[{"type":"SOURCE","id":"2c9180855d191c59015d291ceb051111","name":"My Source 1"},{"type":"SOURCE","id":"2c9180855d191c59015d291ceb052222","name":"My Source 2"}]},"planInitializerScript":{"description":"This is a reference to a plan initializer script.","type":"object","properties":{"source":{"description":"This is a Rule that allows provisioning instruction changes.","type":"string","example":"\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n"}}},"noProvisioningRequests":{"description":"Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.","type":"boolean","example":true},"provisioningRequestExpiration":{"description":"When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.","type":"integer","format":"int32","example":7}}},"attributes":{"description":"Attributes of the Service Desk integration. Validation constraints enforced by the implementation.","type":"object","additionalProperties":true,"example":{"property":"value","key":"value"}},"beforeProvisioningRule":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to beforeProvisioningRule for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["RULE"],"example":"RULE"},"id":{"description":"ID of the rule","example":"2c91808568c529c60168cca6f90c1333"},"name":{"description":"Human-readable display name of the rule","example":"Example Rule"}}}}}]}}},"required":true},"responses":{"200":{"description":"ServiceDeskIntegrationDto as updated","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true},"modified":{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}},{"type":"object","description":"Specification of a Service Desk integration","required":["description","type","attributes"],"properties":{"description":{"description":"Description of the Service Desk integration","type":"string","example":"A very nice Service Desk integration"},"type":{"description":"Service Desk integration types\n\n- ServiceNowSDIM\n- ServiceNow\n","type":"string","default":"ServiceNowSDIM","example":"ServiceNowSDIM"},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the identity that is the owner of this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the identity","example":"MyName"}}},"clusterRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to the source cluster for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"cluster":{"description":"ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)","type":"string","example":"xyzzy999","deprecated":true},"managedSources":{"description":"Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)","type":"array","items":{"type":"string"},"deprecated":true,"example":["2c9180835d191a86015d28455b4a2329","2c5680835d191a85765d28455b4a9823"]},"provisioningConfig":{"description":"The 'provisioningConfig' property specifies the configuration used to provision integrations.","type":"object","properties":{"universalManager":{"description":"Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.","type":"boolean","readOnly":true,"example":true},"managedResourceRefs":{"description":"References to sources for the Service Desk integration template. May only be specified if universalManager is false.","type":"array","items":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"properties":{"type":{"description":"The type of object being referenced","enum":["SOURCE"],"example":"SOURCE"},"id":{"description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313"},"name":{"description":"Human-readable display name of the source","example":"My Source"}}},"example":[{"type":"SOURCE","id":"2c9180855d191c59015d291ceb051111","name":"My Source 1"},{"type":"SOURCE","id":"2c9180855d191c59015d291ceb052222","name":"My Source 2"}]},"planInitializerScript":{"description":"This is a reference to a plan initializer script.","type":"object","properties":{"source":{"description":"This is a Rule that allows provisioning instruction changes.","type":"string","example":"\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n"}}},"noProvisioningRequests":{"description":"Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.","type":"boolean","example":true},"provisioningRequestExpiration":{"description":"When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.","type":"integer","format":"int32","example":7}}},"attributes":{"description":"Attributes of the Service Desk integration. Validation constraints enforced by the implementation.","type":"object","additionalProperties":true,"example":{"property":"value","key":"value"}},"beforeProvisioningRule":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"Reference to beforeProvisioningRule for this Service Desk integration","properties":{"type":{"description":"The type of object being referenced","enum":["RULE"],"example":"RULE"},"id":{"description":"ID of the rule","example":"2c91808568c529c60168cca6f90c1333"},"name":{"description":"Human-readable display name of the rule","example":"Example Rule"}}}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:service-desk-admin:manage","idn:service-desk-integration:manage"]}],"method":"put","path":"/service-desk-integrations/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"aName","description":"A very nice Service Desk integration","type":"ServiceNowSDIM","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":true},"clusterRef":{"type":true,"id":true,"name":true},"provisioningConfig":{"managedResourceRefs":[{"type":"SOURCE","id":"2c9180855d191c59015d291ceb051111","name":"My Source 1"},{"type":"SOURCE","id":"2c9180855d191c59015d291ceb052222","name":"My Source 2"}],"planInitializerScript":{"source":"\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n"},"noProvisioningRequests":true,"provisioningRequestExpiration":7},"attributes":{"property":"value","key":"value"},"beforeProvisioningRule":{"type":true,"id":true,"name":true}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Update a Service Desk integration","description":{"content":"Update an existing Service Desk integration by ID with updated value in JSON form as the request body. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","type":"text/plain"},"url":{"path":["service-desk-integrations",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the Service Desk integration to update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a Service Desk integration' (put-service-desk-integration)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a Service Desk integration + + + +Update an existing Service Desk integration by ID with updated value in JSON form as the request body. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +
    Path Parameters
    Request Body required
    + +The specifics of the integration to update + +
      ownerRef object
      + +Reference to the identity that is the owner of this Service Desk integration + +
      clusterRef object
      + +Reference to the source cluster for this Service Desk integration + +
      provisioningConfig object
      + +The 'provisioningConfig' property specifies the configuration used to provision integrations. + +
      managedResourceRefs object[]
      + +References to sources for the Service Desk integration template. May only be specified if universalManager is false. + +
      planInitializerScript object
      + +This is a reference to a plan initializer script. + +
      attributes object required
      + +Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + +
      beforeProvisioningRule object
      + +Reference to beforeProvisioningRule for this Service Desk integration + +
    + +ServiceDeskIntegrationDto as updated + +
    Schema
      ownerRef object
      + +Reference to the identity that is the owner of this Service Desk integration + +
      clusterRef object
      + +Reference to the source cluster for this Service Desk integration + +
      provisioningConfig object
      + +The 'provisioningConfig' property specifies the configuration used to provision integrations. + +
      managedResourceRefs object[]
      + +References to sources for the Service Desk integration template. May only be specified if universalManager is false. + +
      planInitializerScript object
      + +This is a reference to a plan initializer script. + +
      attributes object
      + +Attributes of the Service Desk integration. Validation constraints enforced by the implementation. + +
      beforeProvisioningRule object
      + +Reference to beforeProvisioningRule for this Service Desk integration + +
    \\\\r\\\\n\\\\r\\\\n\\\\r\\\\n Before Provisioning Rule which changes disables and enables to a modify.\\\\r\\\\n \\n\"\n },\n \"noProvisioningRequests\": true,\n \"provisioningRequestExpiration\": 7\n },\n \"attributes\": {\n \"property\": \"value\",\n \"key\": \"value\"\n },\n \"beforeProvisioningRule\": {\n \"type\": true,\n \"id\": true,\n \"name\": true\n }\n}"} language={"json"}>
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/put-source-schema.api.mdx b/products/idn/api/v3/put-source-schema.api.mdx new file mode 100644 index 000000000..64d7c09b3 --- /dev/null +++ b/products/idn/api/v3/put-source-schema.api.mdx @@ -0,0 +1,113 @@ +--- +id: put-source-schema +sidebar_label: Update Source Schema (Full) +hide_title: true +hide_table_of_contents: true +api: {"operationId":"putSourceSchema","tags":["Sources"],"description":"This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below.\n\n* id\n* name\n* created\n* modified\n\nAny attempt to modify these fields will result in an error response with a status code of 400.\n\n> `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error.\n","parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source id.","example":"2c9180835d191a86015d28455b4a2329"},{"in":"path","name":"schemaId","schema":{"type":"string"},"required":true,"description":"The Schema id.","example":"2c9180835d191a86015d28455b4a2329"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Schema.","example":"2c9180835d191a86015d28455b4a2329"},"name":{"type":"string","description":"The name of the Schema.","example":"account"},"nativeObjectType":{"type":"string","description":"The name of the object type on the native system that the schema represents.","example":"User"},"identityAttribute":{"type":"string","description":"The name of the attribute used to calculate the unique identifier for an object in the schema.","example":"sAMAccountName"},"displayAttribute":{"type":"string","description":"The name of the attribute used to calculate the display value for an object in the schema.","example":"distinguishedName"},"hierarchyAttribute":{"type":"string","description":"The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.","example":"memberOf"},"includePermissions":{"type":"boolean","description":"Flag indicating whether or not the include permissions with the object data when aggregating the schema.","example":false},"features":{"type":"array","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.","example":"AUTHENTICATE"},"description":"The features that the schema supports.","example":["PROVISIONING","NO_PERMISSIONS_PROVISIONING","GROUPS_HAVE_MEMBERS"]},"configuration":{"type":"object","description":"Holds any extra configuration data that the schema may require.","example":{"groupMemberAttribute":"member"}},"attributes":{"type":"array","description":"The attribute definitions which form the schema.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"sAMAccountName"},"type":{"description":"The type of the attribute.","example":"STRING","type":"string","enum":["STRING","LONG","INT","BOOLEAN"]},"schema":{"description":"A reference to the schema on the source to the attribute values map to.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"The object ID this reference applies to.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The human-readable display name of the object.","example":"group"}}},"description":{"type":"string","description":"A human-readable description of the attribute.","example":"SAM Account Name"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","example":false},"isEntitlement":{"type":"boolean","description":"Flag indicating whether or not the attribute is an entitlement.","example":false},"isGroup":{"type":"boolean","description":"Flag indicating whether or not the attribute represents a group.\nThis can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute..\n","example":false}}},"example":[{"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":{"type":"string","description":"The date the Schema was created.","format":"date-time","example":"2019-12-24T22:32:58.104Z"},"modified":{"type":"string","description":"The date the Schema was last modified.","format":"date-time","example":"2019-12-31T20:22:28.104Z"}}}}}},"responses":{"200":{"description":"The Schema was successfully replaced.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Schema.","example":"2c9180835d191a86015d28455b4a2329"},"name":{"type":"string","description":"The name of the Schema.","example":"account"},"nativeObjectType":{"type":"string","description":"The name of the object type on the native system that the schema represents.","example":"User"},"identityAttribute":{"type":"string","description":"The name of the attribute used to calculate the unique identifier for an object in the schema.","example":"sAMAccountName"},"displayAttribute":{"type":"string","description":"The name of the attribute used to calculate the display value for an object in the schema.","example":"distinguishedName"},"hierarchyAttribute":{"type":"string","description":"The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.","example":"memberOf"},"includePermissions":{"type":"boolean","description":"Flag indicating whether or not the include permissions with the object data when aggregating the schema.","example":false},"features":{"type":"array","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.","example":"AUTHENTICATE"},"description":"The features that the schema supports.","example":["PROVISIONING","NO_PERMISSIONS_PROVISIONING","GROUPS_HAVE_MEMBERS"]},"configuration":{"type":"object","description":"Holds any extra configuration data that the schema may require.","example":{"groupMemberAttribute":"member"}},"attributes":{"type":"array","description":"The attribute definitions which form the schema.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"sAMAccountName"},"type":{"description":"The type of the attribute.","example":"STRING","type":"string","enum":["STRING","LONG","INT","BOOLEAN"]},"schema":{"description":"A reference to the schema on the source to the attribute values map to.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"The object ID this reference applies to.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The human-readable display name of the object.","example":"group"}}},"description":{"type":"string","description":"A human-readable description of the attribute.","example":"SAM Account Name"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","example":false},"isEntitlement":{"type":"boolean","description":"Flag indicating whether or not the attribute is an entitlement.","example":false},"isGroup":{"type":"boolean","description":"Flag indicating whether or not the attribute represents a group.\nThis can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute..\n","example":false}}},"example":[{"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":{"type":"string","description":"The date the Schema was created.","format":"date-time","example":"2019-12-24T22:32:58.104Z"},"modified":{"type":"string","description":"The date the Schema was last modified.","format":"date-time","example":"2019-12-31T20:22:28.104Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/sources/{sourceId}/schemas/{schemaId}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"id":"2c9180835d191a86015d28455b4a2329","name":"account","nativeObjectType":"User","identityAttribute":"sAMAccountName","displayAttribute":"distinguishedName","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}],"created":"2019-12-24T22:32:58.104Z","modified":"2019-12-31T20:22:28.104Z"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Update Source Schema (Full)","description":{"content":"This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below.\n\n* id\n* name\n* created\n* modified\n\nAny attempt to modify these fields will result in an error response with a status code of 400.\n\n> `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error.\n","type":"text/plain"},"url":{"path":["sources",":sourceId","schemas",":schemaId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id.","type":"text/plain"},"type":"any","value":"","key":"sourceId"},{"disabled":false,"description":{"content":"(Required) The Schema id.","type":"text/plain"},"type":"any","value":"","key":"schemaId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "put api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Source Schema (Full)' (put-source-schema)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Source Schema (Full) + + + +This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. + +* id +* name +* created +* modified + +Any attempt to modify these fields will result in an error response with a status code of 400. + +> `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. + + +
    Path Parameters
    Request Body required
      attributes object[]
      + +The attribute definitions which form the schema. + +
      schema object
      + +A reference to the schema on the source to the attribute values map to. + +
    + +The Schema was successfully replaced. + +
    Schema
      attributes object[]
      + +The attribute definitions which form the schema. + +
      schema object
      + +A reference to the schema on the source to the attribute values map to. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/put-source.api.mdx b/products/idn/api/v3/put-source.api.mdx new file mode 100644 index 000000000..9b47730e3 --- /dev/null +++ b/products/idn/api/v3/put-source.api.mdx @@ -0,0 +1,182 @@ +--- +id: put-source +sidebar_label: Update Source (Full) +hide_title: true +hide_table_of_contents: true +api: {"operationId":"putSource","security":[{"oauth2":["idn:sources:manage"]}],"tags":["Sources"],"description":"This API updates a source in IdentityNow, using a full object representation. In other words, the existing Source\nconfiguration is completely replaced.\n\nSome fields are immutable and cannot be changed, such as:\n\n* id\n* type\n* authoritative\n* connector\n* connectorClass\n* passwordPolicies\n\nAttempts to modify these fields will result in a 400 error.\n\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.\n","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Source id","example":"2c9180835d191a86015d28455b4a2329"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"the id of the Source","example":"2c91808568c529c60168cca6f90c1324"},"name":{"type":"string","description":"Human-readable name of the source","example":"My Source"},"description":{"type":"string","description":"Human-readable description of the source","example":"This is the corporate directory."},"owner":{"description":"Reference to an owning Identity Object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity","example":"MyName"}}},"cluster":{"description":"Reference to the associated Cluster","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"type":"string","description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"accountCorrelationConfig":{"description":"Reference to an Account Correlation Config object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG"],"example":"ACCOUNT_CORRELATION_CONFIG"},"id":{"type":"string","description":"ID of the account correlation config","example":"2c9180855d191c59015d28583727245a"},"name":{"type":"string","description":"Human-readable display name of the account correlation config","example":"Directory [source-62867] Account Correlation"}}},"accountCorrelationRule":{"description":"Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"managerCorrelationMapping":{"description":"Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity","type":"object","properties":{"accountAttribute":{"type":"string","description":"Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.","example":"manager"},"identityAttribute":{"type":"string","description":"Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.","example":"manager"}}},"managerCorrelationRule":{"description":"Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"beforeProvisioningRule":{"description":"Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"schemas":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"ID of the schema","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the schema","example":"MySchema"}}},"description":"List of references to Schema objects","example":[{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232a","name":"account"},{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232b","name":"group"}]},"passwordPolicies":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["PASSWORD_POLICY"],"example":"PASSWORD_POLICY"},"id":{"type":"string","description":"ID of the policy","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the policy","example":"My Password Policy"}}},"description":"List of references to the associated PasswordPolicy objects.","example":[{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb053980","name":"Corporate Password Policy"},{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb057777","name":"Vendor Password Policy"}]},"features":{"type":"array","description":"Optional features that can be supported by a source.","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.","example":"AUTHENTICATE"},"example":["SYNC_PROVISIONING","MANAGER_LOOKUP","SEARCH","PROVISIONING","AUTHENTICATE","GROUP_PROVISIONING","PASSWORD"]},"type":{"type":"string","description":"Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ","example":"OpenLDAP - Direct"},"connector":{"type":"string","description":"Connector script name.","example":"active-directory"},"connectorClass":{"type":"string","description":"The fully qualified name of the Java class that implements the connector interface.","example":"sailpoint.connector.LDAPConnector"},"connectorAttributes":{"type":"object","description":"Connector specific configuration; will differ from type to type.","example":{"healthCheckTimeout":30,"authSearchAttributes":["cn","uid","mail"]}},"deleteThreshold":{"type":"integer","format":"int32","description":"Number from 0 to 100 that specifies when to skip the delete phase.","example":10},"authoritative":{"type":"boolean","description":"When true indicates the source is referenced by an IdentityProfile.","example":false},"managementWorkgroup":{"description":"Reference to Management Workgroup for this Source","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["GOVERNANCE_GROUP"],"example":"GOVERNANCE_GROUP"},"id":{"type":"string","description":"ID of the management workgroup","example":"2c91808568c529c60168cca6f90c2222"},"name":{"type":"string","description":"Human-readable display name of the management workgroup","example":"My Management Workgroup"}}},"healthy":{"type":"boolean","description":"When true indicates a healthy source","example":true},"status":{"type":"string","description":"A status identifier, giving specific information on why a source is healthy or not","example":"SOURCE_STATE_HEALTHY"},"since":{"type":"string","description":"Timestamp showing when a source health check was last performed","example":"2021-09-28T15:48:29.3801666300Z"},"connectorId":{"type":"string","description":"The id of connector","example":"active-directory"},"connectorName":{"type":"string","description":"The name of the connector that was chosen on source creation","example":"Active Directory"},"connectionType":{"type":"string","description":"The type of connection (direct or file)","example":"file"},"connectorImplementstionId":{"type":"string","description":"The connector implementstion id","example":"delimited-file"}},"required":["name","owner","connector"]}}}},"responses":{"200":{"description":"Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"the id of the Source","example":"2c91808568c529c60168cca6f90c1324"},"name":{"type":"string","description":"Human-readable name of the source","example":"My Source"},"description":{"type":"string","description":"Human-readable description of the source","example":"This is the corporate directory."},"owner":{"description":"Reference to an owning Identity Object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity","example":"MyName"}}},"cluster":{"description":"Reference to the associated Cluster","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"type":"string","description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"accountCorrelationConfig":{"description":"Reference to an Account Correlation Config object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG"],"example":"ACCOUNT_CORRELATION_CONFIG"},"id":{"type":"string","description":"ID of the account correlation config","example":"2c9180855d191c59015d28583727245a"},"name":{"type":"string","description":"Human-readable display name of the account correlation config","example":"Directory [source-62867] Account Correlation"}}},"accountCorrelationRule":{"description":"Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"managerCorrelationMapping":{"description":"Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity","type":"object","properties":{"accountAttribute":{"type":"string","description":"Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.","example":"manager"},"identityAttribute":{"type":"string","description":"Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.","example":"manager"}}},"managerCorrelationRule":{"description":"Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"beforeProvisioningRule":{"description":"Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"schemas":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"ID of the schema","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the schema","example":"MySchema"}}},"description":"List of references to Schema objects","example":[{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232a","name":"account"},{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232b","name":"group"}]},"passwordPolicies":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["PASSWORD_POLICY"],"example":"PASSWORD_POLICY"},"id":{"type":"string","description":"ID of the policy","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the policy","example":"My Password Policy"}}},"description":"List of references to the associated PasswordPolicy objects.","example":[{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb053980","name":"Corporate Password Policy"},{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb057777","name":"Vendor Password Policy"}]},"features":{"type":"array","description":"Optional features that can be supported by a source.","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.","example":"AUTHENTICATE"},"example":["SYNC_PROVISIONING","MANAGER_LOOKUP","SEARCH","PROVISIONING","AUTHENTICATE","GROUP_PROVISIONING","PASSWORD"]},"type":{"type":"string","description":"Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ","example":"OpenLDAP - Direct"},"connector":{"type":"string","description":"Connector script name.","example":"active-directory"},"connectorClass":{"type":"string","description":"The fully qualified name of the Java class that implements the connector interface.","example":"sailpoint.connector.LDAPConnector"},"connectorAttributes":{"type":"object","description":"Connector specific configuration; will differ from type to type.","example":{"healthCheckTimeout":30,"authSearchAttributes":["cn","uid","mail"]}},"deleteThreshold":{"type":"integer","format":"int32","description":"Number from 0 to 100 that specifies when to skip the delete phase.","example":10},"authoritative":{"type":"boolean","description":"When true indicates the source is referenced by an IdentityProfile.","example":false},"managementWorkgroup":{"description":"Reference to Management Workgroup for this Source","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["GOVERNANCE_GROUP"],"example":"GOVERNANCE_GROUP"},"id":{"type":"string","description":"ID of the management workgroup","example":"2c91808568c529c60168cca6f90c2222"},"name":{"type":"string","description":"Human-readable display name of the management workgroup","example":"My Management Workgroup"}}},"healthy":{"type":"boolean","description":"When true indicates a healthy source","example":true},"status":{"type":"string","description":"A status identifier, giving specific information on why a source is healthy or not","example":"SOURCE_STATE_HEALTHY"},"since":{"type":"string","description":"Timestamp showing when a source health check was last performed","example":"2021-09-28T15:48:29.3801666300Z"},"connectorId":{"type":"string","description":"The id of connector","example":"active-directory"},"connectorName":{"type":"string","description":"The name of the connector that was chosen on source creation","example":"Active Directory"},"connectionType":{"type":"string","description":"The type of connection (direct or file)","example":"file"},"connectorImplementstionId":{"type":"string","description":"The connector implementstion id","example":"delimited-file"}},"required":["name","owner","connector"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/sources/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"My Source","description":"This is the corporate directory.","owner":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"MyName"},"cluster":{"type":"CLUSTER","id":"2c9180866166b5b0016167c32ef31a66","name":"Corporate Cluster"},"accountCorrelationConfig":{"type":"ACCOUNT_CORRELATION_CONFIG","id":"2c9180855d191c59015d28583727245a","name":"Directory [source-62867] Account Correlation"},"accountCorrelationRule":{"type":"RULE","id":"2c918085708c274401708c2a8a760001","name":"Example Rule"},"managerCorrelationMapping":{"accountAttribute":"manager","identityAttribute":"manager"},"managerCorrelationRule":{"type":"RULE","id":"2c918085708c274401708c2a8a760001","name":"Example Rule"},"beforeProvisioningRule":{"type":"RULE","id":"2c918085708c274401708c2a8a760001","name":"Example Rule"},"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":["SYNC_PROVISIONING","MANAGER_LOOKUP","SEARCH","PROVISIONING","AUTHENTICATE","GROUP_PROVISIONING","PASSWORD"],"type":"OpenLDAP - Direct","connector":"active-directory","connectorClass":"sailpoint.connector.LDAPConnector","connectorAttributes":{"healthCheckTimeout":30,"authSearchAttributes":["cn","uid","mail"]},"deleteThreshold":10,"authoritative":false,"managementWorkgroup":{"type":"GOVERNANCE_GROUP","id":"2c91808568c529c60168cca6f90c2222","name":"My Management Workgroup"},"healthy":true,"status":"SOURCE_STATE_HEALTHY","since":"2021-09-28T15:48:29.3801666300Z","connectorId":"active-directory","connectorName":"Active Directory","connectionType":"file","connectorImplementstionId":"delimited-file"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Update Source (Full)","description":{"content":"This API updates a source in IdentityNow, using a full object representation. In other words, the existing Source\nconfiguration is completely replaced.\n\nSome fields are immutable and cannot be changed, such as:\n\n* id\n* type\n* authoritative\n* connector\n* connectorClass\n* passwordPolicies\n\nAttempts to modify these fields will result in a 400 error.\n\nA token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.\n","type":"text/plain"},"url":{"path":["sources",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Source (Full)' (put-source)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Source (Full) + + + +This API updates a source in IdentityNow, using a full object representation. In other words, the existing Source +configuration is completely replaced. + +Some fields are immutable and cannot be changed, such as: + +* id +* type +* authoritative +* connector +* connectorClass +* passwordPolicies + +Attempts to modify these fields will result in a 400 error. + +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + + +
    Path Parameters
    Request Body required
      owner object required
      + +Reference to an owning Identity Object + +
      cluster object
      + +Reference to the associated Cluster + +
      accountCorrelationConfig object
      + +Reference to an Account Correlation Config object + +
      accountCorrelationRule object
      + +Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used. + +
      managerCorrelationMapping object
      + +Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + +
      managerCorrelationRule object
      + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
      beforeProvisioningRule object
      + +Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + +
      schemas object[]
      + +List of references to Schema objects + +
      passwordPolicies object[]
      + +List of references to the associated PasswordPolicy objects. + +
      managementWorkgroup object
      + +Reference to Management Workgroup for this Source + +
    + +Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design. + +
    Schema
      owner object
      + +Reference to an owning Identity Object + +
      cluster object
      + +Reference to the associated Cluster + +
      accountCorrelationConfig object
      + +Reference to an Account Correlation Config object + +
      accountCorrelationRule object
      + +Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used. + +
      managerCorrelationMapping object
      + +Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + +
      managerCorrelationRule object
      + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
      beforeProvisioningRule object
      + +Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + +
      schemas object[]
      + +List of references to Schema objects + +
      passwordPolicies object[]
      + +List of references to the associated PasswordPolicy objects. + +
      managementWorkgroup object
      + +Reference to Management Workgroup for this Source + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/put-tagged-object.api.mdx b/products/idn/api/v3/put-tagged-object.api.mdx new file mode 100644 index 000000000..c53eab1c2 --- /dev/null +++ b/products/idn/api/v3/put-tagged-object.api.mdx @@ -0,0 +1,75 @@ +--- +id: put-tagged-object +sidebar_label: Update Tagged Object +hide_title: true +hide_table_of_contents: true +api: {"operationId":"putTaggedObject","security":[{"oauth2":["idn:tag:manage"]}],"tags":["Tagged Objects"],"description":"This updates a tagged object for the specified type.","parameters":[{"in":"path","name":"type","schema":{"type":"string","enum":["ROLE","IDENTITY","SOD_POLICY"]},"required":true,"description":"The type of tagged object to update.","example":"ROLE"},{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the object reference to update.","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"objectRef":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","nullable":true,"description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"tags":{"type":"array","items":{"type":"string"},"description":"Labels to be applied to an Object","example":["BU_FINANCE","PCI"]}}}}}},"responses":{"200":{"description":"Tagged object by type and ID.","content":{"application/json":{"schema":{"type":"object","properties":{"objectRef":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","nullable":true,"description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"tags":{"type":"array","items":{"type":"string"},"description":"Labels to be applied to an Object","example":["BU_FINANCE","PCI"]}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/tagged-objects/{type}/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"objectRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"},"tags":["BU_FINANCE","PCI"]},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Update Tagged Object","description":{"content":"This updates a tagged object for the specified type.","type":"text/plain"},"url":{"path":["tagged-objects",":type",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The type of tagged object to update.","type":"text/plain"},"type":"any","value":"","key":"type"},{"disabled":false,"description":{"content":"(Required) The ID of the object reference to update.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Tagged Object' (put-tagged-object)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Tagged Object + + + +This updates a tagged object for the specified type. + +
    Path Parameters
    Request Body required
      objectRef object
    + +Tagged object by type and ID. + +
    Schema
      objectRef object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/query-password-info.api.mdx b/products/idn/api/v3/query-password-info.api.mdx new file mode 100644 index 000000000..c46bb6db3 --- /dev/null +++ b/products/idn/api/v3/query-password-info.api.mdx @@ -0,0 +1,87 @@ +--- +id: query-password-info +sidebar_label: Query Password Info +hide_title: true +hide_table_of_contents: true +api: {"operationId":"queryPasswordInfo","tags":["Password Management"],"description":"This API is used to query password related information. \n\nA token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) \nis required to call this API. \"API authority\" refers to a token that only has the \"client_credentials\" \ngrant type, and therefore no user context. A [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) \nor a token generated with the [authorization_code](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) \ngrant type will **NOT** work on this endpoint, and a `403 Forbidden` response \nwill be returned.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userName":{"type":"string","description":"The login name of the user","example":"Abby.Smith"},"sourceName":{"type":"string","description":"The display name of the source","example":"My-AD"}}}}}},"responses":{"200":{"description":"Reference to the password info.","content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","description":"Identity ID","example":"2c918085744fec4301746f9a5bce4605"},"sourceId":{"type":"string","description":"source ID","example":"2c918083746f642c01746f990884012a"},"publicKeyId":{"type":"string","description":"public key ID","example":"N2M1OTJiMGEtMDJlZS00ZWU3LTkyYTEtNjA5YmI5NWE3ZWVh"},"publicKey":{"type":"string","description":"User's public key with Base64 encoding","example":"MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuGFkWi2J75TztpbaPKd36bJnIB3J8gZ6UcoS9oSDYsqBzPpTsfZXYaEf4Y4BKGgJIXmE/lwhwuj7mU1itdZ2qTSNFtnXA8Fn75c3UUkk+h+wdZbkuSmqlsJo3R1OnJkwkJggcAy9Jvk9jlcrNLWorpQ1w9raUvxtvfgkSdq153KxotenQ1HciSyZ0nA/Kw0UaucLnho8xdRowZs11afXGXA9IT9H6D8T6zUdtSxm0nAyH+mluma5LdTfaM50W3l/L8q56Vrqmx2pZIiwdx/0+g3Y++jV70zom0ZBkC1MmSoLMrQYG5OICNjr72f78B2PaGXfarQHqARLjKpMVt9YIQIDAQAB"},"accounts":{"type":"array","description":"Account info related to queried identity and source","items":{"type":"object","properties":{"accountId":{"type":"string","description":"Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350","example":"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com"},"accountName":{"type":"string","description":"Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008","example":"Abby.Smith"}}}},"policies":{"type":"array","description":"Password constraints","items":{"type":"string"},"example":["passwordRepeatedChar is 3","passwordMinAlpha is 1","passwordMinLength is 5","passwordMinNumeric is 1"]}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/query-password-info","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"userName":"Abby.Smith","sourceName":"My-AD"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Query Password Info","description":{"content":"This API is used to query password related information. \n\nA token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) \nis required to call this API. \"API authority\" refers to a token that only has the \"client_credentials\" \ngrant type, and therefore no user context. A [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) \nor a token generated with the [authorization_code](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) \ngrant type will **NOT** work on this endpoint, and a `403 Forbidden` response \nwill be returned.\n","type":"text/plain"},"url":{"path":["query-password-info"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Query Password Info' (query-password-info)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Query Password Info + + + +This API is used to query password related information. + +A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) +is required to call this API. "API authority" refers to a token that only has the "client_credentials" +grant type, and therefore no user context. A [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) +or a token generated with the [authorization_code](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) +grant type will **NOT** work on this endpoint, and a `403 Forbidden` response +will be returned. + + +
    Request Body required
    + +Reference to the password info. + +
    Schema
      accounts object[]
      + +Account info related to queried identity and source + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/reassign-identity-certifications.api.mdx b/products/idn/api/v3/reassign-identity-certifications.api.mdx new file mode 100644 index 000000000..5167a2e13 --- /dev/null +++ b/products/idn/api/v3/reassign-identity-certifications.api.mdx @@ -0,0 +1,87 @@ +--- +id: reassign-identity-certifications +sidebar_label: Reassign Identities or Items +hide_title: true +hide_table_of_contents: true +api: {"operationId":"reassignIdentityCertifications","tags":["Certifications"],"description":"This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity campaign certification ID","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reassign":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of item or identity being reassigned.","example":"ef38f94347e94562b5bb8424a56397d8"},"type":{"type":"string","description":"The type of item or identity being reassigned.","enum":["TARGET_SUMMARY","ITEM","IDENTITY_SUMMARY"],"example":"ITEM"}},"required":["id","type"]}},"reassignTo":{"type":"string","description":"The ID of the identity to which the certification is reassigned","example":"ef38f94347e94562b5bb8424a56397d8"},"reason":{"type":"string","description":"The reason comment for why the reassign was made","example":"reassigned for some reason"}},"required":["reassign","reassignTo","reason"]}}}},"responses":{"200":{"description":"An identity campaign certification details after completing the reassignment.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"example":"2c9180835d2e5168015d32f890ca1581","type":"string","description":"id of the certification"},"name":{"example":"Source Owner Access Review for Employees [source]","type":"string","description":"name of the certification"},"campaign":{"type":"object","required":["id","name","type","campaignType","description","correlatedStatus","mandatoryCommentRequirement"],"properties":{"id":{"type":"string","description":"The unique ID of the campaign.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the campaign.","example":"Campaign Name"},"type":{"type":"string","enum":["CAMPAIGN"],"description":"The type of object that is being referenced.","example":"CAMPAIGN"},"campaignType":{"type":"string","enum":["MANAGER","SOURCE_OWNER","SEARCH"],"description":"The type of the campaign.","example":"MANAGER"},"description":{"type":"string","description":"The description of the campaign set by the admin who created it.","nullable":true,"example":"A description of the campaign"},"correlatedStatus":{"description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"},"mandatoryCommentRequirement":{"type":"string","description":"Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.","enum":["ALL_DECISIONS","REVOKE_ONLY_DECISIONS","NO_DECISIONS"],"example":"NO_DECISIONS"}}},"completed":{"type":"boolean","description":"Have all decisions been made?","example":true},"identitiesCompleted":{"type":"integer","description":"The number of identities for whom all decisions have been made and are complete.","example":5,"format":"int32"},"identitiesTotal":{"type":"integer","description":"The total number of identities in the Certification, both complete and incomplete.","example":10,"format":"int32"},"created":{"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"created date"},"modified":{"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"modified date"},"decisionsMade":{"type":"integer","description":"The number of approve/revoke/acknowledge decisions that have been made.","example":20,"format":"int32"},"decisionsTotal":{"type":"integer","description":"The total number of approve/revoke/acknowledge decisions.","example":40,"format":"int32"},"due":{"type":"string","format":"date-time","description":"The due date of the certification.","example":"2018-10-19T13:49:37.385Z"},"signed":{"type":"string","format":"date-time","nullable":true,"description":"The date the reviewer signed off on the Certification.","example":"2018-10-19T13:49:37.385Z"},"reviewer":{"type":"object","properties":{"id":{"type":"string","description":"The id of the reviewer.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the reviewer.","example":"Reviewer Name"},"email":{"type":"string","description":"The email of the reviewing identity.","example":"reviewer@test.com"},"type":{"type":"string","enum":["IDENTITY"],"description":"The type of the reviewing identity.","example":"IDENTITY"},"created":{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The created date of the reviewing identity."},"modified":{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The modified date of the reviewing identity."}}},"reassignment":{"type":"object","nullable":true,"properties":{"from":{"type":"object","properties":{"id":{"type":"string","description":"The id of the certification.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the certification.","example":"Certification Name"},"type":{"type":"string","enum":["CERTIFICATION"],"example":"CERTIFICATION"},"reviewer":{"type":"object","properties":{"id":{"type":"string","description":"The id of the reviewer.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the reviewer.","example":"Reviewer Name"},"email":{"type":"string","description":"The email of the reviewing identity.","example":"reviewer@test.com"},"type":{"type":"string","enum":["IDENTITY"],"description":"The type of the reviewing identity.","example":"IDENTITY"},"created":{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The created date of the reviewing identity."},"modified":{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The modified date of the reviewing identity."}}}}},"comment":{"type":"string","description":"The comment entered when the Certification was reassigned","example":"Reassigned for a reason"}}},"hasErrors":{"description":"Identifies if the certification has an error","type":"boolean","example":false},"errorMessage":{"description":"Description of the certification error","nullable":true,"type":"string","example":"The certification has an error"},"phase":{"type":"string","description":"The current phase of the campaign.\n* `STAGED`: The campaign is waiting to be activated.\n* `ACTIVE`: The campaign is active.\n* `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete.\n","enum":["STAGED","ACTIVE","SIGNED"],"example":"ACTIVE"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/certifications/{id}/reassign","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"reassign":[{"id":"ef38f94347e94562b5bb8424a56397d8","type":"ITEM"}],"reassignTo":"ef38f94347e94562b5bb8424a56397d8","reason":"reassigned for some reason"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Reassign Identities or Items","description":{"content":"This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.","type":"text/plain"},"url":{"path":["certifications",":id","reassign"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identity campaign certification ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Reassign Identities or Items' (reassign-identity-certifications)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Reassign Identities or Items + + + +This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +
    Path Parameters
    Request Body required
      reassign object[] required
    + +An identity campaign certification details after completing the reassignment. + +
    Schema
      campaign object
      reviewer object
      reassignment object
      from object
      reviewer object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/reject-access-request.api.mdx b/products/idn/api/v3/reject-access-request.api.mdx new file mode 100644 index 000000000..e398648bb --- /dev/null +++ b/products/idn/api/v3/reject-access-request.api.mdx @@ -0,0 +1,91 @@ +--- +id: reject-access-request +sidebar_label: Rejects an access request approval. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"rejectAccessRequest","tags":["Access Request Approvals"],"description":"This endpoint rejects an access request approval. Only the owner of the approval and admin users are allowed to perform this action.","parameters":[{"in":"path","name":"approvalId","schema":{"type":"string"},"required":true,"description":"The id of the approval.","example":"2c91808b7294bea301729568c68c002e"}],"requestBody":{"description":"Reviewer's comment.","required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"comment":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat"},"author":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the author","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"}}},"created":{"type":"string","format":"date-time","description":"Date and time comment was created","example":"2017-07-11T18:45:37.098Z"}}}}}},"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/access-request-approvals/{approvalId}/reject","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"comment":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat","author":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Adam Kennedy"},"created":"2017-07-11T18:45:37.098Z"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Rejects an access request approval.","description":{"content":"This endpoint rejects an access request approval. Only the owner of the approval and admin users are allowed to perform this action.","type":"text/plain"},"url":{"path":["access-request-approvals",":approvalId","reject"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The id of the approval.","type":"text/plain"},"type":"any","value":"","key":"approvalId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Rejects an access request approval.' (reject-access-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Rejects an access request approval. + + + +This endpoint rejects an access request approval. Only the owner of the approval and admin users are allowed to perform this action. + +
    Path Parameters
    Request Body
    + +Reviewer's comment. + +
      author object
    + +Accepted - Returned if the request was successfully accepted into the system. + +
    Schema
    • object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/reject-approval-item.api.mdx b/products/idn/api/v3/reject-approval-item.api.mdx new file mode 100644 index 000000000..40e4cf21f --- /dev/null +++ b/products/idn/api/v3/reject-approval-item.api.mdx @@ -0,0 +1,87 @@ +--- +id: reject-approval-item +sidebar_label: Reject an Approval Item +hide_title: true +hide_table_of_contents: true +api: {"operationId":"rejectApprovalItem","tags":["Work Items"],"description":"This API rejects an Approval Item. Either an admin, or the owning/current user must make this request.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the work item","example":"ef38f94347e94562b5bb8424a56397d8"},{"in":"path","name":"approvalItemId","schema":{"type":"string"},"required":true,"description":"The ID of the approval item.","example":"1211bcaa32112bcef6122adb21cef1ac"}],"responses":{"200":{"description":"A work items details object.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the work item","example":"2c9180835d2e5168015d32f890ca1581"},"requesterId":{"type":"string","description":"ID of the requester","example":"2c9180835d2e5168015d32f890ca1581"},"requesterDisplayName":{"type":"string","description":"The displayname of the requester","example":"John Smith"},"ownerId":{"type":"string","description":"The ID of the owner","example":"2c9180835d2e5168015d32f890ca1581"},"ownerName":{"type":"string","description":"The name of the owner","example":"Jason Smith"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z","description":"Time when the work item was created"},"modified":{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"Time when the work item was last updated"},"description":{"type":"string","description":"The description of the work item","example":"Create account on source 'AD'"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"},"type":{"type":"string","enum":["UNKNOWN","GENERIC","CERTIFICATION","REMEDIATION","DELEGATION","APPROVAL","VIOLATIONREVIEW","FORM","POLICYVIOLATION","CHALLENGE","IMPACTANALYSIS","SIGNOFF","EVENT","MANUALACTION","TEST"],"example":"GENERIC","description":"The type of the work item"},"remediationItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the certification","example":"2c9180835d2e5168015d32f890ca1581"},"targetId":{"type":"string","description":"The ID of the certification target","example":"2c9180835d2e5168015d32f890ca1581"},"targetName":{"type":"string","description":"The name of the certification target","example":"john.smith"},"targetDisplayName":{"type":"string","description":"The display name of the certification target","example":"emailAddress"},"applicationName":{"type":"string","description":"The name of the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute being certified","example":"phoneNumber"},"attributeOperation":{"type":"string","description":"The operation of the certification on the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute being certified","example":"512-555-1212"},"nativeIdentity":{"type":"string","description":"The native identity of the target","example":"jason.smith2"}}},"approvalItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the approval item","example":"2c9180835d2e5168015d32f890ca1581"},"account":{"type":"string","description":"The account referenced by the approval item","example":"john.smith"},"application":{"type":"string","description":"The name the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute","example":"emailAddress"},"attributeOperation":{"type":"string","description":"The operation of the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute","example":"a@b.com"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"}}},"name":{"type":"string","description":"The work item name","example":"Account Create"},"completed":{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z","description":"The time at which the work item completed"},"numItems":{"type":"integer","format":"int32","description":"The number of items in the work item","example":19},"form":{"type":"object","properties":{"id":{"type":"string","description":"ID of the form","example":"2c9180835d2e5168015d32f890ca1581"},"name":{"type":"string","description":"Name of the form","example":"AccountSelection Form"},"title":{"type":"string","description":"The form title","example":"Account Selection for John.Doe"},"subtitle":{"type":"string","description":"The form subtitle.","example":"Please select from the following"},"targetUser":{"type":"string","description":"The name of the user that should be shown this form","example":"Jane.Doe"},"sections":{"type":"object","allOf":[{"type":"object","properties":{"name":{"type":"string","description":"Name of the FormItem","example":"Field1"}}},{"type":"object","properties":{"label":{"type":"string","description":"Label of the section","example":"Section 1"},"formItems":{"type":"array","items":{"type":"object"},"description":"List of FormItems. FormItems can be SectionDetails and/or FieldDetails","example":[]}}}]}}},"errors":{"type":"array","items":{"type":"string"},"example":["The work item ID that was specified was not found."],"description":"An array of errors that ocurred during the work item"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/work-items/{id}/reject/{approvalItemId}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Reject an Approval Item","description":{"content":"This API rejects an Approval Item. Either an admin, or the owning/current user must make this request.","type":"text/plain"},"url":{"path":["work-items",":id","reject",":approvalItemId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the work item","type":"text/plain"},"type":"any","value":"","key":"id"},{"disabled":false,"description":{"content":"(Required) The ID of the approval item.","type":"text/plain"},"type":"any","value":"","key":"approvalItemId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Reject an Approval Item' (reject-approval-item)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Reject an Approval Item + + + +This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. + +
    Path Parameters
    + +A work items details object. + +
    Schema
      remediationItems object
      approvalItems object
      form object
      sections object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/reject-approval-items-in-bulk.api.mdx b/products/idn/api/v3/reject-approval-items-in-bulk.api.mdx new file mode 100644 index 000000000..aa85c33ef --- /dev/null +++ b/products/idn/api/v3/reject-approval-items-in-bulk.api.mdx @@ -0,0 +1,87 @@ +--- +id: reject-approval-items-in-bulk +sidebar_label: Bulk reject Approval Items +hide_title: true +hide_table_of_contents: true +api: {"operationId":"rejectApprovalItemsInBulk","tags":["Work Items"],"description":"This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the work item","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"A work items details object.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the work item","example":"2c9180835d2e5168015d32f890ca1581"},"requesterId":{"type":"string","description":"ID of the requester","example":"2c9180835d2e5168015d32f890ca1581"},"requesterDisplayName":{"type":"string","description":"The displayname of the requester","example":"John Smith"},"ownerId":{"type":"string","description":"The ID of the owner","example":"2c9180835d2e5168015d32f890ca1581"},"ownerName":{"type":"string","description":"The name of the owner","example":"Jason Smith"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z","description":"Time when the work item was created"},"modified":{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"Time when the work item was last updated"},"description":{"type":"string","description":"The description of the work item","example":"Create account on source 'AD'"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"},"type":{"type":"string","enum":["UNKNOWN","GENERIC","CERTIFICATION","REMEDIATION","DELEGATION","APPROVAL","VIOLATIONREVIEW","FORM","POLICYVIOLATION","CHALLENGE","IMPACTANALYSIS","SIGNOFF","EVENT","MANUALACTION","TEST"],"example":"GENERIC","description":"The type of the work item"},"remediationItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the certification","example":"2c9180835d2e5168015d32f890ca1581"},"targetId":{"type":"string","description":"The ID of the certification target","example":"2c9180835d2e5168015d32f890ca1581"},"targetName":{"type":"string","description":"The name of the certification target","example":"john.smith"},"targetDisplayName":{"type":"string","description":"The display name of the certification target","example":"emailAddress"},"applicationName":{"type":"string","description":"The name of the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute being certified","example":"phoneNumber"},"attributeOperation":{"type":"string","description":"The operation of the certification on the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute being certified","example":"512-555-1212"},"nativeIdentity":{"type":"string","description":"The native identity of the target","example":"jason.smith2"}}},"approvalItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the approval item","example":"2c9180835d2e5168015d32f890ca1581"},"account":{"type":"string","description":"The account referenced by the approval item","example":"john.smith"},"application":{"type":"string","description":"The name the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute","example":"emailAddress"},"attributeOperation":{"type":"string","description":"The operation of the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute","example":"a@b.com"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"}}},"name":{"type":"string","description":"The work item name","example":"Account Create"},"completed":{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z","description":"The time at which the work item completed"},"numItems":{"type":"integer","format":"int32","description":"The number of items in the work item","example":19},"form":{"type":"object","properties":{"id":{"type":"string","description":"ID of the form","example":"2c9180835d2e5168015d32f890ca1581"},"name":{"type":"string","description":"Name of the form","example":"AccountSelection Form"},"title":{"type":"string","description":"The form title","example":"Account Selection for John.Doe"},"subtitle":{"type":"string","description":"The form subtitle.","example":"Please select from the following"},"targetUser":{"type":"string","description":"The name of the user that should be shown this form","example":"Jane.Doe"},"sections":{"type":"object","allOf":[{"type":"object","properties":{"name":{"type":"string","description":"Name of the FormItem","example":"Field1"}}},{"type":"object","properties":{"label":{"type":"string","description":"Label of the section","example":"Section 1"},"formItems":{"type":"array","items":{"type":"object"},"description":"List of FormItems. FormItems can be SectionDetails and/or FieldDetails","example":[]}}}]}}},"errors":{"type":"array","items":{"type":"string"},"example":["The work item ID that was specified was not found."],"description":"An array of errors that ocurred during the work item"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/work-items/bulk-reject/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Bulk reject Approval Items","description":{"content":"This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request.","type":"text/plain"},"url":{"path":["work-items","bulk-reject",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the work item","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Bulk reject Approval Items' (reject-approval-items-in-bulk)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Bulk reject Approval Items + + + +This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. + +
    Path Parameters
    + +A work items details object. + +
    Schema
      remediationItems object
      approvalItems object
      form object
      sections object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/reject-non-employee-request.api.mdx b/products/idn/api/v3/reject-non-employee-request.api.mdx new file mode 100644 index 000000000..68fc8c9e6 --- /dev/null +++ b/products/idn/api/v3/reject-non-employee-request.api.mdx @@ -0,0 +1,79 @@ +--- +id: reject-non-employee-request +sidebar_label: Reject a Non-Employee Request +hide_title: true +hide_table_of_contents: true +api: {"operationId":"rejectNonEmployeeRequest","security":[{"oauth2":[]}],"tags":["Non-Employee Lifecycle Management"],"description":"This endpoint will reject an approval item request and notify user. The current user must be the requested approver.","parameters":[{"in":"path","name":"id","description":"Non-Employee approval item id (UUID)","required":true,"schema":{"type":"string"},"example":"e136567de87e4d029e60b3c3c55db56d"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"comment":{"type":"string","description":"Comment on the approval item.","maxLength":4000,"example":"approved"}},"required":["comment"]}}}},"responses":{"200":{"description":"Non-Employee approval item object.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee approval item id","example":"2c1e388b-1e55-4b0a-ab5c-897f1204159c"},"approver":{"description":"Reference to the associated Identity","type":"object","properties":{"type":{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}},"accountName":{"type":"string","description":"Requested identity account name","example":"test.account"},"approvalStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status","example":"APPROVED"},"approvalOrder":{"type":"number","description":"Approval order","example":1,"format":"float"},"comment":{"type":"string","description":"comment of approver","example":"I approve"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}},{"type":"object","properties":{"nonEmployeeRequest":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee request id.","example":"ac110005-7156-1150-8171-5b292e3e0084"},"requester":{"type":"object","properties":{"type":{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group"},"id":{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}},"example":{"type":"IDENTITY","id":"2c9180866166b5b0016167c32ef31a66","name":"William Smith"}}}}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/non-employee-approvals/{id}/reject","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"comment":"approved"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Reject a Non-Employee Request","description":{"content":"This endpoint will reject an approval item request and notify user. The current user must be the requested approver.","type":"text/plain"},"url":{"path":["non-employee-approvals",":id","reject"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Non-Employee approval item id (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Reject a Non-Employee Request' (reject-non-employee-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Reject a Non-Employee Request + + + +This endpoint will reject an approval item request and notify user. The current user must be the requested approver. + +
    Path Parameters
    Request Body required
    + +Non-Employee approval item object. + +
    Schema
      approver object
      + +Reference to the associated Identity + +
      nonEmployeeRequest object
      requester object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/reload-account.api.mdx b/products/idn/api/v3/reload-account.api.mdx new file mode 100644 index 000000000..3d3dd1ce9 --- /dev/null +++ b/products/idn/api/v3/reload-account.api.mdx @@ -0,0 +1,88 @@ +--- +id: reload-account +sidebar_label: Reload Account +hide_title: true +hide_table_of_contents: true +api: {"operationId":"reloadAccount","tags":["Accounts"],"description":"This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. \nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:accounts-state:manage"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The account id","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"202":{"description":"Async task details","content":{"application/json":{"schema":{"description":"Accounts async response containing details on started async process","required":["id"],"type":"object","properties":{"id":{"description":"id of the task","type":"string","example":"2c91808474683da6017468693c260195"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/accounts/{id}/reload","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Reload Account","description":{"content":"This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. \nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts",":id","reload"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The account id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Reload Account' (reload-account)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Reload Account + + + +This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. +A token with ORG_ADMIN authority is required to call this API. + +
    Path Parameters
    + +Async task details + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/requestable-objects.tag.mdx b/products/idn/api/v3/requestable-objects.tag.mdx new file mode 100644 index 000000000..0c25d589e --- /dev/null +++ b/products/idn/api/v3/requestable-objects.tag.mdx @@ -0,0 +1,23 @@ +--- +id: requestable-objects +title: "Requestable Objects" +description: "Requestable Objects" +custom_edit_url: null +--- + + + +Use this API to implement requestable object functionality. +With this functionality in place, administrators can determine which access items can be requested with the [Access Request APIs](https://developer.sailpoint.com/idn/api/v3/access-requests), along with their statuses. +This can be helpful for administrators who are implementing and customizing access request functionality as a way of checking which items are requestable as they are created, assigned, and made available. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/roles.tag.mdx b/products/idn/api/v3/roles.tag.mdx new file mode 100644 index 000000000..02d805dc7 --- /dev/null +++ b/products/idn/api/v3/roles.tag.mdx @@ -0,0 +1,57 @@ +--- +id: roles +title: "Roles" +description: "Roles" +custom_edit_url: null +--- + + + +Use this API to implement and customize role functionality. +With this functionality in place, administrators can create roles and configure them for use throughout IdentityNow. +IdentityNow can use established criteria to automatically assign the roles to qualified users. This enables users to get all the access they need quickly and securely and administrators to spend their time on other tasks. + +Entitlements represent the most granular level of access in IdentityNow. +Access profiles represent the next level and often group entitlements. +Roles represent the broadest level of access and often group access profiles. + +For example, an Active Directory source in IdentityNow can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +An administrator can then create an even broader set of access in the form of a role grouping the 'AD Developers' access profile with another profile, 'GitHub Developers,' grouping entitlements for the GitHub source. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +When users need both the 'AD Developers' access profile and the 'GitHub Developers' access profile, they can request access to the role grouping both. + +Roles often represent positions within organizations. +For example, an organization's accountant can access all the tools the organization's accountants need with the 'Accountant' role. +If the accountant switches to engineering, a qualified member of the organization can quickly revoke the accountant's 'Accountant' access and grant access to the 'Engineer' role instead, granting access to all the tools the organization's engineers need. + +In IdentityNow, adminstrators can use the Access drop-down menu and select Roles to view, configure, and delete existing roles, as well as create new ones. +Administrators can enable and disable the role, and they can also make the following configurations: + +- Manage Access: Manage the role's access by adding or removing access profiles. + +- Define Assignment: Define the criteria IdentityNow uses to assign the role to identities. +Use the first option, 'Standard Criteria,' to provide specific criteria for assignment like specific account attributes, entitlements, or identity attributes. +Use the second, 'Identity List,' to specify the identities for assignment. + +- Access Requests: Configure roles to be requestable and establish an approval process for any requests that the role be granted or revoked. +Do not configure a role to be requestable without establishing a secure access request approval process for that role first. + +Refer to [Working with Roles](https://documentation.sailpoint.com/saas/help/provisioning/roles.html) for more information about roles. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/saved-search.tag.mdx b/products/idn/api/v3/saved-search.tag.mdx new file mode 100644 index 000000000..99203ec13 --- /dev/null +++ b/products/idn/api/v3/saved-search.tag.mdx @@ -0,0 +1,30 @@ +--- +id: saved-search +title: "Saved Search" +description: "Saved Search" +custom_edit_url: null +--- + + + +Use this API to implement saved search functionality. +With saved search functionality in place, users can save search queries and then view those saved searches, as well as rerun them. + +Search queries in IdentityNow can grow very long and specific, which can make reconstructing them difficult or tedious, so it can be especially helpful to save search queries. +It also opens the possibility to configure IdentityNow to run the saved queries on a schedule, which is essential to detecting user information and access changes throughout an organization's tenant and across all its sources. +Refer to [Scheduled Search](https://developer.sailpoint.com/idn/api/v3/scheduled-search) for more information about running saved searches on a schedule. + +In IdentityNow, users can save searches under a name, and then they can access that saved search and run it again when they want. + +Refer to [Managing Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html) for more information about saving searches and using them. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/scheduled-search.tag.mdx b/products/idn/api/v3/scheduled-search.tag.mdx new file mode 100644 index 000000000..6f38b362f --- /dev/null +++ b/products/idn/api/v3/scheduled-search.tag.mdx @@ -0,0 +1,46 @@ +--- +id: scheduled-search +title: "Scheduled Search" +description: "Scheduled Search" +custom_edit_url: null +--- + + + +Use this API to implement scheduled search functionality. +With scheduled search functionality in place, users can run saved search queries on their tenants on a schedule, and IdentityNow emails them the search results. +Users can also share these search results with other users by email by adding those users as subscribers, or those users can subscribe themselves. + +One of the greatest benefits of saving searches is the ability to run those searches on a schedule. +This is essential for organizations to constantly detect any changes to user information or access throughout their tenants and across all their sources. +For example, the manager Amanda Ross can schedule a saved search "manager.name:amanda.ross AND attributes.location:austin" on a schedule to regularly stay aware of changes with the Austin employees reporting to her. +IdentityNow emails her the search results when the search runs, so she can work on other tasks instead of actively running this search. + +In IdentityNow, scheduling a search involves a subscription. +Users can create a subscription for a saved search and schedule it to run daily, weekly, or monthly (you can only use one schedule option at a time). +The user can add other identities as subscribers so when the scheduled search runs, the subscribers and the user all receive emails. + +By default, subscriptions exclude detailed results from the emails, for security purposes. +Including detailed results about user access in an email may expose sensitive information. +However, the subscription creator can choose to include the information in the emails. + +By default, IdentityNow sends emails to the subscribers even when the searches do not return new results. +However, the subscription creator can choose to suppress these empty emails. + +Users can also subscribe to saved searches that already have existing subscriptions so they receive emails when the searches run. +A saved search can have up to 10 subscriptions configured at a time. + +The subscription creator can enable, disable, or delete the subscription. + +Refer to [Subscribing to Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html#subscribing-to-saved-searches) for more information about scheduling searches and subscribing to them. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/search-aggregate.api.mdx b/products/idn/api/v3/search-aggregate.api.mdx new file mode 100644 index 000000000..37d8718cd --- /dev/null +++ b/products/idn/api/v3/search-aggregate.api.mdx @@ -0,0 +1,195 @@ +--- +id: search-aggregate +sidebar_label: Perform a Search Query Aggregation +hide_title: true +hide_table_of_contents: true +api: {"tags":["Search"],"description":"Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. ","operationId":"searchAggregate","parameters":[{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"indices":{"description":"The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched.","externalDocs":{"description":"Learn more about search indices here.","url":"https://documentation.sailpoint.com/saas/help/search/searchable-fields.html"},"type":"array","items":{"description":"Enum representing the currently supported indices.\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofiles","accountactivities","entitlements","events","identities","roles","*"],"example":"identities"},"example":["identities"]},"queryType":{"description":"The type of query to use. By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body.\nTo use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly.\nAdditional values may be added in the future without notice.","type":"string","enum":["DSL","SAILPOINT","TYPEAHEAD"],"default":"SAILPOINT","example":"SAILPOINT"},"queryVersion":{"allOf":[{"description":"The current Elasticserver version.","type":"string","default":"5.2","example":"5.2"},{"type":"string","description":"The version of the query object.\nThis version number will map to the version of Elasticsearch for the query strings and objects being used."}]},"query":{"type":"object","description":"Query parameters used to construct an Elasticsearch query object.","properties":{"query":{"description":"The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.","type":"string","example":"name:a*"},"fields":{"description":"The fields to which the specified query will be applied. The available fields are dependent on the indice(s) being searched on. Please refer to the response schema of this API for a list of available fields.","type":"array","items":{"type":"string"},"example":["name"]},"timeZone":{"description":"The time zone to be applied to any range query related to dates.","type":"string","example":"America/Chicago"},"innerHit":{"description":"The innerHit query object returns a flattened list of results for the specified nested type.","type":"object","required":["query","type"],"properties":{"query":{"description":"The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.","type":"string","example":"source.name:\\\"Active Directory\\\""},"type":{"description":"The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document \"nested\" within another document. For example, an identity can have nested documents for access, accounts, and apps.","type":"string","example":"access"}}}}},"queryDsl":{"description":"The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax.","type":"object","example":{"match":{"name":"john.doe"}}},"typeAheadQuery":{"type":"object","description":"Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing \"Jo\" results in top hits matching \"Jo.\" Typing \"Job\" results in top hits matching \"Job.\" ","required":["query","field"],"properties":{"query":{"description":"The type ahead query string used to construct a phrase prefix match query.","type":"string","example":"Work"},"field":{"description":"The field on which to perform the type ahead search.","type":"string","example":"source.name"},"nestedType":{"description":"The nested type.","type":"string","example":"access"},"maxExpansions":{"description":"The number of suffixes the last term will be expanded into.\nInfluences the performance of the query and the number results returned.\nValid values: 1 to 1000.","type":"integer","format":"int32","minimum":1,"maximum":1000,"default":10,"example":10}}},"includeNested":{"description":"Indicates whether nested objects from returned search results should be included.","type":"boolean","default":true,"example":true},"queryResultFilter":{"type":"object","description":"Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents.","properties":{"includes":{"description":"The list of field names to include in the result documents.","type":"array","items":{"type":"string"},"example":["name","displayName"]},"excludes":{"description":"The list of field names to exclude from the result documents.","type":"array","items":{"type":"string"},"example":["stacktrace"]}}},"aggregationType":{"description":"Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["DSL","SAILPOINT"],"default":"DSL","example":"DSL"},"aggregationsVersion":{"allOf":[{"description":"The current Elasticserver version.","type":"string","default":"5.2","example":"5.2"},{"type":"string","description":"The version of the language being used for aggregation queries.\nThis version number will map to the version of Elasticsearch for the aggregation query object."}]},"aggregationsDsl":{"description":"The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax.","type":"object","example":{}},"aggregations":{"description":"The aggregation’s specifications, such as the groupings and calculations to be performed.\n","allOf":[{"type":"object","properties":{"nested":{"type":"object","description":"The nested aggregation object.","required":["name","type"],"properties":{"name":{"description":"The name of the nested aggregate to be included in the result.","type":"string","example":"id"},"type":{"description":"The type of the nested object.","type":"string","example":"access"}}},"metric":{"type":"object","description":"The calculation done on the results of the query","required":["name","field"],"properties":{"name":{"description":"The name of the metric aggregate to be included in the result.\nIf the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results.","type":"string","example":"Access Name Count"},"type":{"description":"Enum representing the currently supported metric aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["COUNT","UNIQUE_COUNT","AVG","SUM","MEDIAN","MIN","MAX"],"default":"UNIQUE_COUNT","example":"COUNT"},"field":{"description":"The field the calculation is performed on.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"@access.name"}}},"filter":{"type":"object","description":"An additional filter to constrain the results of the search query.","required":["name","field","value"],"properties":{"name":{"description":"The name of the filter aggregate to be included in the result.","type":"string","example":"Entitlements"},"type":{"description":"Enum representing the currently supported filter aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERM"],"default":"TERM","example":"TERM"},"field":{"description":"The search field to apply the filter to.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"access.type"},"value":{"description":"The value to filter on.","type":"string","example":"ENTITLEMENT"}}},"bucket":{"type":"object","description":"The bucket to group the results of the aggregation query by.","required":["name","field"],"properties":{"name":{"description":"The name of the bucket aggregate to be included in the result.","type":"string","example":"Identity Locations"},"type":{"description":"Enum representing the currently supported bucket aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERMS"],"default":"TERMS","example":"TERMS"},"field":{"description":"The field to bucket on.\nPrefix the field name with '@' to reference a nested object.","type":"string","example":"attributes.city"},"size":{"description":"Maximum number of buckets to include.","type":"integer","format":"int32","example":100},"minDocCount":{"description":"Minimum number of documents a bucket should have.","type":"integer","format":"int32","example":2}}}}},{"type":"object","properties":{"subAggregation":{"description":"Aggregation to be performed on the result of the parent bucket aggregation.","allOf":[{"type":"object","properties":{"nested":{"type":"object","description":"The nested aggregation object.","required":["name","type"],"properties":{"name":{"description":"The name of the nested aggregate to be included in the result.","type":"string","example":"id"},"type":{"description":"The type of the nested object.","type":"string","example":"access"}}},"metric":{"type":"object","description":"The calculation done on the results of the query","required":["name","field"],"properties":{"name":{"description":"The name of the metric aggregate to be included in the result.\nIf the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results.","type":"string","example":"Access Name Count"},"type":{"description":"Enum representing the currently supported metric aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["COUNT","UNIQUE_COUNT","AVG","SUM","MEDIAN","MIN","MAX"],"default":"UNIQUE_COUNT","example":"COUNT"},"field":{"description":"The field the calculation is performed on.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"@access.name"}}},"filter":{"type":"object","description":"An additional filter to constrain the results of the search query.","required":["name","field","value"],"properties":{"name":{"description":"The name of the filter aggregate to be included in the result.","type":"string","example":"Entitlements"},"type":{"description":"Enum representing the currently supported filter aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERM"],"default":"TERM","example":"TERM"},"field":{"description":"The search field to apply the filter to.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"access.type"},"value":{"description":"The value to filter on.","type":"string","example":"ENTITLEMENT"}}},"bucket":{"type":"object","description":"The bucket to group the results of the aggregation query by.","required":["name","field"],"properties":{"name":{"description":"The name of the bucket aggregate to be included in the result.","type":"string","example":"Identity Locations"},"type":{"description":"Enum representing the currently supported bucket aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERMS"],"default":"TERMS","example":"TERMS"},"field":{"description":"The field to bucket on.\nPrefix the field name with '@' to reference a nested object.","type":"string","example":"attributes.city"},"size":{"description":"Maximum number of buckets to include.","type":"integer","format":"int32","example":100},"minDocCount":{"description":"Minimum number of documents a bucket should have.","type":"integer","format":"int32","example":2}}}}},{"type":"object","properties":{"subAggregation":{"type":"object","properties":{"nested":{"type":"object","description":"The nested aggregation object.","required":["name","type"],"properties":{"name":{"description":"The name of the nested aggregate to be included in the result.","type":"string","example":"id"},"type":{"description":"The type of the nested object.","type":"string","example":"access"}}},"metric":{"type":"object","description":"The calculation done on the results of the query","required":["name","field"],"properties":{"name":{"description":"The name of the metric aggregate to be included in the result.\nIf the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results.","type":"string","example":"Access Name Count"},"type":{"description":"Enum representing the currently supported metric aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["COUNT","UNIQUE_COUNT","AVG","SUM","MEDIAN","MIN","MAX"],"default":"UNIQUE_COUNT","example":"COUNT"},"field":{"description":"The field the calculation is performed on.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"@access.name"}}},"filter":{"type":"object","description":"An additional filter to constrain the results of the search query.","required":["name","field","value"],"properties":{"name":{"description":"The name of the filter aggregate to be included in the result.","type":"string","example":"Entitlements"},"type":{"description":"Enum representing the currently supported filter aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERM"],"default":"TERM","example":"TERM"},"field":{"description":"The search field to apply the filter to.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"access.type"},"value":{"description":"The value to filter on.","type":"string","example":"ENTITLEMENT"}}},"bucket":{"type":"object","description":"The bucket to group the results of the aggregation query by.","required":["name","field"],"properties":{"name":{"description":"The name of the bucket aggregate to be included in the result.","type":"string","example":"Identity Locations"},"type":{"description":"Enum representing the currently supported bucket aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERMS"],"default":"TERMS","example":"TERMS"},"field":{"description":"The field to bucket on.\nPrefix the field name with '@' to reference a nested object.","type":"string","example":"attributes.city"},"size":{"description":"Maximum number of buckets to include.","type":"integer","format":"int32","example":100},"minDocCount":{"description":"Minimum number of documents a bucket should have.","type":"integer","format":"int32","example":2}}}},"description":"Aggregation to be performed on the result of the parent bucket aggregation."}}}]}}}]},"sort":{"description":"The fields to be used to sort the search results. Use + or - to specify the sort direction.","type":"array","items":{"type":"string","example":["displayName","+id"]}},"searchAfter":{"description":"Used to begin the search window at the values specified.\nThis parameter consists of the last values of the sorted fields in the current record set.\nThis is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value.\nIt is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging.\nFor example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example [\"displayName\", \"id\"]. \nIf the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is \"John Doe\", then using that displayName and ID will start a new search after this identity.\nThe searchAfter value will look like [\"John Doe\",\"2c91808375d8e80a0175e1f88a575221\"]","type":"array","items":{"type":"string","example":["John Doe","2c91808375d8e80a0175e1f88a575221"]}},"filters":{"description":"The filters to be applied for each filtered field name.","type":"object","additionalProperties":{"type":"object","properties":{"type":{"description":"Enum representing the currently supported filter types.\nAdditional values may be added in the future without notice.","type":"string","enum":["EXISTS","RANGE","TERMS"],"example":"RANGE"},"range":{"type":"object","description":"The range of values to be filtered.","properties":{"lower":{"description":"The lower bound of the range.","type":"object","required":["value"],"properties":{"value":{"description":"The value of the range's endpoint.","type":"string","example":"1"},"inclusive":{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}},"upper":{"description":"The upper bound of the range.","type":"object","required":["value"],"properties":{"value":{"description":"The value of the range's endpoint.","type":"string","example":"1"},"inclusive":{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}}}},"terms":{"description":"The terms to be filtered.","type":"array","items":{"type":"string","example":"account_count"}},"exclude":{"description":"Indicates if the filter excludes results.","type":"boolean","default":false,"example":false}}},"example":{}}}},"examples":{"metricAggregation":{"summary":"MetricAggregation","value":{"indices":["aggregations"],"aggregationType":"SAILPOINT","aggregations":{"metric":{"name":"How Many Locations","type":"UNIQUE_COUNT","field":"attributes.city"}}}},"metricAggregation-dsl":{"summary":"MetricAggregation using DSL","value":{"indices":["aggregations"],"aggregationType":"DSL","aggregationsDsl":{"How Many Locations":{"cardinality":{"field":"attributes.city.exact"}}}}},"bucketAggregation":{"summary":"BucketAggregation","value":{"indices":["aggregations"],"aggregationType":"SAILPOINT","aggregations":{"bucket":{"name":"Identity Locations","type":"TERMS","field":"attributes.city"}}}},"bucketAggregation-dsl":{"summary":"BucketAggregation using DSL","value":{"indices":["aggregations"],"aggregationType":"DSL","aggregationsDsl":{"Identity Locations":{"terms":{"field":"attributes.city.exact"}}}}},"nestedAggregation-bucketAggregation":{"summary":"NestedAggregation with BucketAggregation","value":{"indices":["aggregations"],"aggregationType":"SAILPOINT","aggregations":{"nested":{"name":"Access","field":"access","type":"TERMS"},"bucket":{"name":"Access Source Name","type":"TERMS","field":"access.source.name"}}}},"nestedAggregation-bucketAggregation-dsl":{"summary":"NestedAggregation with BucketAggregation using DSL","value":{"indices":["aggregations"],"aggregationType":"DSL","aggregationsDsl":{"access":{"nested":{"path":"access"},"aggs":{"Access Source Name":{"terms":{"field":"access.source.name.exact"}}}}}}},"nestedAggregation-filterAggregation-bucketAggregation":{"summary":"NestedAggregation with FilterAggregation and BucketAggregation","value":{"indices":["aggregations"],"aggregationType":"SAILPOINT","aggregations":{"nested":{"name":"Access","field":"access","type":"TERMS"},"filter":{"name":"Entitlements","field":"access.type","value":"ENTITLEMENT"},"bucket":{"name":"Access Name","type":"TERMS","field":"access.name"}}}},"nestedAggregation-filterAggregation-bucketAggregation-dsl":{"summary":"NestedAggregation with FilterAggregation and BucketAggregation using DSL","value":{"indices":["aggregations"],"aggregationType":"DSL","aggregationsDsl":{"access":{"nested":{"path":"access"},"aggs":{"Entitlements":{"filter":{"term":{"access.type":"ENTITLEMENT"}},"aggs":{"Access Name":{"terms":{"field":"access.name.exact"}}}}}}}}},"bucketAggregation-subAggregation":{"summary":"BucketAggregation with SubAggregation","value":{"indices":["aggregations"],"aggregationType":"SAILPOINT","aggregations":{"bucket":{"name":"Identity Department","type":"TERMS","field":"attributes.department"},"subAggregation":{"bucket":{"name":"Identity Locations","type":"TERMS","field":"attributes.city"}}}}},"bucketAggregation-subAggregation-dsl":{"summary":"BucketAggregation with SubAggregation using DSL","value":{"indices":["aggregations"],"aggregationType":"DSL","aggregationsDsl":{"Identity Department":{"terms":{"field":"attributes.department.exact"},"aggs":{"Identity Locations":{"terms":{"field":"attributes.city.exact"}}}}}}}}}},"required":true},"responses":{"200":{"description":"Aggregation results.","content":{"application/json":{"schema":{"type":"object","properties":{"aggregations":{"type":"object","description":"The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run.\n\nSee Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information.\n","example":{"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":{"description":"The results of the aggregation search query.\n","type":"array","items":{"discriminator":{"propertyName":"_type","mapping":{"accessprofile":{"description":"This is more of a complete representation of an access profile. ","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the access item","example":"The admin role"},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"enabled":{"type":"boolean","example":true},"requestable":{"type":"boolean","example":true,"description":"Indicates if the access can be requested"},"requestCommentsRequired":{"type":"boolean","description":"Indicates if comments are required when requesting access","example":false},"owner":{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}}]},{"type":"object","properties":{"email":{"type":"string","example":"john.doe@sailpoint.com","description":"The email of the identity"}}}]}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"entitlements":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"A description of the entitlement","example":"The admin privilege"},"attribute":{"type":"string","description":"The name of the entitlement attribute","example":"admin"},"value":{"type":"string","description":"The value of the entitlement","example":"true"}}}]}},"entitlementCount":{"type":"integer","example":5},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},"accountactivity":{"description":"AccountActivity","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"type":"object","properties":{"action":{"type":"string","description":"The type of action that this activity performed","externalDocs":{"description":"Learn more about account activity action types","url":"https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data"},"example":"Identity Refresh."},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"stage":{"type":"string","description":"The current stage of the activity","example":"Completed"},"origin":{"type":"string","nullable":true,"example":null},"status":{"type":"string","description":"the current status of the activity","example":"Complete"},"requester":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"recipient":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"trackingNumber":{"type":"string","example":"61aad0c9e8134eca89e76a35e0cabe3f"},"errors":{"type":"array","items":{"type":"string"},"nullable":true,"example":null},"warnings":{"type":"array","items":{"type":"string"},"nullable":true,"example":null},"approvals":{"type":"array","items":{"type":"object","properties":{"comments":{"type":"array","items":{"type":"object","properties":{"comment":{"type":"string","description":"The comment text","example":"This request was autoapproved by our automated ETS subscriber."},"commenter":{"type":"string","description":"The name of the commenter","example":"Automated AR Approval"},"date":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}}}},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"result":{"type":"string","description":"The result of the approval","example":"Finished"},"type":{"type":"string","nullable":true,"example":null}}}},"originalRequests":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","description":"the account id","example":"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com"},"attributeRequests":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name","example":"groups"},"op":{"type":"string","description":"The operation to perform","example":"Add"},"value":{"type":"string","description":"The value of the attribute","example":"3203537556531076"}}}},"op":{"type":"string","description":"the operation that was used","example":"add"},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]}}}},"expansionItems":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","description":"The ID of the account","example":"2c91808981f58ea601821c3e93482e6f"},"cause":{"type":"string","example":"Role"},"name":{"type":"string","description":"The name of the item","example":"smartsheet-role"},"attributeRequests":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name","example":"groups"},"op":{"type":"string","description":"The operation to perform","example":"Add"},"value":{"type":"string","description":"The value of the attribute","example":"3203537556531076"}}}},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]}}}},"accountRequests":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","description":"Unique ID of the account","example":"John.Doe"},"attributeRequests":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name","example":"groups"},"op":{"type":"string","description":"The operation to perform","example":"Add"},"value":{"type":"string","description":"The value of the attribute","example":"3203537556531076"}}}},"op":{"type":"string","example":"Modify","description":"The operation that was performed"},"provisioningTarget":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"result":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","example":"[ConnectorError] [\n {\n \"code\": \"unrecognized_keys\",\n \"keys\": [\n \"groups\"\n ],\n \"path\": [],\n \"message\": \"Unrecognized key(s) in object: 'groups'\"\n }\n] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e)"}},"status":{"type":"string","description":"The status of the account request","example":"failed"},"ticketId":{"type":"string","nullable":true,"example":null}}},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]}}}},"sources":{"type":"string","example":"smartsheet-test, airtable-v4, IdentityNow"}}}]},"account":{"description":"Account","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"accountId":{"type":"string","description":"The ID of the account","example":"john.doe"},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"disabled":{"type":"boolean","description":"Indicates if the account is disabled","example":false},"locked":{"type":"boolean","description":"Indicates if the account is locked","example":false},"privileged":{"type":"boolean","example":false},"manuallyCorrelated":{"type":"boolean","description":"Indicates if the account has been manually correlated to an identity","example":false},"passwordLastSet":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"entitlementAttributes":{"type":"object","nullable":true,"description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"moderator":true,"admin":true,"trust_level":"4"}},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}}}]},{"type":"object","properties":{"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"attributes":{"type":"object","description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"firstName":"John","lastName":"Doe","displayName":"John.Doe"}},"identity":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"access":{"type":"array","items":{"description":"EntitlementReference","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"attribute":{"type":"string","example":"memberOf"},"value":{"type":"string","example":"CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"},"standalone":{"type":"boolean","example":false}}}]}},"entitlementCount":{"type":"integer","description":"The number of entitlements assigned to the account","format":"int32","example":2},"uncorrelated":{"type":"boolean","description":"Indicates if the account is not correlated to an identity","example":false},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},"aggregation":{"description":"Aggregation","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"type":"object","properties":{"status":{"type":"string","example":"Success"},"duration":{"type":"integer","format":"int32","example":20},"avgDuration":{"type":"integer","format":"int32","example":20},"changedAccounts":{"type":"integer","format":"int32","example":1},"nextScheduled":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"startTime":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"sourceOwner":{"type":"string","description":"John Doe"}}}]},"entitlement":{"description":"Entitlement","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"A description of the entitlement","example":"The admin privilege"},"attribute":{"type":"string","description":"The name of the entitlement attribute","example":"admin"},"value":{"type":"string","description":"The value of the entitlement","example":"true"}}}]},{"type":"object","properties":{"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"displayName":{"type":"string","description":"The display name of the entitlement","example":"Admin"},"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"identityCount":{"type":"integer","format":"int32","example":3},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},"event":{"description":"Event","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"type":"object","properties":{"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"action":{"type":"string","description":"The action that was performed","example":"update"},"type":{"type":"string","description":"The type of event","example":"SYSTEM_CONFIG"},"actor":{"type":"object","properties":{"name":{"type":"string","example":"John Doe","description":"the actor or target name"},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}},"target":{"type":"object","properties":{"name":{"type":"string","example":"John Doe","description":"the actor or target name"},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}},"stack":{"type":"string","example":"tpe"},"trackingNumber":{"type":"string","example":"63f891e0735f4cc8bf1968144a1e7440"},"ipAddress":{"type":"string","example":"52.52.97.85"},"details":{"type":"string","example":"73b65dfbed1842548c207432a18c84b0"},"attributes":{"type":"object","additionalProperties":true,"example":{"pod":"stg03-useast1","org":"acme","sourceName":"SailPoint"}},"objects":{"type":"array","items":{"type":"string","example":"AUTHENTICATION"}},"operation":{"type":"string","example":"REQUEST"},"status":{"type":"string","example":"PASSED"},"technicalName":{"type":"string","example":"AUTHENTICATION_REQUEST_PASSED"}}}]},"identity":{"description":"Identity","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the identity","example":"Carol"},"lastName":{"type":"string","description":"The last name of the identity","example":"Adams"},"displayName":{"type":"string","example":"Carol.Adams","description":"The display name of the identity"},"email":{"type":"string","description":"The identity's primary email address","example":"Carol.Adams@sailpointdemo.com"},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"phone":{"type":"string","description":"The phone number of the identity","example":"+1 440-527-3672"},"inactive":{"type":"boolean","description":"Indicates if the identity is inactive","example":false},"protected":{"type":"boolean","example":false},"status":{"type":"string","description":"The identity's status in SailPoint","example":"UNREGISTERED"},"employeeNumber":{"type":"string","example":"1a2a3d4e"},"manager":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}],"nullable":true},"isManager":{"type":"boolean","description":"Indicates if this identity is a manager of other identities","example":false},"identityProfile":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"attributes":{"type":"object","description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"country":"US","firstname":"Carol","cloudStatus":"UNREGISTERED"}},"processingState":{"type":"string","nullable":true,"example":null},"processingDetails":{"nullable":true,"type":"object","properties":{"date":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"stage":{"type":"string","example":"In Process"},"retryCount":{"type":"integer","example":0,"format":"int32"},"stackTrace":{"type":"string","example":""},"message":{"type":"string","example":""}}},"accounts":{"type":"array","description":"List of accounts associated with the identity","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"accountId":{"type":"string","description":"The ID of the account","example":"john.doe"},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"disabled":{"type":"boolean","description":"Indicates if the account is disabled","example":false},"locked":{"type":"boolean","description":"Indicates if the account is locked","example":false},"privileged":{"type":"boolean","example":false},"manuallyCorrelated":{"type":"boolean","description":"Indicates if the account has been manually correlated to an identity","example":false},"passwordLastSet":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"entitlementAttributes":{"type":"object","nullable":true,"description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"moderator":true,"admin":true,"trust_level":"4"}},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}}}]}},"accountCount":{"type":"integer","description":"Number of accounts associated with the identity","format":"int32","example":3},"apps":{"type":"array","description":"The list of applications the identity has access to","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"account":{"type":"object","properties":{"id":{"type":"string","description":"The SailPoint generated unique ID","example":"2c9180837dfe6949017e21f3d8cd6d49"},"accountId":{"type":"string","description":"The account ID generated by the source","example":"CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"}}}}}]}},"appCount":{"type":"integer","format":"int32","description":"The number of applications the identity has access to","example":2},"access":{"type":"array","description":"The list of access items assigned to the identity","items":{"discriminator":{"propertyName":"type","mapping":{"ACCESS_PROFILE":{"description":"This is a summary representation of an access profile.","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"revocable":{"type":"boolean","example":true}}}]},"ENTITLEMENT":{"description":"EntitlementReference","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"attribute":{"type":"string","example":"memberOf"},"value":{"type":"string","example":"CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"},"standalone":{"type":"boolean","example":false}}}]},"ROLE":{"description":"Role","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"disabled":{"type":"boolean"},"revocable":{"type":"boolean"}}}]}}},"oneOf":[{"description":"This is a summary representation of an access profile.","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"revocable":{"type":"boolean","example":true}}}]},{"description":"EntitlementReference","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"attribute":{"type":"string","example":"memberOf"},"value":{"type":"string","example":"CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"},"standalone":{"type":"boolean","example":false}}}]},{"description":"Role","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"disabled":{"type":"boolean"},"revocable":{"type":"boolean"}}}]}]}},"accessCount":{"type":"integer","format":"int32","description":"The number of access items assigned to the identity","example":5},"accessProfileCount":{"type":"integer","description":"The number of access profiles assigned to the identity","example":1},"entitlementCount":{"type":"integer","description":"The number of entitlements assigned to the identity","example":10},"roleCount":{"type":"integer","description":"The number of roles assigned to the identity","example":1},"owns":{"type":"object","properties":{"sources":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"entitlements":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"accessProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"apps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"governanceGroups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"fallbackApprover":{"type":"boolean","example":false}}},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},"role":{"description":"Role","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the access item","example":"The admin role"},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"enabled":{"type":"boolean","example":true},"requestable":{"type":"boolean","example":true,"description":"Indicates if the access can be requested"},"requestCommentsRequired":{"type":"boolean","description":"Indicates if comments are required when requesting access","example":false},"owner":{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}}]},{"type":"object","properties":{"email":{"type":"string","example":"john.doe@sailpoint.com","description":"The email of the identity"}}}]}}}]},{"type":"object","properties":{"accessProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"accessProfileCount":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]}}},"oneOf":[{"description":"This is more of a complete representation of an access profile. ","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the access item","example":"The admin role"},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"enabled":{"type":"boolean","example":true},"requestable":{"type":"boolean","example":true,"description":"Indicates if the access can be requested"},"requestCommentsRequired":{"type":"boolean","description":"Indicates if comments are required when requesting access","example":false},"owner":{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}}]},{"type":"object","properties":{"email":{"type":"string","example":"john.doe@sailpoint.com","description":"The email of the identity"}}}]}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"entitlements":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"A description of the entitlement","example":"The admin privilege"},"attribute":{"type":"string","description":"The name of the entitlement attribute","example":"admin"},"value":{"type":"string","description":"The value of the entitlement","example":"true"}}}]}},"entitlementCount":{"type":"integer","example":5},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},{"description":"AccountActivity","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"type":"object","properties":{"action":{"type":"string","description":"The type of action that this activity performed","externalDocs":{"description":"Learn more about account activity action types","url":"https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data"},"example":"Identity Refresh."},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"stage":{"type":"string","description":"The current stage of the activity","example":"Completed"},"origin":{"type":"string","nullable":true,"example":null},"status":{"type":"string","description":"the current status of the activity","example":"Complete"},"requester":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"recipient":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"trackingNumber":{"type":"string","example":"61aad0c9e8134eca89e76a35e0cabe3f"},"errors":{"type":"array","items":{"type":"string"},"nullable":true,"example":null},"warnings":{"type":"array","items":{"type":"string"},"nullable":true,"example":null},"approvals":{"type":"array","items":{"type":"object","properties":{"comments":{"type":"array","items":{"type":"object","properties":{"comment":{"type":"string","description":"The comment text","example":"This request was autoapproved by our automated ETS subscriber."},"commenter":{"type":"string","description":"The name of the commenter","example":"Automated AR Approval"},"date":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}}}},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"result":{"type":"string","description":"The result of the approval","example":"Finished"},"type":{"type":"string","nullable":true,"example":null}}}},"originalRequests":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","description":"the account id","example":"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com"},"attributeRequests":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name","example":"groups"},"op":{"type":"string","description":"The operation to perform","example":"Add"},"value":{"type":"string","description":"The value of the attribute","example":"3203537556531076"}}}},"op":{"type":"string","description":"the operation that was used","example":"add"},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]}}}},"expansionItems":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","description":"The ID of the account","example":"2c91808981f58ea601821c3e93482e6f"},"cause":{"type":"string","example":"Role"},"name":{"type":"string","description":"The name of the item","example":"smartsheet-role"},"attributeRequests":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name","example":"groups"},"op":{"type":"string","description":"The operation to perform","example":"Add"},"value":{"type":"string","description":"The value of the attribute","example":"3203537556531076"}}}},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]}}}},"accountRequests":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","description":"Unique ID of the account","example":"John.Doe"},"attributeRequests":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name","example":"groups"},"op":{"type":"string","description":"The operation to perform","example":"Add"},"value":{"type":"string","description":"The value of the attribute","example":"3203537556531076"}}}},"op":{"type":"string","example":"Modify","description":"The operation that was performed"},"provisioningTarget":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"result":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","example":"[ConnectorError] [\n {\n \"code\": \"unrecognized_keys\",\n \"keys\": [\n \"groups\"\n ],\n \"path\": [],\n \"message\": \"Unrecognized key(s) in object: 'groups'\"\n }\n] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e)"}},"status":{"type":"string","description":"The status of the account request","example":"failed"},"ticketId":{"type":"string","nullable":true,"example":null}}},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]}}}},"sources":{"type":"string","example":"smartsheet-test, airtable-v4, IdentityNow"}}}]},{"description":"Account","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"accountId":{"type":"string","description":"The ID of the account","example":"john.doe"},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"disabled":{"type":"boolean","description":"Indicates if the account is disabled","example":false},"locked":{"type":"boolean","description":"Indicates if the account is locked","example":false},"privileged":{"type":"boolean","example":false},"manuallyCorrelated":{"type":"boolean","description":"Indicates if the account has been manually correlated to an identity","example":false},"passwordLastSet":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"entitlementAttributes":{"type":"object","nullable":true,"description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"moderator":true,"admin":true,"trust_level":"4"}},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}}}]},{"type":"object","properties":{"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"attributes":{"type":"object","description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"firstName":"John","lastName":"Doe","displayName":"John.Doe"}},"identity":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"access":{"type":"array","items":{"description":"EntitlementReference","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"attribute":{"type":"string","example":"memberOf"},"value":{"type":"string","example":"CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"},"standalone":{"type":"boolean","example":false}}}]}},"entitlementCount":{"type":"integer","description":"The number of entitlements assigned to the account","format":"int32","example":2},"uncorrelated":{"type":"boolean","description":"Indicates if the account is not correlated to an identity","example":false},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},{"description":"Aggregation","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"type":"object","properties":{"status":{"type":"string","example":"Success"},"duration":{"type":"integer","format":"int32","example":20},"avgDuration":{"type":"integer","format":"int32","example":20},"changedAccounts":{"type":"integer","format":"int32","example":1},"nextScheduled":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"startTime":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"sourceOwner":{"type":"string","description":"John Doe"}}}]},{"description":"Entitlement","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"A description of the entitlement","example":"The admin privilege"},"attribute":{"type":"string","description":"The name of the entitlement attribute","example":"admin"},"value":{"type":"string","description":"The value of the entitlement","example":"true"}}}]},{"type":"object","properties":{"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"displayName":{"type":"string","description":"The display name of the entitlement","example":"Admin"},"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"identityCount":{"type":"integer","format":"int32","example":3},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},{"description":"Event","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"type":"object","properties":{"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"action":{"type":"string","description":"The action that was performed","example":"update"},"type":{"type":"string","description":"The type of event","example":"SYSTEM_CONFIG"},"actor":{"type":"object","properties":{"name":{"type":"string","example":"John Doe","description":"the actor or target name"},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}},"target":{"type":"object","properties":{"name":{"type":"string","example":"John Doe","description":"the actor or target name"},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}},"stack":{"type":"string","example":"tpe"},"trackingNumber":{"type":"string","example":"63f891e0735f4cc8bf1968144a1e7440"},"ipAddress":{"type":"string","example":"52.52.97.85"},"details":{"type":"string","example":"73b65dfbed1842548c207432a18c84b0"},"attributes":{"type":"object","additionalProperties":true,"example":{"pod":"stg03-useast1","org":"acme","sourceName":"SailPoint"}},"objects":{"type":"array","items":{"type":"string","example":"AUTHENTICATION"}},"operation":{"type":"string","example":"REQUEST"},"status":{"type":"string","example":"PASSED"},"technicalName":{"type":"string","example":"AUTHENTICATION_REQUEST_PASSED"}}}]},{"description":"Identity","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the identity","example":"Carol"},"lastName":{"type":"string","description":"The last name of the identity","example":"Adams"},"displayName":{"type":"string","example":"Carol.Adams","description":"The display name of the identity"},"email":{"type":"string","description":"The identity's primary email address","example":"Carol.Adams@sailpointdemo.com"},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"phone":{"type":"string","description":"The phone number of the identity","example":"+1 440-527-3672"},"inactive":{"type":"boolean","description":"Indicates if the identity is inactive","example":false},"protected":{"type":"boolean","example":false},"status":{"type":"string","description":"The identity's status in SailPoint","example":"UNREGISTERED"},"employeeNumber":{"type":"string","example":"1a2a3d4e"},"manager":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}],"nullable":true},"isManager":{"type":"boolean","description":"Indicates if this identity is a manager of other identities","example":false},"identityProfile":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"attributes":{"type":"object","description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"country":"US","firstname":"Carol","cloudStatus":"UNREGISTERED"}},"processingState":{"type":"string","nullable":true,"example":null},"processingDetails":{"nullable":true,"type":"object","properties":{"date":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"stage":{"type":"string","example":"In Process"},"retryCount":{"type":"integer","example":0,"format":"int32"},"stackTrace":{"type":"string","example":""},"message":{"type":"string","example":""}}},"accounts":{"type":"array","description":"List of accounts associated with the identity","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"accountId":{"type":"string","description":"The ID of the account","example":"john.doe"},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"disabled":{"type":"boolean","description":"Indicates if the account is disabled","example":false},"locked":{"type":"boolean","description":"Indicates if the account is locked","example":false},"privileged":{"type":"boolean","example":false},"manuallyCorrelated":{"type":"boolean","description":"Indicates if the account has been manually correlated to an identity","example":false},"passwordLastSet":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"entitlementAttributes":{"type":"object","nullable":true,"description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"moderator":true,"admin":true,"trust_level":"4"}},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}}}]}},"accountCount":{"type":"integer","description":"Number of accounts associated with the identity","format":"int32","example":3},"apps":{"type":"array","description":"The list of applications the identity has access to","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"account":{"type":"object","properties":{"id":{"type":"string","description":"The SailPoint generated unique ID","example":"2c9180837dfe6949017e21f3d8cd6d49"},"accountId":{"type":"string","description":"The account ID generated by the source","example":"CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"}}}}}]}},"appCount":{"type":"integer","format":"int32","description":"The number of applications the identity has access to","example":2},"access":{"type":"array","description":"The list of access items assigned to the identity","items":{"discriminator":{"propertyName":"type","mapping":{"ACCESS_PROFILE":{"description":"This is a summary representation of an access profile.","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"revocable":{"type":"boolean","example":true}}}]},"ENTITLEMENT":{"description":"EntitlementReference","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"attribute":{"type":"string","example":"memberOf"},"value":{"type":"string","example":"CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"},"standalone":{"type":"boolean","example":false}}}]},"ROLE":{"description":"Role","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"disabled":{"type":"boolean"},"revocable":{"type":"boolean"}}}]}}},"oneOf":[{"description":"This is a summary representation of an access profile.","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"revocable":{"type":"boolean","example":true}}}]},{"description":"EntitlementReference","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"attribute":{"type":"string","example":"memberOf"},"value":{"type":"string","example":"CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"},"standalone":{"type":"boolean","example":false}}}]},{"description":"Role","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"disabled":{"type":"boolean"},"revocable":{"type":"boolean"}}}]}]}},"accessCount":{"type":"integer","format":"int32","description":"The number of access items assigned to the identity","example":5},"accessProfileCount":{"type":"integer","description":"The number of access profiles assigned to the identity","example":1},"entitlementCount":{"type":"integer","description":"The number of entitlements assigned to the identity","example":10},"roleCount":{"type":"integer","description":"The number of roles assigned to the identity","example":1},"owns":{"type":"object","properties":{"sources":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"entitlements":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"accessProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"apps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"governanceGroups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"fallbackApprover":{"type":"boolean","example":false}}},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},{"description":"Role","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the access item","example":"The admin role"},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"enabled":{"type":"boolean","example":true},"requestable":{"type":"boolean","example":true,"description":"Indicates if the access can be requested"},"requestCommentsRequired":{"type":"boolean","description":"Indicates if comments are required when requesting access","example":false},"owner":{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}}]},{"type":"object","properties":{"email":{"type":"string","example":"john.doe@sailpoint.com","description":"The email of the identity"}}}]}}}]},{"type":"object","properties":{"accessProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"accessProfileCount":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]}]}}}}},"text/csv":{"schema":{"description":"If the *Accept:text/csv* header is specified and the *aggregationType* parameter in the request body is *SAILPOINT*,\n\nthe aggregation result will be returned as a CSV document.\n","type":"string","example":["Identity Locations,Count","Munich,23","Brussels,26","Singapore,22","Tokyo,20","Taipei,16","London,64","Austin,109","Sao Paulo,24","San Jose,27"]}}},"headers":{"X-Total-Count":{"description":"The total result count (returned only if the *count* parameter is specified as *true*).","schema":{"type":"integer"},"example":5}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/search/aggregate","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"indices":["identities"],"queryType":"SAILPOINT","queryVersion":"5.2","query":{"query":"name:a*","fields":["name"],"timeZone":"America/Chicago","innerHit":{"query":"source.name:\\\"Active Directory\\\"","type":"access"}},"queryDsl":{"match":{"name":"john.doe"}},"typeAheadQuery":{"query":"Work","field":"source.name","nestedType":"access","maxExpansions":10},"includeNested":true,"queryResultFilter":{"includes":["name","displayName"],"excludes":["stacktrace"]},"aggregationType":"DSL","aggregationsVersion":"5.2","aggregationsDsl":{},"aggregations":{"nested":{"name":"id","type":"access"},"metric":{"name":"Access Name Count","type":"COUNT","field":"@access.name"},"filter":{"name":"Entitlements","type":"TERM","field":"access.type","value":"ENTITLEMENT"},"bucket":{"name":"Identity Locations","type":"TERMS","field":"attributes.city","size":100,"minDocCount":2},"subAggregation":{"nested":{"name":"id","type":"access"},"metric":{"name":"Access Name Count","type":"COUNT","field":"@access.name"},"filter":{"name":"Entitlements","type":"TERM","field":"access.type","value":"ENTITLEMENT"},"bucket":{"name":"Identity Locations","type":"TERMS","field":"attributes.city","size":100,"minDocCount":2},"subAggregation":{"nested":{"name":"id","type":"access"},"metric":{"name":"Access Name Count","type":"COUNT","field":"@access.name"},"filter":{"name":"Entitlements","type":"TERM","field":"access.type","value":"ENTITLEMENT"},"bucket":{"name":"Identity Locations","type":"TERMS","field":"attributes.city","size":100,"minDocCount":2}}}},"sort":[["displayName","+id"]],"searchAfter":[["John Doe","2c91808375d8e80a0175e1f88a575221"]],"filters":{}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Perform a Search Query Aggregation","description":{"content":"Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. ","type":"text/plain"},"url":{"path":["search","aggregate"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Perform a Search Query Aggregation' (search-aggregate)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Perform a Search Query Aggregation + + + +Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. + +
    Query Parameters
    Request Body required
      query object
      + +Query parameters used to construct an Elasticsearch query object. + +
      innerHit object
      + +The innerHit query object returns a flattened list of results for the specified nested type. + +
      typeAheadQuery object
      + +Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing "Jo" results in top hits matching "Jo." Typing "Job" results in top hits matching "Job." + +
      = 1` and `<= 1000`"} defaultValue={10}>
      queryResultFilter object
      + +Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. + +
      aggregations object
      nested object
      + +The nested aggregation object. + +
      metric object
      + +The calculation done on the results of the query + +
      filter object
      + +An additional filter to constrain the results of the search query. + +
      bucket object
      + +The bucket to group the results of the aggregation query by. + +
      subAggregation object
      + +Aggregation to be performed on the result of the parent bucket aggregation. + +
      nested object
      + +The nested aggregation object. + +
      metric object
      + +The calculation done on the results of the query + +
      filter object
      + +An additional filter to constrain the results of the search query. + +
      bucket object
      + +The bucket to group the results of the aggregation query by. + +
      subAggregation object
      + +Aggregation to be performed on the result of the parent bucket aggregation. + +
      nested object
      + +The nested aggregation object. + +
      metric object
      + +The calculation done on the results of the query + +
      filter object
      + +An additional filter to constrain the results of the search query. + +
      bucket object
      + +The bucket to group the results of the aggregation query by. + +
      filters object
      + +The filters to be applied for each filtered field name. + +
    • property name* object
    + +Aggregation results. + +
    Response Headers
    • X-Total-Count integer
      Example: 5 + +The total result count (returned only if the *count* parameter is specified as *true*). + +
    Schema
      hits object[]
      + +The results of the aggregation search query. + + +
      oneOf
      owner object
      source object
      entitlements object[]
      requester object
      recipient object
      approvals object[]
      comments object[]
      owner object
      originalRequests object[]
      attributeRequests object[]
      source object
      expansionItems object[]
      attributeRequests object[]
      source object
      accountRequests object[]
      attributeRequests object[]
      provisioningTarget object
      result object
      source object
      source object
      entitlementAttributes object
      + +a map or dictionary of key/value pairs + +
      attributes object
      + +a map or dictionary of key/value pairs + +
      identity object
      access object[]
      source object
      source object
      actor object
      target object
      attributes object
      manager object
      identityProfile object
      source object
      attributes object
      + +a map or dictionary of key/value pairs + +
      processingDetails object
      accounts object[]
      + +List of accounts associated with the identity + +
      source object
      entitlementAttributes object
      + +a map or dictionary of key/value pairs + +
      apps object[]
      + +The list of applications the identity has access to + +
      source object
      account object
      access object[]
      + +The list of access items assigned to the identity + +
      oneOf
      source object
      owner object
      source object
      owner object
      owns object
      sources object[]
      entitlements object[]
      accessProfiles object[]
      roles object[]
      apps object[]
      governanceGroups object[]
      owner object
      accessProfiles object[]
    \",\n \"message\": \"\"\n },\n \"accounts\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"accountId\": \"john.doe\",\n \"source\": {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"type\": \"Delimited File\"\n },\n \"disabled\": false,\n \"locked\": false,\n \"privileged\": false,\n \"manuallyCorrelated\": false,\n \"passwordLastSet\": \"2018-06-25T20:22:28.104Z\",\n \"entitlementAttributes\": {\n \"moderator\": true,\n \"admin\": true,\n \"trust_level\": \"4\"\n },\n \"created\": \"2018-06-25T20:22:28.104Z\"\n }\n ],\n \"accountCount\": 3,\n \"apps\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"source\": {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\"\n },\n \"account\": {\n \"id\": \"2c9180837dfe6949017e21f3d8cd6d49\",\n \"accountId\": \"CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\"\n }\n }\n ],\n \"appCount\": 2,\n \"access\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"displayName\": \"John Q. Doe\",\n \"type\": \"IDENTITY\",\n \"description\": null,\n \"source\": {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\"\n },\n \"owner\": {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"displayName\": \"John Q. Doe\"\n },\n \"revocable\": true\n },\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"displayName\": \"John Q. Doe\",\n \"type\": \"IDENTITY\",\n \"description\": null,\n \"source\": {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\"\n },\n \"privileged\": false,\n \"attribute\": \"memberOf\",\n \"value\": \"CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"standalone\": false\n },\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"displayName\": \"John Q. Doe\",\n \"type\": \"IDENTITY\",\n \"description\": null,\n \"owner\": {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"displayName\": \"John Q. Doe\"\n },\n \"disabled\": true,\n \"revocable\": true\n }\n ],\n \"accessCount\": 5,\n \"accessProfileCount\": 1,\n \"entitlementCount\": 10,\n \"roleCount\": 1,\n \"owns\": {\n \"sources\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\"\n }\n ],\n \"entitlements\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\"\n }\n ],\n \"accessProfiles\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\"\n }\n ],\n \"roles\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\"\n }\n ],\n \"apps\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\"\n }\n ],\n \"governanceGroups\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\"\n }\n ],\n \"fallbackApprover\": false\n },\n \"tags\": [\n \"TAG_1\",\n \"TAG_2\"\n ]\n },\n {\n \"id\": true,\n \"name\": true,\n \"_type\": \"identity\",\n \"description\": \"The admin role\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"synced\": \"2018-06-25T20:22:28.104Z\",\n \"enabled\": true,\n \"requestable\": true,\n \"requestCommentsRequired\": false,\n \"owner\": {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"type\": \"IDENTITY\",\n \"email\": \"john.doe@sailpoint.com\"\n },\n \"accessProfiles\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\"\n }\n ],\n \"accessProfileCount\": 0,\n \"tags\": [\n \"TAG_1\",\n \"TAG_2\"\n ]\n }\n ]\n}"} language={"json"}>
    Schema
    • string
      + +If the *Accept:text/csv* header is specified and the *aggregationType* parameter in the request body is *SAILPOINT*, + +the aggregation result will be returned as a CSV document. + + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/search-count.api.mdx b/products/idn/api/v3/search-count.api.mdx new file mode 100644 index 000000000..723973637 --- /dev/null +++ b/products/idn/api/v3/search-count.api.mdx @@ -0,0 +1,155 @@ +--- +id: search-count +sidebar_label: Count Documents Satisfying a Query +hide_title: true +hide_table_of_contents: true +api: {"tags":["Search"],"description":"Performs a search with a provided query and returns the count of results in the X-Total-Count header.","operationId":"searchCount","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"indices":{"description":"The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched.","externalDocs":{"description":"Learn more about search indices here.","url":"https://documentation.sailpoint.com/saas/help/search/searchable-fields.html"},"type":"array","items":{"description":"Enum representing the currently supported indices.\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofiles","accountactivities","entitlements","events","identities","roles","*"],"example":"identities"},"example":["identities"]},"queryType":{"description":"The type of query to use. By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body.\nTo use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly.\nAdditional values may be added in the future without notice.","type":"string","enum":["DSL","SAILPOINT","TYPEAHEAD"],"default":"SAILPOINT","example":"SAILPOINT"},"queryVersion":{"allOf":[{"description":"The current Elasticserver version.","type":"string","default":"5.2","example":"5.2"},{"type":"string","description":"The version of the query object.\nThis version number will map to the version of Elasticsearch for the query strings and objects being used."}]},"query":{"type":"object","description":"Query parameters used to construct an Elasticsearch query object.","properties":{"query":{"description":"The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.","type":"string","example":"name:a*"},"fields":{"description":"The fields to which the specified query will be applied. The available fields are dependent on the indice(s) being searched on. Please refer to the response schema of this API for a list of available fields.","type":"array","items":{"type":"string"},"example":["name"]},"timeZone":{"description":"The time zone to be applied to any range query related to dates.","type":"string","example":"America/Chicago"},"innerHit":{"description":"The innerHit query object returns a flattened list of results for the specified nested type.","type":"object","required":["query","type"],"properties":{"query":{"description":"The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.","type":"string","example":"source.name:\\\"Active Directory\\\""},"type":{"description":"The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document \"nested\" within another document. For example, an identity can have nested documents for access, accounts, and apps.","type":"string","example":"access"}}}}},"queryDsl":{"description":"The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax.","type":"object","example":{"match":{"name":"john.doe"}}},"typeAheadQuery":{"type":"object","description":"Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing \"Jo\" results in top hits matching \"Jo.\" Typing \"Job\" results in top hits matching \"Job.\" ","required":["query","field"],"properties":{"query":{"description":"The type ahead query string used to construct a phrase prefix match query.","type":"string","example":"Work"},"field":{"description":"The field on which to perform the type ahead search.","type":"string","example":"source.name"},"nestedType":{"description":"The nested type.","type":"string","example":"access"},"maxExpansions":{"description":"The number of suffixes the last term will be expanded into.\nInfluences the performance of the query and the number results returned.\nValid values: 1 to 1000.","type":"integer","format":"int32","minimum":1,"maximum":1000,"default":10,"example":10}}},"includeNested":{"description":"Indicates whether nested objects from returned search results should be included.","type":"boolean","default":true,"example":true},"queryResultFilter":{"type":"object","description":"Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents.","properties":{"includes":{"description":"The list of field names to include in the result documents.","type":"array","items":{"type":"string"},"example":["name","displayName"]},"excludes":{"description":"The list of field names to exclude from the result documents.","type":"array","items":{"type":"string"},"example":["stacktrace"]}}},"aggregationType":{"description":"Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["DSL","SAILPOINT"],"default":"DSL","example":"DSL"},"aggregationsVersion":{"allOf":[{"description":"The current Elasticserver version.","type":"string","default":"5.2","example":"5.2"},{"type":"string","description":"The version of the language being used for aggregation queries.\nThis version number will map to the version of Elasticsearch for the aggregation query object."}]},"aggregationsDsl":{"description":"The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax.","type":"object","example":{}},"aggregations":{"description":"The aggregation’s specifications, such as the groupings and calculations to be performed.\n","allOf":[{"type":"object","properties":{"nested":{"type":"object","description":"The nested aggregation object.","required":["name","type"],"properties":{"name":{"description":"The name of the nested aggregate to be included in the result.","type":"string","example":"id"},"type":{"description":"The type of the nested object.","type":"string","example":"access"}}},"metric":{"type":"object","description":"The calculation done on the results of the query","required":["name","field"],"properties":{"name":{"description":"The name of the metric aggregate to be included in the result.\nIf the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results.","type":"string","example":"Access Name Count"},"type":{"description":"Enum representing the currently supported metric aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["COUNT","UNIQUE_COUNT","AVG","SUM","MEDIAN","MIN","MAX"],"default":"UNIQUE_COUNT","example":"COUNT"},"field":{"description":"The field the calculation is performed on.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"@access.name"}}},"filter":{"type":"object","description":"An additional filter to constrain the results of the search query.","required":["name","field","value"],"properties":{"name":{"description":"The name of the filter aggregate to be included in the result.","type":"string","example":"Entitlements"},"type":{"description":"Enum representing the currently supported filter aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERM"],"default":"TERM","example":"TERM"},"field":{"description":"The search field to apply the filter to.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"access.type"},"value":{"description":"The value to filter on.","type":"string","example":"ENTITLEMENT"}}},"bucket":{"type":"object","description":"The bucket to group the results of the aggregation query by.","required":["name","field"],"properties":{"name":{"description":"The name of the bucket aggregate to be included in the result.","type":"string","example":"Identity Locations"},"type":{"description":"Enum representing the currently supported bucket aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERMS"],"default":"TERMS","example":"TERMS"},"field":{"description":"The field to bucket on.\nPrefix the field name with '@' to reference a nested object.","type":"string","example":"attributes.city"},"size":{"description":"Maximum number of buckets to include.","type":"integer","format":"int32","example":100},"minDocCount":{"description":"Minimum number of documents a bucket should have.","type":"integer","format":"int32","example":2}}}}},{"type":"object","properties":{"subAggregation":{"description":"Aggregation to be performed on the result of the parent bucket aggregation.","allOf":[{"type":"object","properties":{"nested":{"type":"object","description":"The nested aggregation object.","required":["name","type"],"properties":{"name":{"description":"The name of the nested aggregate to be included in the result.","type":"string","example":"id"},"type":{"description":"The type of the nested object.","type":"string","example":"access"}}},"metric":{"type":"object","description":"The calculation done on the results of the query","required":["name","field"],"properties":{"name":{"description":"The name of the metric aggregate to be included in the result.\nIf the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results.","type":"string","example":"Access Name Count"},"type":{"description":"Enum representing the currently supported metric aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["COUNT","UNIQUE_COUNT","AVG","SUM","MEDIAN","MIN","MAX"],"default":"UNIQUE_COUNT","example":"COUNT"},"field":{"description":"The field the calculation is performed on.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"@access.name"}}},"filter":{"type":"object","description":"An additional filter to constrain the results of the search query.","required":["name","field","value"],"properties":{"name":{"description":"The name of the filter aggregate to be included in the result.","type":"string","example":"Entitlements"},"type":{"description":"Enum representing the currently supported filter aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERM"],"default":"TERM","example":"TERM"},"field":{"description":"The search field to apply the filter to.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"access.type"},"value":{"description":"The value to filter on.","type":"string","example":"ENTITLEMENT"}}},"bucket":{"type":"object","description":"The bucket to group the results of the aggregation query by.","required":["name","field"],"properties":{"name":{"description":"The name of the bucket aggregate to be included in the result.","type":"string","example":"Identity Locations"},"type":{"description":"Enum representing the currently supported bucket aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERMS"],"default":"TERMS","example":"TERMS"},"field":{"description":"The field to bucket on.\nPrefix the field name with '@' to reference a nested object.","type":"string","example":"attributes.city"},"size":{"description":"Maximum number of buckets to include.","type":"integer","format":"int32","example":100},"minDocCount":{"description":"Minimum number of documents a bucket should have.","type":"integer","format":"int32","example":2}}}}},{"type":"object","properties":{"subAggregation":{"type":"object","properties":{"nested":{"type":"object","description":"The nested aggregation object.","required":["name","type"],"properties":{"name":{"description":"The name of the nested aggregate to be included in the result.","type":"string","example":"id"},"type":{"description":"The type of the nested object.","type":"string","example":"access"}}},"metric":{"type":"object","description":"The calculation done on the results of the query","required":["name","field"],"properties":{"name":{"description":"The name of the metric aggregate to be included in the result.\nIf the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results.","type":"string","example":"Access Name Count"},"type":{"description":"Enum representing the currently supported metric aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["COUNT","UNIQUE_COUNT","AVG","SUM","MEDIAN","MIN","MAX"],"default":"UNIQUE_COUNT","example":"COUNT"},"field":{"description":"The field the calculation is performed on.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"@access.name"}}},"filter":{"type":"object","description":"An additional filter to constrain the results of the search query.","required":["name","field","value"],"properties":{"name":{"description":"The name of the filter aggregate to be included in the result.","type":"string","example":"Entitlements"},"type":{"description":"Enum representing the currently supported filter aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERM"],"default":"TERM","example":"TERM"},"field":{"description":"The search field to apply the filter to.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"access.type"},"value":{"description":"The value to filter on.","type":"string","example":"ENTITLEMENT"}}},"bucket":{"type":"object","description":"The bucket to group the results of the aggregation query by.","required":["name","field"],"properties":{"name":{"description":"The name of the bucket aggregate to be included in the result.","type":"string","example":"Identity Locations"},"type":{"description":"Enum representing the currently supported bucket aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERMS"],"default":"TERMS","example":"TERMS"},"field":{"description":"The field to bucket on.\nPrefix the field name with '@' to reference a nested object.","type":"string","example":"attributes.city"},"size":{"description":"Maximum number of buckets to include.","type":"integer","format":"int32","example":100},"minDocCount":{"description":"Minimum number of documents a bucket should have.","type":"integer","format":"int32","example":2}}}},"description":"Aggregation to be performed on the result of the parent bucket aggregation."}}}]}}}]},"sort":{"description":"The fields to be used to sort the search results. Use + or - to specify the sort direction.","type":"array","items":{"type":"string","example":["displayName","+id"]}},"searchAfter":{"description":"Used to begin the search window at the values specified.\nThis parameter consists of the last values of the sorted fields in the current record set.\nThis is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value.\nIt is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging.\nFor example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example [\"displayName\", \"id\"]. \nIf the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is \"John Doe\", then using that displayName and ID will start a new search after this identity.\nThe searchAfter value will look like [\"John Doe\",\"2c91808375d8e80a0175e1f88a575221\"]","type":"array","items":{"type":"string","example":["John Doe","2c91808375d8e80a0175e1f88a575221"]}},"filters":{"description":"The filters to be applied for each filtered field name.","type":"object","additionalProperties":{"type":"object","properties":{"type":{"description":"Enum representing the currently supported filter types.\nAdditional values may be added in the future without notice.","type":"string","enum":["EXISTS","RANGE","TERMS"],"example":"RANGE"},"range":{"type":"object","description":"The range of values to be filtered.","properties":{"lower":{"description":"The lower bound of the range.","type":"object","required":["value"],"properties":{"value":{"description":"The value of the range's endpoint.","type":"string","example":"1"},"inclusive":{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}},"upper":{"description":"The upper bound of the range.","type":"object","required":["value"],"properties":{"value":{"description":"The value of the range's endpoint.","type":"string","example":"1"},"inclusive":{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}}}},"terms":{"description":"The terms to be filtered.","type":"array","items":{"type":"string","example":"account_count"}},"exclude":{"description":"Indicates if the filter excludes results.","type":"boolean","default":false,"example":false}}},"example":{}}}},"examples":{"query-timeZone":{"summary":"Query with TimeZone","value":{"indices":["identities"],"query":{"query":"created: [2022-05-19T19:26:03.351Z TO now]","timeZone":"America/Los_Angeles"}}}}}},"required":true},"responses":{"204":{"description":"No content - indicates the request was successful but there is no content to be returned in the response.","headers":{"X-Total-Count":{"description":"The total result count.","schema":{"type":"integer"},"example":5}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/search/count","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"indices":["identities"],"queryType":"SAILPOINT","queryVersion":"5.2","query":{"query":"name:a*","fields":["name"],"timeZone":"America/Chicago","innerHit":{"query":"source.name:\\\"Active Directory\\\"","type":"access"}},"queryDsl":{"match":{"name":"john.doe"}},"typeAheadQuery":{"query":"Work","field":"source.name","nestedType":"access","maxExpansions":10},"includeNested":true,"queryResultFilter":{"includes":["name","displayName"],"excludes":["stacktrace"]},"aggregationType":"DSL","aggregationsVersion":"5.2","aggregationsDsl":{},"aggregations":{"nested":{"name":"id","type":"access"},"metric":{"name":"Access Name Count","type":"COUNT","field":"@access.name"},"filter":{"name":"Entitlements","type":"TERM","field":"access.type","value":"ENTITLEMENT"},"bucket":{"name":"Identity Locations","type":"TERMS","field":"attributes.city","size":100,"minDocCount":2},"subAggregation":{"nested":{"name":"id","type":"access"},"metric":{"name":"Access Name Count","type":"COUNT","field":"@access.name"},"filter":{"name":"Entitlements","type":"TERM","field":"access.type","value":"ENTITLEMENT"},"bucket":{"name":"Identity Locations","type":"TERMS","field":"attributes.city","size":100,"minDocCount":2},"subAggregation":{"nested":{"name":"id","type":"access"},"metric":{"name":"Access Name Count","type":"COUNT","field":"@access.name"},"filter":{"name":"Entitlements","type":"TERM","field":"access.type","value":"ENTITLEMENT"},"bucket":{"name":"Identity Locations","type":"TERMS","field":"attributes.city","size":100,"minDocCount":2}}}},"sort":[["displayName","+id"]],"searchAfter":[["John Doe","2c91808375d8e80a0175e1f88a575221"]],"filters":{}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Count Documents Satisfying a Query","description":{"content":"Performs a search with a provided query and returns the count of results in the X-Total-Count header.","type":"text/plain"},"url":{"path":["search","count"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Count Documents Satisfying a Query' (search-count)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Count Documents Satisfying a Query + + + +Performs a search with a provided query and returns the count of results in the X-Total-Count header. + +
    Request Body required
      query object
      + +Query parameters used to construct an Elasticsearch query object. + +
      innerHit object
      + +The innerHit query object returns a flattened list of results for the specified nested type. + +
      typeAheadQuery object
      + +Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing "Jo" results in top hits matching "Jo." Typing "Job" results in top hits matching "Job." + +
      = 1` and `<= 1000`"} defaultValue={10}>
      queryResultFilter object
      + +Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. + +
      aggregations object
      nested object
      + +The nested aggregation object. + +
      metric object
      + +The calculation done on the results of the query + +
      filter object
      + +An additional filter to constrain the results of the search query. + +
      bucket object
      + +The bucket to group the results of the aggregation query by. + +
      subAggregation object
      + +Aggregation to be performed on the result of the parent bucket aggregation. + +
      nested object
      + +The nested aggregation object. + +
      metric object
      + +The calculation done on the results of the query + +
      filter object
      + +An additional filter to constrain the results of the search query. + +
      bucket object
      + +The bucket to group the results of the aggregation query by. + +
      subAggregation object
      + +Aggregation to be performed on the result of the parent bucket aggregation. + +
      nested object
      + +The nested aggregation object. + +
      metric object
      + +The calculation done on the results of the query + +
      filter object
      + +An additional filter to constrain the results of the search query. + +
      bucket object
      + +The bucket to group the results of the aggregation query by. + +
      filters object
      + +The filters to be applied for each filtered field name. + +
    • property name* object
    + +No content - indicates the request was successful but there is no content to be returned in the response. + +
    Response Headers
    • X-Total-Count integer
      Example: 5 + +The total result count. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/search-get.api.mdx b/products/idn/api/v3/search-get.api.mdx new file mode 100644 index 000000000..2023a5f67 --- /dev/null +++ b/products/idn/api/v3/search-get.api.mdx @@ -0,0 +1,115 @@ +--- +id: search-get +sidebar_label: Get a Document by ID +hide_title: true +hide_table_of_contents: true +api: {"tags":["Search"],"description":"Fetches a single document from the specified index, using the specified document ID.","operationId":"searchGet","parameters":[{"in":"path","name":"index","description":"The index from which to fetch the specified document.\n\nThe currently supported index names are: *accessprofiles*, *accountactivities*, *accounts*, *aggregations*, *entitlements*, *events*, *identities*, and *roles*.\n","schema":{"type":"string"},"required":true,"example":"accounts"},{"in":"path","name":"id","description":"ID of the requested document.","schema":{"type":"string"},"required":true,"example":"2c91808568c529c60168cca6f90c1313"}],"responses":{"200":{"description":"The requested document.","content":{"application/json":{"schema":{"discriminator":{"propertyName":"_type","mapping":{"accessprofile":{"description":"This is more of a complete representation of an access profile. ","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the access item","example":"The admin role"},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"enabled":{"type":"boolean","example":true},"requestable":{"type":"boolean","example":true,"description":"Indicates if the access can be requested"},"requestCommentsRequired":{"type":"boolean","description":"Indicates if comments are required when requesting access","example":false},"owner":{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}}]},{"type":"object","properties":{"email":{"type":"string","example":"john.doe@sailpoint.com","description":"The email of the identity"}}}]}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"entitlements":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"A description of the entitlement","example":"The admin privilege"},"attribute":{"type":"string","description":"The name of the entitlement attribute","example":"admin"},"value":{"type":"string","description":"The value of the entitlement","example":"true"}}}]}},"entitlementCount":{"type":"integer","example":5},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},"accountactivity":{"description":"AccountActivity","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"type":"object","properties":{"action":{"type":"string","description":"The type of action that this activity performed","externalDocs":{"description":"Learn more about account activity action types","url":"https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data"},"example":"Identity Refresh."},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"stage":{"type":"string","description":"The current stage of the activity","example":"Completed"},"origin":{"type":"string","nullable":true,"example":null},"status":{"type":"string","description":"the current status of the activity","example":"Complete"},"requester":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"recipient":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"trackingNumber":{"type":"string","example":"61aad0c9e8134eca89e76a35e0cabe3f"},"errors":{"type":"array","items":{"type":"string"},"nullable":true,"example":null},"warnings":{"type":"array","items":{"type":"string"},"nullable":true,"example":null},"approvals":{"type":"array","items":{"type":"object","properties":{"comments":{"type":"array","items":{"type":"object","properties":{"comment":{"type":"string","description":"The comment text","example":"This request was autoapproved by our automated ETS subscriber."},"commenter":{"type":"string","description":"The name of the commenter","example":"Automated AR Approval"},"date":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}}}},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"result":{"type":"string","description":"The result of the approval","example":"Finished"},"type":{"type":"string","nullable":true,"example":null}}}},"originalRequests":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","description":"the account id","example":"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com"},"attributeRequests":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name","example":"groups"},"op":{"type":"string","description":"The operation to perform","example":"Add"},"value":{"type":"string","description":"The value of the attribute","example":"3203537556531076"}}}},"op":{"type":"string","description":"the operation that was used","example":"add"},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]}}}},"expansionItems":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","description":"The ID of the account","example":"2c91808981f58ea601821c3e93482e6f"},"cause":{"type":"string","example":"Role"},"name":{"type":"string","description":"The name of the item","example":"smartsheet-role"},"attributeRequests":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name","example":"groups"},"op":{"type":"string","description":"The operation to perform","example":"Add"},"value":{"type":"string","description":"The value of the attribute","example":"3203537556531076"}}}},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]}}}},"accountRequests":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","description":"Unique ID of the account","example":"John.Doe"},"attributeRequests":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name","example":"groups"},"op":{"type":"string","description":"The operation to perform","example":"Add"},"value":{"type":"string","description":"The value of the attribute","example":"3203537556531076"}}}},"op":{"type":"string","example":"Modify","description":"The operation that was performed"},"provisioningTarget":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"result":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","example":"[ConnectorError] [\n {\n \"code\": \"unrecognized_keys\",\n \"keys\": [\n \"groups\"\n ],\n \"path\": [],\n \"message\": \"Unrecognized key(s) in object: 'groups'\"\n }\n] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e)"}},"status":{"type":"string","description":"The status of the account request","example":"failed"},"ticketId":{"type":"string","nullable":true,"example":null}}},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]}}}},"sources":{"type":"string","example":"smartsheet-test, airtable-v4, IdentityNow"}}}]},"account":{"description":"Account","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"accountId":{"type":"string","description":"The ID of the account","example":"john.doe"},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"disabled":{"type":"boolean","description":"Indicates if the account is disabled","example":false},"locked":{"type":"boolean","description":"Indicates if the account is locked","example":false},"privileged":{"type":"boolean","example":false},"manuallyCorrelated":{"type":"boolean","description":"Indicates if the account has been manually correlated to an identity","example":false},"passwordLastSet":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"entitlementAttributes":{"type":"object","nullable":true,"description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"moderator":true,"admin":true,"trust_level":"4"}},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}}}]},{"type":"object","properties":{"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"attributes":{"type":"object","description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"firstName":"John","lastName":"Doe","displayName":"John.Doe"}},"identity":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"access":{"type":"array","items":{"description":"EntitlementReference","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"attribute":{"type":"string","example":"memberOf"},"value":{"type":"string","example":"CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"},"standalone":{"type":"boolean","example":false}}}]}},"entitlementCount":{"type":"integer","description":"The number of entitlements assigned to the account","format":"int32","example":2},"uncorrelated":{"type":"boolean","description":"Indicates if the account is not correlated to an identity","example":false},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},"aggregation":{"description":"Aggregation","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"type":"object","properties":{"status":{"type":"string","example":"Success"},"duration":{"type":"integer","format":"int32","example":20},"avgDuration":{"type":"integer","format":"int32","example":20},"changedAccounts":{"type":"integer","format":"int32","example":1},"nextScheduled":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"startTime":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"sourceOwner":{"type":"string","description":"John Doe"}}}]},"entitlement":{"description":"Entitlement","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"A description of the entitlement","example":"The admin privilege"},"attribute":{"type":"string","description":"The name of the entitlement attribute","example":"admin"},"value":{"type":"string","description":"The value of the entitlement","example":"true"}}}]},{"type":"object","properties":{"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"displayName":{"type":"string","description":"The display name of the entitlement","example":"Admin"},"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"identityCount":{"type":"integer","format":"int32","example":3},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},"event":{"description":"Event","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"type":"object","properties":{"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"action":{"type":"string","description":"The action that was performed","example":"update"},"type":{"type":"string","description":"The type of event","example":"SYSTEM_CONFIG"},"actor":{"type":"object","properties":{"name":{"type":"string","example":"John Doe","description":"the actor or target name"},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}},"target":{"type":"object","properties":{"name":{"type":"string","example":"John Doe","description":"the actor or target name"},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}},"stack":{"type":"string","example":"tpe"},"trackingNumber":{"type":"string","example":"63f891e0735f4cc8bf1968144a1e7440"},"ipAddress":{"type":"string","example":"52.52.97.85"},"details":{"type":"string","example":"73b65dfbed1842548c207432a18c84b0"},"attributes":{"type":"object","additionalProperties":true,"example":{"pod":"stg03-useast1","org":"acme","sourceName":"SailPoint"}},"objects":{"type":"array","items":{"type":"string","example":"AUTHENTICATION"}},"operation":{"type":"string","example":"REQUEST"},"status":{"type":"string","example":"PASSED"},"technicalName":{"type":"string","example":"AUTHENTICATION_REQUEST_PASSED"}}}]},"identity":{"description":"Identity","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the identity","example":"Carol"},"lastName":{"type":"string","description":"The last name of the identity","example":"Adams"},"displayName":{"type":"string","example":"Carol.Adams","description":"The display name of the identity"},"email":{"type":"string","description":"The identity's primary email address","example":"Carol.Adams@sailpointdemo.com"},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"phone":{"type":"string","description":"The phone number of the identity","example":"+1 440-527-3672"},"inactive":{"type":"boolean","description":"Indicates if the identity is inactive","example":false},"protected":{"type":"boolean","example":false},"status":{"type":"string","description":"The identity's status in SailPoint","example":"UNREGISTERED"},"employeeNumber":{"type":"string","example":"1a2a3d4e"},"manager":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}],"nullable":true},"isManager":{"type":"boolean","description":"Indicates if this identity is a manager of other identities","example":false},"identityProfile":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"attributes":{"type":"object","description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"country":"US","firstname":"Carol","cloudStatus":"UNREGISTERED"}},"processingState":{"type":"string","nullable":true,"example":null},"processingDetails":{"nullable":true,"type":"object","properties":{"date":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"stage":{"type":"string","example":"In Process"},"retryCount":{"type":"integer","example":0,"format":"int32"},"stackTrace":{"type":"string","example":""},"message":{"type":"string","example":""}}},"accounts":{"type":"array","description":"List of accounts associated with the identity","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"accountId":{"type":"string","description":"The ID of the account","example":"john.doe"},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"disabled":{"type":"boolean","description":"Indicates if the account is disabled","example":false},"locked":{"type":"boolean","description":"Indicates if the account is locked","example":false},"privileged":{"type":"boolean","example":false},"manuallyCorrelated":{"type":"boolean","description":"Indicates if the account has been manually correlated to an identity","example":false},"passwordLastSet":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"entitlementAttributes":{"type":"object","nullable":true,"description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"moderator":true,"admin":true,"trust_level":"4"}},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}}}]}},"accountCount":{"type":"integer","description":"Number of accounts associated with the identity","format":"int32","example":3},"apps":{"type":"array","description":"The list of applications the identity has access to","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"account":{"type":"object","properties":{"id":{"type":"string","description":"The SailPoint generated unique ID","example":"2c9180837dfe6949017e21f3d8cd6d49"},"accountId":{"type":"string","description":"The account ID generated by the source","example":"CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"}}}}}]}},"appCount":{"type":"integer","format":"int32","description":"The number of applications the identity has access to","example":2},"access":{"type":"array","description":"The list of access items assigned to the identity","items":{"discriminator":{"propertyName":"type","mapping":{"ACCESS_PROFILE":{"description":"This is a summary representation of an access profile.","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"revocable":{"type":"boolean","example":true}}}]},"ENTITLEMENT":{"description":"EntitlementReference","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"attribute":{"type":"string","example":"memberOf"},"value":{"type":"string","example":"CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"},"standalone":{"type":"boolean","example":false}}}]},"ROLE":{"description":"Role","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"disabled":{"type":"boolean"},"revocable":{"type":"boolean"}}}]}}},"oneOf":[{"description":"This is a summary representation of an access profile.","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"revocable":{"type":"boolean","example":true}}}]},{"description":"EntitlementReference","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"attribute":{"type":"string","example":"memberOf"},"value":{"type":"string","example":"CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"},"standalone":{"type":"boolean","example":false}}}]},{"description":"Role","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"disabled":{"type":"boolean"},"revocable":{"type":"boolean"}}}]}]}},"accessCount":{"type":"integer","format":"int32","description":"The number of access items assigned to the identity","example":5},"accessProfileCount":{"type":"integer","description":"The number of access profiles assigned to the identity","example":1},"entitlementCount":{"type":"integer","description":"The number of entitlements assigned to the identity","example":10},"roleCount":{"type":"integer","description":"The number of roles assigned to the identity","example":1},"owns":{"type":"object","properties":{"sources":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"entitlements":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"accessProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"apps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"governanceGroups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"fallbackApprover":{"type":"boolean","example":false}}},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},"role":{"description":"Role","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the access item","example":"The admin role"},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"enabled":{"type":"boolean","example":true},"requestable":{"type":"boolean","example":true,"description":"Indicates if the access can be requested"},"requestCommentsRequired":{"type":"boolean","description":"Indicates if comments are required when requesting access","example":false},"owner":{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}}]},{"type":"object","properties":{"email":{"type":"string","example":"john.doe@sailpoint.com","description":"The email of the identity"}}}]}}}]},{"type":"object","properties":{"accessProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"accessProfileCount":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]}}},"oneOf":[{"description":"This is more of a complete representation of an access profile. ","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the access item","example":"The admin role"},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"enabled":{"type":"boolean","example":true},"requestable":{"type":"boolean","example":true,"description":"Indicates if the access can be requested"},"requestCommentsRequired":{"type":"boolean","description":"Indicates if comments are required when requesting access","example":false},"owner":{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}}]},{"type":"object","properties":{"email":{"type":"string","example":"john.doe@sailpoint.com","description":"The email of the identity"}}}]}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"entitlements":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"A description of the entitlement","example":"The admin privilege"},"attribute":{"type":"string","description":"The name of the entitlement attribute","example":"admin"},"value":{"type":"string","description":"The value of the entitlement","example":"true"}}}]}},"entitlementCount":{"type":"integer","example":5},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},{"description":"AccountActivity","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"type":"object","properties":{"action":{"type":"string","description":"The type of action that this activity performed","externalDocs":{"description":"Learn more about account activity action types","url":"https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data"},"example":"Identity Refresh."},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"stage":{"type":"string","description":"The current stage of the activity","example":"Completed"},"origin":{"type":"string","nullable":true,"example":null},"status":{"type":"string","description":"the current status of the activity","example":"Complete"},"requester":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"recipient":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"trackingNumber":{"type":"string","example":"61aad0c9e8134eca89e76a35e0cabe3f"},"errors":{"type":"array","items":{"type":"string"},"nullable":true,"example":null},"warnings":{"type":"array","items":{"type":"string"},"nullable":true,"example":null},"approvals":{"type":"array","items":{"type":"object","properties":{"comments":{"type":"array","items":{"type":"object","properties":{"comment":{"type":"string","description":"The comment text","example":"This request was autoapproved by our automated ETS subscriber."},"commenter":{"type":"string","description":"The name of the commenter","example":"Automated AR Approval"},"date":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}}}},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"result":{"type":"string","description":"The result of the approval","example":"Finished"},"type":{"type":"string","nullable":true,"example":null}}}},"originalRequests":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","description":"the account id","example":"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com"},"attributeRequests":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name","example":"groups"},"op":{"type":"string","description":"The operation to perform","example":"Add"},"value":{"type":"string","description":"The value of the attribute","example":"3203537556531076"}}}},"op":{"type":"string","description":"the operation that was used","example":"add"},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]}}}},"expansionItems":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","description":"The ID of the account","example":"2c91808981f58ea601821c3e93482e6f"},"cause":{"type":"string","example":"Role"},"name":{"type":"string","description":"The name of the item","example":"smartsheet-role"},"attributeRequests":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name","example":"groups"},"op":{"type":"string","description":"The operation to perform","example":"Add"},"value":{"type":"string","description":"The value of the attribute","example":"3203537556531076"}}}},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]}}}},"accountRequests":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","description":"Unique ID of the account","example":"John.Doe"},"attributeRequests":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name","example":"groups"},"op":{"type":"string","description":"The operation to perform","example":"Add"},"value":{"type":"string","description":"The value of the attribute","example":"3203537556531076"}}}},"op":{"type":"string","example":"Modify","description":"The operation that was performed"},"provisioningTarget":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"result":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","example":"[ConnectorError] [\n {\n \"code\": \"unrecognized_keys\",\n \"keys\": [\n \"groups\"\n ],\n \"path\": [],\n \"message\": \"Unrecognized key(s) in object: 'groups'\"\n }\n] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e)"}},"status":{"type":"string","description":"The status of the account request","example":"failed"},"ticketId":{"type":"string","nullable":true,"example":null}}},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]}}}},"sources":{"type":"string","example":"smartsheet-test, airtable-v4, IdentityNow"}}}]},{"description":"Account","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"accountId":{"type":"string","description":"The ID of the account","example":"john.doe"},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"disabled":{"type":"boolean","description":"Indicates if the account is disabled","example":false},"locked":{"type":"boolean","description":"Indicates if the account is locked","example":false},"privileged":{"type":"boolean","example":false},"manuallyCorrelated":{"type":"boolean","description":"Indicates if the account has been manually correlated to an identity","example":false},"passwordLastSet":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"entitlementAttributes":{"type":"object","nullable":true,"description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"moderator":true,"admin":true,"trust_level":"4"}},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}}}]},{"type":"object","properties":{"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"attributes":{"type":"object","description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"firstName":"John","lastName":"Doe","displayName":"John.Doe"}},"identity":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"access":{"type":"array","items":{"description":"EntitlementReference","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"attribute":{"type":"string","example":"memberOf"},"value":{"type":"string","example":"CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"},"standalone":{"type":"boolean","example":false}}}]}},"entitlementCount":{"type":"integer","description":"The number of entitlements assigned to the account","format":"int32","example":2},"uncorrelated":{"type":"boolean","description":"Indicates if the account is not correlated to an identity","example":false},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},{"description":"Aggregation","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"type":"object","properties":{"status":{"type":"string","example":"Success"},"duration":{"type":"integer","format":"int32","example":20},"avgDuration":{"type":"integer","format":"int32","example":20},"changedAccounts":{"type":"integer","format":"int32","example":1},"nextScheduled":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"startTime":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"sourceOwner":{"type":"string","description":"John Doe"}}}]},{"description":"Entitlement","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"A description of the entitlement","example":"The admin privilege"},"attribute":{"type":"string","description":"The name of the entitlement attribute","example":"admin"},"value":{"type":"string","description":"The value of the entitlement","example":"true"}}}]},{"type":"object","properties":{"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"displayName":{"type":"string","description":"The display name of the entitlement","example":"Admin"},"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"identityCount":{"type":"integer","format":"int32","example":3},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},{"description":"Event","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"type":"object","properties":{"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"action":{"type":"string","description":"The action that was performed","example":"update"},"type":{"type":"string","description":"The type of event","example":"SYSTEM_CONFIG"},"actor":{"type":"object","properties":{"name":{"type":"string","example":"John Doe","description":"the actor or target name"},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}},"target":{"type":"object","properties":{"name":{"type":"string","example":"John Doe","description":"the actor or target name"},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}},"stack":{"type":"string","example":"tpe"},"trackingNumber":{"type":"string","example":"63f891e0735f4cc8bf1968144a1e7440"},"ipAddress":{"type":"string","example":"52.52.97.85"},"details":{"type":"string","example":"73b65dfbed1842548c207432a18c84b0"},"attributes":{"type":"object","additionalProperties":true,"example":{"pod":"stg03-useast1","org":"acme","sourceName":"SailPoint"}},"objects":{"type":"array","items":{"type":"string","example":"AUTHENTICATION"}},"operation":{"type":"string","example":"REQUEST"},"status":{"type":"string","example":"PASSED"},"technicalName":{"type":"string","example":"AUTHENTICATION_REQUEST_PASSED"}}}]},{"description":"Identity","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the identity","example":"Carol"},"lastName":{"type":"string","description":"The last name of the identity","example":"Adams"},"displayName":{"type":"string","example":"Carol.Adams","description":"The display name of the identity"},"email":{"type":"string","description":"The identity's primary email address","example":"Carol.Adams@sailpointdemo.com"},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"phone":{"type":"string","description":"The phone number of the identity","example":"+1 440-527-3672"},"inactive":{"type":"boolean","description":"Indicates if the identity is inactive","example":false},"protected":{"type":"boolean","example":false},"status":{"type":"string","description":"The identity's status in SailPoint","example":"UNREGISTERED"},"employeeNumber":{"type":"string","example":"1a2a3d4e"},"manager":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}],"nullable":true},"isManager":{"type":"boolean","description":"Indicates if this identity is a manager of other identities","example":false},"identityProfile":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"attributes":{"type":"object","description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"country":"US","firstname":"Carol","cloudStatus":"UNREGISTERED"}},"processingState":{"type":"string","nullable":true,"example":null},"processingDetails":{"nullable":true,"type":"object","properties":{"date":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"stage":{"type":"string","example":"In Process"},"retryCount":{"type":"integer","example":0,"format":"int32"},"stackTrace":{"type":"string","example":""},"message":{"type":"string","example":""}}},"accounts":{"type":"array","description":"List of accounts associated with the identity","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"accountId":{"type":"string","description":"The ID of the account","example":"john.doe"},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"disabled":{"type":"boolean","description":"Indicates if the account is disabled","example":false},"locked":{"type":"boolean","description":"Indicates if the account is locked","example":false},"privileged":{"type":"boolean","example":false},"manuallyCorrelated":{"type":"boolean","description":"Indicates if the account has been manually correlated to an identity","example":false},"passwordLastSet":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"entitlementAttributes":{"type":"object","nullable":true,"description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"moderator":true,"admin":true,"trust_level":"4"}},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}}}]}},"accountCount":{"type":"integer","description":"Number of accounts associated with the identity","format":"int32","example":3},"apps":{"type":"array","description":"The list of applications the identity has access to","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"account":{"type":"object","properties":{"id":{"type":"string","description":"The SailPoint generated unique ID","example":"2c9180837dfe6949017e21f3d8cd6d49"},"accountId":{"type":"string","description":"The account ID generated by the source","example":"CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"}}}}}]}},"appCount":{"type":"integer","format":"int32","description":"The number of applications the identity has access to","example":2},"access":{"type":"array","description":"The list of access items assigned to the identity","items":{"discriminator":{"propertyName":"type","mapping":{"ACCESS_PROFILE":{"description":"This is a summary representation of an access profile.","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"revocable":{"type":"boolean","example":true}}}]},"ENTITLEMENT":{"description":"EntitlementReference","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"attribute":{"type":"string","example":"memberOf"},"value":{"type":"string","example":"CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"},"standalone":{"type":"boolean","example":false}}}]},"ROLE":{"description":"Role","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"disabled":{"type":"boolean"},"revocable":{"type":"boolean"}}}]}}},"oneOf":[{"description":"This is a summary representation of an access profile.","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"revocable":{"type":"boolean","example":true}}}]},{"description":"EntitlementReference","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"attribute":{"type":"string","example":"memberOf"},"value":{"type":"string","example":"CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"},"standalone":{"type":"boolean","example":false}}}]},{"description":"Role","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"disabled":{"type":"boolean"},"revocable":{"type":"boolean"}}}]}]}},"accessCount":{"type":"integer","format":"int32","description":"The number of access items assigned to the identity","example":5},"accessProfileCount":{"type":"integer","description":"The number of access profiles assigned to the identity","example":1},"entitlementCount":{"type":"integer","description":"The number of entitlements assigned to the identity","example":10},"roleCount":{"type":"integer","description":"The number of roles assigned to the identity","example":1},"owns":{"type":"object","properties":{"sources":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"entitlements":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"accessProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"apps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"governanceGroups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"fallbackApprover":{"type":"boolean","example":false}}},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},{"description":"Role","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the access item","example":"The admin role"},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"enabled":{"type":"boolean","example":true},"requestable":{"type":"boolean","example":true,"description":"Indicates if the access can be requested"},"requestCommentsRequired":{"type":"boolean","description":"Indicates if comments are required when requesting access","example":false},"owner":{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}}]},{"type":"object","properties":{"email":{"type":"string","example":"john.doe@sailpoint.com","description":"The email of the identity"}}}]}}}]},{"type":"object","properties":{"accessProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"accessProfileCount":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]}]},"examples":{"accessProfile":{"summary":"AccessProfile","value":{"id":"2c9180825a6c1adc015a71c9023f0818","name":"Cloud Eng","_type":"accessprofile","description":"Cloud Eng","created":"2017-02-24T20:21:23.145Z","modified":"2019-05-24T20:36:04.312Z","synced":"2020-02-18T05:30:20.414Z","enabled":true,"requestable":true,"requestCommentsRequired":false,"owner":{"id":"ff8081815757d36a015757d42e56031e","name":"SailPoint Support","type":"IDENTITY","email":"cloud-support@sailpoint.com"},"source":{"id":"ff8081815757d4fb0157588f3d9d008f","name":"Employees"},"entitlements":[{"id":"2c918084575812550157589064f33b89","name":"CN=Cloud Engineering,DC=sailpoint,DC=COM","description":"mull","attribute":"memberOf","value":"CN=Cloud Engineering,DC=sailpoint,DC=COM"}],"entitlementCount":1,"tags":["TAG_1","TAG_2"]}},"entitlement":{"summary":"Entitlement","value":{"id":"2c9180946ed0c43d016eec1a80892fbd","name":"entitlement.aa415ae7","_type":"entitlement","description":"null","attribute":"groups","value":"entitlement.aa415ae7","modified":"2019-12-09T19:19:50.154Z","created":"2018-12-07T01:07:48Z","synced":"2020-02-19T04:30:32.906Z","displayName":"entitlement.aa415ae7","source":{"id":"2c91808b6e9e6fb8016eec1a2b6f7b5f","name":"ODS-HR-Employees"},"owner":{"type":"IDENTITY","id":"2c9180858315595501831958427e5424","name":"Addie Lee"},"privileged":false,"identityCount":68,"tags":["TAG_1","TAG_2"]}},"event":{"summary":"Event","value":{"id":"e092842f-c904-4b59-aac8-2544abeeef4b","name":"Update Task Schedule Passed","_type":"event","created":"2020-02-17T16:23:18.327Z","synced":"2020-02-17T16:23:18.388Z","action":"TASK_SCHEDULE_UPDATE_PASSED","type":"SYSTEM_CONFIG","actor":{"name":"MantisTaskScheduler"},"target":{"name":"Perform provisioning activity search delete synchronization"},"stack":"tpe","trackingNumber":"c6b98bc39ece48b080826d16c76b166c","ipAddress":"207.189.160.158","details":"null","attributes":{"sourceName":"SailPoint"},"objects":["TASK","SCHEDULE"],"operation":"UPDATE","status":"PASSED","technicalName":"TASK_SCHEDULE_UPDATE_PASSED"}},"identity":{"summary":"Identity","value":{"id":"2c9180865c45e7e3015c46c434a80622","name":"ad.admin","_type":"identity","firstName":"AD","lastName":"Admin","displayName":"AD Admin","email":"SLPT.CLOUD.SAILPOINT.TEST+AD-ADMIN@GMAIL.COM","created":"2018-08-22T19:54:54.302Z","modified":"2018-08-22T19:54:54.302Z","synced":"2018-08-22T19:54:54.302Z","phone":"512-942-7578","inactive":false,"protected":false,"status":"UNREGISTERED","employeeNumber":"O349804","manager":null,"isManager":false,"identityProfile":{"id":"2c918085605c8d0601606f357cb231e6","name":"E2E AD"},"source":{"id":"2c9180855c45b230015c46c19b9c0202","name":"EndToEnd-ADSource"},"attributes":{"uid":"ad.admin","firstname":"AD","cloudAuthoritativeSource":"2c9180855c45b230015c46c19b9c0202","cloudStatus":"UNREGISTERED","iplanet-am-user-alias-list":null,"displayName":"AD Admin","internalCloudStatus":"UNREGISTERED","workPhone":"512-942-7578","email":"SLPT.CLOUD.SAILPOINT.TEST+AD-ADMIN@GMAIL.COM","lastname":"Admin"},"processingState":null,"processingDetails":null,"accounts":[{"id":"2c9180865c45e7e3015c46c434a80623","name":"ad.admin","accountId":"CN=AD Admin,OU=slpt-automation,DC=TestAutomationAD,DC=local","source":{"id":"2c9180855c45b230015c46c19b9c0202","name":"EndToEnd-ADSource","type":"Active Directory - Direct"},"disabled":false,"locked":false,"privileged":false,"manuallyCorrelated":false,"passwordLastSet":"2018-08-22T19:54:54.302Z","entitlementAttributes":{"memberOf":["CN=Group Policy Creator Owners,CN=Users,DC=TestAutomationAD,DC=local","CN=Domain Guests,CN=Users,DC=TestAutomationAD,DC=local","CN=Domain Admins,CN=Users,DC=TestAutomationAD,DC=local","CN=Enterprise Admins,CN=Users,DC=TestAutomationAD,DC=local","CN=Schema Admins,CN=Users,DC=TestAutomationAD,DC=local","CN=Guests,CN=Builtin,DC=TestAutomationAD,DC=local","CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local"]},"created":"2018-08-22T19:54:54.302Z"},{"id":"2c918083606d670c01606f35a30a0349","name":"ad.admin","accountId":"ad.admin","source":{"id":"ff8081815c46b85b015c46b90c7c02a6","name":"IdentityNow","type":"IdentityNowConnector"},"disabled":false,"locked":false,"privileged":false,"manuallyCorrelated":false,"passwordLastSet":null,"entitlementAttributes":null,"created":"2018-08-22T19:54:54.302Z"}],"accountCount":2,"apps":[{"id":"22751","name":"ADP Workforce Now","source":{"id":"2c9180855c45b230015c46e2f6a8026a","name":"Corporate Active Directory"},"account":{"id":"2c9180865c45efa4015c470be0de1606","accountId":"CN=Bob Wilson,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com"}}],"appCount":1,"access":[{"id":"2c918083634bc6cb01639808d40270ba","name":"test [AccessProfile-1527264105448]","displayName":"test","type":"ACCESS_PROFILE","description":"test","source":{"id":"2c9180855c45b230015c46c19b9c0202","name":"EndToEnd-ADSource"},"owner":{"id":"2c9180865c45e7e3015c46c434a80622","name":"ad.admin","displayName":"AD Admin"}},{"id":"2c9180865c45e7e3015c46c457c50755","name":"Administrators","displayName":"Administrators","type":"ENTITLEMENT","description":null,"source":{"id":"2c9180855c45b230015c46c19b9c0202","name":"EndToEnd-ADSource"},"privileged":false,"attribute":"memberOf","value":"CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local","standalone":false},{"id":"2c9180865decdaa5015e06598b293108","name":"test [cloudRole-1503345085223]","displayName":"test","type":"ROLE","description":"test","owner":{"id":"2c9180865c45e7e3015c46c5030707a0","name":"will.albin","displayName":"Albin Will"},"disabled":false}],"accessCount":3,"accessProfileCount":1,"entitlementCount":1,"roleCount":1,"tags":["TAG_1","TAG_2"]}},"role":{"summary":"Role","value":{"id":"2c91808c6faadea6016fb4f2bc69077b","name":"IT Role","_type":"role","description":"IT role","created":"2020-01-17T19:20:15.040Z","modified":null,"synced":"2020-02-18T05:30:20.145Z","enabled":true,"requestable":false,"requestCommentsRequired":false,"owner":{"id":"2c9180a46faadee4016fb4e018c20639","name":"Cloud Support","type":"IDENTITY","email":"thomas.edison@acme-solar.com"},"accessProfiles":[{"id":"2c91809c6faade77016fb4f0b63407ae","name":"Admin Access"}],"accessProfileCount":1,"tags":["TAG_1","TAG_2"]}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/search/{index}/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Get a Document by ID","description":{"content":"Fetches a single document from the specified index, using the specified document ID.","type":"text/plain"},"url":{"path":["search",":index",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The index from which to fetch the specified document.\n\nThe currently supported index names are: *accessprofiles*, *accountactivities*, *accounts*, *aggregations*, *entitlements*, *events*, *identities*, and *roles*.\n","type":"text/plain"},"type":"any","value":"","key":"index"},{"disabled":false,"description":{"content":"(Required) ID of the requested document.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get a Document by ID' (search-get)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Get a Document by ID + + + +Fetches a single document from the specified index, using the specified document ID. + +
    Path Parameters
    + +The requested document. + +
    Schema
      oneOf
      owner object
      source object
      entitlements object[]
      requester object
      recipient object
      approvals object[]
      comments object[]
      owner object
      originalRequests object[]
      attributeRequests object[]
      source object
      expansionItems object[]
      attributeRequests object[]
      source object
      accountRequests object[]
      attributeRequests object[]
      provisioningTarget object
      result object
      source object
      source object
      entitlementAttributes object
      + +a map or dictionary of key/value pairs + +
      attributes object
      + +a map or dictionary of key/value pairs + +
      identity object
      access object[]
      source object
      source object
      actor object
      target object
      attributes object
      manager object
      identityProfile object
      source object
      attributes object
      + +a map or dictionary of key/value pairs + +
      processingDetails object
      accounts object[]
      + +List of accounts associated with the identity + +
      source object
      entitlementAttributes object
      + +a map or dictionary of key/value pairs + +
      apps object[]
      + +The list of applications the identity has access to + +
      source object
      account object
      access object[]
      + +The list of access items assigned to the identity + +
      oneOf
      source object
      owner object
      source object
      owner object
      owns object
      sources object[]
      entitlements object[]
      accessProfiles object[]
      roles object[]
      apps object[]
      governanceGroups object[]
      owner object
      accessProfiles object[]

    AccessProfile

    Entitlement

    Event

    Identity

    Role

    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/search-post.api.mdx b/products/idn/api/v3/search-post.api.mdx new file mode 100644 index 000000000..64edcbeab --- /dev/null +++ b/products/idn/api/v3/search-post.api.mdx @@ -0,0 +1,183 @@ +--- +id: search-post +sidebar_label: Perform Search +hide_title: true +hide_table_of_contents: true +api: {"tags":["Search"],"description":"Performs a search with the provided query and returns a matching result collection. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. ","externalDocs":{"description":"Learn more about search.","url":"https://documentation.sailpoint.com/saas/help/search/index.html"},"operationId":"searchPost","parameters":[{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}},{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}},{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"indices":{"description":"The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched.","externalDocs":{"description":"Learn more about search indices here.","url":"https://documentation.sailpoint.com/saas/help/search/searchable-fields.html"},"type":"array","items":{"description":"Enum representing the currently supported indices.\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofiles","accountactivities","entitlements","events","identities","roles","*"],"example":"identities"},"example":["identities"]},"queryType":{"description":"The type of query to use. By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body.\nTo use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly.\nAdditional values may be added in the future without notice.","type":"string","enum":["DSL","SAILPOINT","TYPEAHEAD"],"default":"SAILPOINT","example":"SAILPOINT"},"queryVersion":{"allOf":[{"description":"The current Elasticserver version.","type":"string","default":"5.2","example":"5.2"},{"type":"string","description":"The version of the query object.\nThis version number will map to the version of Elasticsearch for the query strings and objects being used."}]},"query":{"type":"object","description":"Query parameters used to construct an Elasticsearch query object.","properties":{"query":{"description":"The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.","type":"string","example":"name:a*"},"fields":{"description":"The fields to which the specified query will be applied. The available fields are dependent on the indice(s) being searched on. Please refer to the response schema of this API for a list of available fields.","type":"array","items":{"type":"string"},"example":["name"]},"timeZone":{"description":"The time zone to be applied to any range query related to dates.","type":"string","example":"America/Chicago"},"innerHit":{"description":"The innerHit query object returns a flattened list of results for the specified nested type.","type":"object","required":["query","type"],"properties":{"query":{"description":"The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.","type":"string","example":"source.name:\\\"Active Directory\\\""},"type":{"description":"The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document \"nested\" within another document. For example, an identity can have nested documents for access, accounts, and apps.","type":"string","example":"access"}}}}},"queryDsl":{"description":"The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax.","type":"object","example":{"match":{"name":"john.doe"}}},"typeAheadQuery":{"type":"object","description":"Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing \"Jo\" results in top hits matching \"Jo.\" Typing \"Job\" results in top hits matching \"Job.\" ","required":["query","field"],"properties":{"query":{"description":"The type ahead query string used to construct a phrase prefix match query.","type":"string","example":"Work"},"field":{"description":"The field on which to perform the type ahead search.","type":"string","example":"source.name"},"nestedType":{"description":"The nested type.","type":"string","example":"access"},"maxExpansions":{"description":"The number of suffixes the last term will be expanded into.\nInfluences the performance of the query and the number results returned.\nValid values: 1 to 1000.","type":"integer","format":"int32","minimum":1,"maximum":1000,"default":10,"example":10}}},"includeNested":{"description":"Indicates whether nested objects from returned search results should be included.","type":"boolean","default":true,"example":true},"queryResultFilter":{"type":"object","description":"Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents.","properties":{"includes":{"description":"The list of field names to include in the result documents.","type":"array","items":{"type":"string"},"example":["name","displayName"]},"excludes":{"description":"The list of field names to exclude from the result documents.","type":"array","items":{"type":"string"},"example":["stacktrace"]}}},"aggregationType":{"description":"Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["DSL","SAILPOINT"],"default":"DSL","example":"DSL"},"aggregationsVersion":{"allOf":[{"description":"The current Elasticserver version.","type":"string","default":"5.2","example":"5.2"},{"type":"string","description":"The version of the language being used for aggregation queries.\nThis version number will map to the version of Elasticsearch for the aggregation query object."}]},"aggregationsDsl":{"description":"The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax.","type":"object","example":{}},"aggregations":{"description":"The aggregation’s specifications, such as the groupings and calculations to be performed.\n","allOf":[{"type":"object","properties":{"nested":{"type":"object","description":"The nested aggregation object.","required":["name","type"],"properties":{"name":{"description":"The name of the nested aggregate to be included in the result.","type":"string","example":"id"},"type":{"description":"The type of the nested object.","type":"string","example":"access"}}},"metric":{"type":"object","description":"The calculation done on the results of the query","required":["name","field"],"properties":{"name":{"description":"The name of the metric aggregate to be included in the result.\nIf the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results.","type":"string","example":"Access Name Count"},"type":{"description":"Enum representing the currently supported metric aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["COUNT","UNIQUE_COUNT","AVG","SUM","MEDIAN","MIN","MAX"],"default":"UNIQUE_COUNT","example":"COUNT"},"field":{"description":"The field the calculation is performed on.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"@access.name"}}},"filter":{"type":"object","description":"An additional filter to constrain the results of the search query.","required":["name","field","value"],"properties":{"name":{"description":"The name of the filter aggregate to be included in the result.","type":"string","example":"Entitlements"},"type":{"description":"Enum representing the currently supported filter aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERM"],"default":"TERM","example":"TERM"},"field":{"description":"The search field to apply the filter to.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"access.type"},"value":{"description":"The value to filter on.","type":"string","example":"ENTITLEMENT"}}},"bucket":{"type":"object","description":"The bucket to group the results of the aggregation query by.","required":["name","field"],"properties":{"name":{"description":"The name of the bucket aggregate to be included in the result.","type":"string","example":"Identity Locations"},"type":{"description":"Enum representing the currently supported bucket aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERMS"],"default":"TERMS","example":"TERMS"},"field":{"description":"The field to bucket on.\nPrefix the field name with '@' to reference a nested object.","type":"string","example":"attributes.city"},"size":{"description":"Maximum number of buckets to include.","type":"integer","format":"int32","example":100},"minDocCount":{"description":"Minimum number of documents a bucket should have.","type":"integer","format":"int32","example":2}}}}},{"type":"object","properties":{"subAggregation":{"description":"Aggregation to be performed on the result of the parent bucket aggregation.","allOf":[{"type":"object","properties":{"nested":{"type":"object","description":"The nested aggregation object.","required":["name","type"],"properties":{"name":{"description":"The name of the nested aggregate to be included in the result.","type":"string","example":"id"},"type":{"description":"The type of the nested object.","type":"string","example":"access"}}},"metric":{"type":"object","description":"The calculation done on the results of the query","required":["name","field"],"properties":{"name":{"description":"The name of the metric aggregate to be included in the result.\nIf the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results.","type":"string","example":"Access Name Count"},"type":{"description":"Enum representing the currently supported metric aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["COUNT","UNIQUE_COUNT","AVG","SUM","MEDIAN","MIN","MAX"],"default":"UNIQUE_COUNT","example":"COUNT"},"field":{"description":"The field the calculation is performed on.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"@access.name"}}},"filter":{"type":"object","description":"An additional filter to constrain the results of the search query.","required":["name","field","value"],"properties":{"name":{"description":"The name of the filter aggregate to be included in the result.","type":"string","example":"Entitlements"},"type":{"description":"Enum representing the currently supported filter aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERM"],"default":"TERM","example":"TERM"},"field":{"description":"The search field to apply the filter to.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"access.type"},"value":{"description":"The value to filter on.","type":"string","example":"ENTITLEMENT"}}},"bucket":{"type":"object","description":"The bucket to group the results of the aggregation query by.","required":["name","field"],"properties":{"name":{"description":"The name of the bucket aggregate to be included in the result.","type":"string","example":"Identity Locations"},"type":{"description":"Enum representing the currently supported bucket aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERMS"],"default":"TERMS","example":"TERMS"},"field":{"description":"The field to bucket on.\nPrefix the field name with '@' to reference a nested object.","type":"string","example":"attributes.city"},"size":{"description":"Maximum number of buckets to include.","type":"integer","format":"int32","example":100},"minDocCount":{"description":"Minimum number of documents a bucket should have.","type":"integer","format":"int32","example":2}}}}},{"type":"object","properties":{"subAggregation":{"type":"object","properties":{"nested":{"type":"object","description":"The nested aggregation object.","required":["name","type"],"properties":{"name":{"description":"The name of the nested aggregate to be included in the result.","type":"string","example":"id"},"type":{"description":"The type of the nested object.","type":"string","example":"access"}}},"metric":{"type":"object","description":"The calculation done on the results of the query","required":["name","field"],"properties":{"name":{"description":"The name of the metric aggregate to be included in the result.\nIf the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results.","type":"string","example":"Access Name Count"},"type":{"description":"Enum representing the currently supported metric aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["COUNT","UNIQUE_COUNT","AVG","SUM","MEDIAN","MIN","MAX"],"default":"UNIQUE_COUNT","example":"COUNT"},"field":{"description":"The field the calculation is performed on.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"@access.name"}}},"filter":{"type":"object","description":"An additional filter to constrain the results of the search query.","required":["name","field","value"],"properties":{"name":{"description":"The name of the filter aggregate to be included in the result.","type":"string","example":"Entitlements"},"type":{"description":"Enum representing the currently supported filter aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERM"],"default":"TERM","example":"TERM"},"field":{"description":"The search field to apply the filter to.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"access.type"},"value":{"description":"The value to filter on.","type":"string","example":"ENTITLEMENT"}}},"bucket":{"type":"object","description":"The bucket to group the results of the aggregation query by.","required":["name","field"],"properties":{"name":{"description":"The name of the bucket aggregate to be included in the result.","type":"string","example":"Identity Locations"},"type":{"description":"Enum representing the currently supported bucket aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERMS"],"default":"TERMS","example":"TERMS"},"field":{"description":"The field to bucket on.\nPrefix the field name with '@' to reference a nested object.","type":"string","example":"attributes.city"},"size":{"description":"Maximum number of buckets to include.","type":"integer","format":"int32","example":100},"minDocCount":{"description":"Minimum number of documents a bucket should have.","type":"integer","format":"int32","example":2}}}},"description":"Aggregation to be performed on the result of the parent bucket aggregation."}}}]}}}]},"sort":{"description":"The fields to be used to sort the search results. Use + or - to specify the sort direction.","type":"array","items":{"type":"string","example":["displayName","+id"]}},"searchAfter":{"description":"Used to begin the search window at the values specified.\nThis parameter consists of the last values of the sorted fields in the current record set.\nThis is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value.\nIt is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging.\nFor example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example [\"displayName\", \"id\"]. \nIf the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is \"John Doe\", then using that displayName and ID will start a new search after this identity.\nThe searchAfter value will look like [\"John Doe\",\"2c91808375d8e80a0175e1f88a575221\"]","type":"array","items":{"type":"string","example":["John Doe","2c91808375d8e80a0175e1f88a575221"]}},"filters":{"description":"The filters to be applied for each filtered field name.","type":"object","additionalProperties":{"type":"object","properties":{"type":{"description":"Enum representing the currently supported filter types.\nAdditional values may be added in the future without notice.","type":"string","enum":["EXISTS","RANGE","TERMS"],"example":"RANGE"},"range":{"type":"object","description":"The range of values to be filtered.","properties":{"lower":{"description":"The lower bound of the range.","type":"object","required":["value"],"properties":{"value":{"description":"The value of the range's endpoint.","type":"string","example":"1"},"inclusive":{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}},"upper":{"description":"The upper bound of the range.","type":"object","required":["value"],"properties":{"value":{"description":"The value of the range's endpoint.","type":"string","example":"1"},"inclusive":{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}}}},"terms":{"description":"The terms to be filtered.","type":"array","items":{"type":"string","example":"account_count"}},"exclude":{"description":"Indicates if the filter excludes results.","type":"boolean","default":false,"example":false}}},"example":{}}}},"examples":{"query-fields":{"summary":"Query with Fields","value":{"indices":["identities"],"query":{"query":"\"John Doe\"","fields":["name"]}}},"query-timeZone":{"summary":"Query with TimeZone","value":{"indices":["identities"],"query":{"query":"created: [2022-05-19T19:26:03.351Z TO now]","timeZone":"America/Los_Angeles"}}},"query-innerHit":{"summary":"Query with InnerHit","value":{"indices":["identities"],"query":{"query":"\"John Doe\"","innerHit":{"type":"access","query":"source.name:\\\"Active Directory\\\""}}}},"typeAheadQuery":{"summary":"TypeAheadQuery","value":{"indices":["identities"],"queryType":"TYPEAHEAD","typeAheadQuery":{"field":"name","query":"Jo","maxExpansions":50}}},"typeAheadQuery-nestedType":{"summary":"TypeAheadQuery with NestedType","value":{"indices":["identities"],"queryType":"TYPEAHEAD","typeAheadQuery":{"field":"source.name","nestedType":"access","query":"Work","maxExpansions":50}}},"filter-exists":{"summary":"Filter with Exists","value":{"indices":["identities"],"query":{"query":"attributes.city:London"},"filters":{"attributes.cloudAuthoritativeSource":{"type":"EXISTS","exclude":true}}}},"filter-range":{"summary":"Filter with Range","value":{"indices":["identities"],"query":{"query":"attributes.city:London","timeZone":"Europe/London"},"filters":{"accessCount":{"type":"RANGE","range":{"lower":{"value":"3"}}},"created":{"type":"RANGE","range":{"lower":{"value":"2019-12-01","inclusive":true},"upper":{"value":"2020-01-01"}}}}}},"filter-terms":{"summary":"Filter with Terms","value":{"indices":["identities"],"query":{"query":"attributes.city:London"},"filters":{"source.name":{"type":"TERMS","terms":["HR Employees","Corporate Active Directory"],"exclude":true},"protected":{"type":"TERMS","terms":["true"]}}}}}}},"required":true},"responses":{"200":{"description":"List of matching documents.","content":{"application/json":{"schema":{"type":"array","items":{"discriminator":{"propertyName":"_type","mapping":{"accessprofile":{"description":"This is more of a complete representation of an access profile. ","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the access item","example":"The admin role"},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"enabled":{"type":"boolean","example":true},"requestable":{"type":"boolean","example":true,"description":"Indicates if the access can be requested"},"requestCommentsRequired":{"type":"boolean","description":"Indicates if comments are required when requesting access","example":false},"owner":{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}}]},{"type":"object","properties":{"email":{"type":"string","example":"john.doe@sailpoint.com","description":"The email of the identity"}}}]}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"entitlements":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"A description of the entitlement","example":"The admin privilege"},"attribute":{"type":"string","description":"The name of the entitlement attribute","example":"admin"},"value":{"type":"string","description":"The value of the entitlement","example":"true"}}}]}},"entitlementCount":{"type":"integer","example":5},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},"accountactivity":{"description":"AccountActivity","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"type":"object","properties":{"action":{"type":"string","description":"The type of action that this activity performed","externalDocs":{"description":"Learn more about account activity action types","url":"https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data"},"example":"Identity Refresh."},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"stage":{"type":"string","description":"The current stage of the activity","example":"Completed"},"origin":{"type":"string","nullable":true,"example":null},"status":{"type":"string","description":"the current status of the activity","example":"Complete"},"requester":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"recipient":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"trackingNumber":{"type":"string","example":"61aad0c9e8134eca89e76a35e0cabe3f"},"errors":{"type":"array","items":{"type":"string"},"nullable":true,"example":null},"warnings":{"type":"array","items":{"type":"string"},"nullable":true,"example":null},"approvals":{"type":"array","items":{"type":"object","properties":{"comments":{"type":"array","items":{"type":"object","properties":{"comment":{"type":"string","description":"The comment text","example":"This request was autoapproved by our automated ETS subscriber."},"commenter":{"type":"string","description":"The name of the commenter","example":"Automated AR Approval"},"date":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}}}},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"result":{"type":"string","description":"The result of the approval","example":"Finished"},"type":{"type":"string","nullable":true,"example":null}}}},"originalRequests":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","description":"the account id","example":"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com"},"attributeRequests":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name","example":"groups"},"op":{"type":"string","description":"The operation to perform","example":"Add"},"value":{"type":"string","description":"The value of the attribute","example":"3203537556531076"}}}},"op":{"type":"string","description":"the operation that was used","example":"add"},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]}}}},"expansionItems":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","description":"The ID of the account","example":"2c91808981f58ea601821c3e93482e6f"},"cause":{"type":"string","example":"Role"},"name":{"type":"string","description":"The name of the item","example":"smartsheet-role"},"attributeRequests":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name","example":"groups"},"op":{"type":"string","description":"The operation to perform","example":"Add"},"value":{"type":"string","description":"The value of the attribute","example":"3203537556531076"}}}},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]}}}},"accountRequests":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","description":"Unique ID of the account","example":"John.Doe"},"attributeRequests":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name","example":"groups"},"op":{"type":"string","description":"The operation to perform","example":"Add"},"value":{"type":"string","description":"The value of the attribute","example":"3203537556531076"}}}},"op":{"type":"string","example":"Modify","description":"The operation that was performed"},"provisioningTarget":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"result":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","example":"[ConnectorError] [\n {\n \"code\": \"unrecognized_keys\",\n \"keys\": [\n \"groups\"\n ],\n \"path\": [],\n \"message\": \"Unrecognized key(s) in object: 'groups'\"\n }\n] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e)"}},"status":{"type":"string","description":"The status of the account request","example":"failed"},"ticketId":{"type":"string","nullable":true,"example":null}}},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]}}}},"sources":{"type":"string","example":"smartsheet-test, airtable-v4, IdentityNow"}}}]},"account":{"description":"Account","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"accountId":{"type":"string","description":"The ID of the account","example":"john.doe"},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"disabled":{"type":"boolean","description":"Indicates if the account is disabled","example":false},"locked":{"type":"boolean","description":"Indicates if the account is locked","example":false},"privileged":{"type":"boolean","example":false},"manuallyCorrelated":{"type":"boolean","description":"Indicates if the account has been manually correlated to an identity","example":false},"passwordLastSet":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"entitlementAttributes":{"type":"object","nullable":true,"description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"moderator":true,"admin":true,"trust_level":"4"}},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}}}]},{"type":"object","properties":{"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"attributes":{"type":"object","description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"firstName":"John","lastName":"Doe","displayName":"John.Doe"}},"identity":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"access":{"type":"array","items":{"description":"EntitlementReference","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"attribute":{"type":"string","example":"memberOf"},"value":{"type":"string","example":"CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"},"standalone":{"type":"boolean","example":false}}}]}},"entitlementCount":{"type":"integer","description":"The number of entitlements assigned to the account","format":"int32","example":2},"uncorrelated":{"type":"boolean","description":"Indicates if the account is not correlated to an identity","example":false},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},"aggregation":{"description":"Aggregation","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"type":"object","properties":{"status":{"type":"string","example":"Success"},"duration":{"type":"integer","format":"int32","example":20},"avgDuration":{"type":"integer","format":"int32","example":20},"changedAccounts":{"type":"integer","format":"int32","example":1},"nextScheduled":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"startTime":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"sourceOwner":{"type":"string","description":"John Doe"}}}]},"entitlement":{"description":"Entitlement","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"A description of the entitlement","example":"The admin privilege"},"attribute":{"type":"string","description":"The name of the entitlement attribute","example":"admin"},"value":{"type":"string","description":"The value of the entitlement","example":"true"}}}]},{"type":"object","properties":{"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"displayName":{"type":"string","description":"The display name of the entitlement","example":"Admin"},"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"identityCount":{"type":"integer","format":"int32","example":3},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},"event":{"description":"Event","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"type":"object","properties":{"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"action":{"type":"string","description":"The action that was performed","example":"update"},"type":{"type":"string","description":"The type of event","example":"SYSTEM_CONFIG"},"actor":{"type":"object","properties":{"name":{"type":"string","example":"John Doe","description":"the actor or target name"},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}},"target":{"type":"object","properties":{"name":{"type":"string","example":"John Doe","description":"the actor or target name"},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}},"stack":{"type":"string","example":"tpe"},"trackingNumber":{"type":"string","example":"63f891e0735f4cc8bf1968144a1e7440"},"ipAddress":{"type":"string","example":"52.52.97.85"},"details":{"type":"string","example":"73b65dfbed1842548c207432a18c84b0"},"attributes":{"type":"object","additionalProperties":true,"example":{"pod":"stg03-useast1","org":"acme","sourceName":"SailPoint"}},"objects":{"type":"array","items":{"type":"string","example":"AUTHENTICATION"}},"operation":{"type":"string","example":"REQUEST"},"status":{"type":"string","example":"PASSED"},"technicalName":{"type":"string","example":"AUTHENTICATION_REQUEST_PASSED"}}}]},"identity":{"description":"Identity","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the identity","example":"Carol"},"lastName":{"type":"string","description":"The last name of the identity","example":"Adams"},"displayName":{"type":"string","example":"Carol.Adams","description":"The display name of the identity"},"email":{"type":"string","description":"The identity's primary email address","example":"Carol.Adams@sailpointdemo.com"},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"phone":{"type":"string","description":"The phone number of the identity","example":"+1 440-527-3672"},"inactive":{"type":"boolean","description":"Indicates if the identity is inactive","example":false},"protected":{"type":"boolean","example":false},"status":{"type":"string","description":"The identity's status in SailPoint","example":"UNREGISTERED"},"employeeNumber":{"type":"string","example":"1a2a3d4e"},"manager":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}],"nullable":true},"isManager":{"type":"boolean","description":"Indicates if this identity is a manager of other identities","example":false},"identityProfile":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"attributes":{"type":"object","description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"country":"US","firstname":"Carol","cloudStatus":"UNREGISTERED"}},"processingState":{"type":"string","nullable":true,"example":null},"processingDetails":{"nullable":true,"type":"object","properties":{"date":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"stage":{"type":"string","example":"In Process"},"retryCount":{"type":"integer","example":0,"format":"int32"},"stackTrace":{"type":"string","example":""},"message":{"type":"string","example":""}}},"accounts":{"type":"array","description":"List of accounts associated with the identity","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"accountId":{"type":"string","description":"The ID of the account","example":"john.doe"},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"disabled":{"type":"boolean","description":"Indicates if the account is disabled","example":false},"locked":{"type":"boolean","description":"Indicates if the account is locked","example":false},"privileged":{"type":"boolean","example":false},"manuallyCorrelated":{"type":"boolean","description":"Indicates if the account has been manually correlated to an identity","example":false},"passwordLastSet":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"entitlementAttributes":{"type":"object","nullable":true,"description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"moderator":true,"admin":true,"trust_level":"4"}},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}}}]}},"accountCount":{"type":"integer","description":"Number of accounts associated with the identity","format":"int32","example":3},"apps":{"type":"array","description":"The list of applications the identity has access to","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"account":{"type":"object","properties":{"id":{"type":"string","description":"The SailPoint generated unique ID","example":"2c9180837dfe6949017e21f3d8cd6d49"},"accountId":{"type":"string","description":"The account ID generated by the source","example":"CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"}}}}}]}},"appCount":{"type":"integer","format":"int32","description":"The number of applications the identity has access to","example":2},"access":{"type":"array","description":"The list of access items assigned to the identity","items":{"discriminator":{"propertyName":"type","mapping":{"ACCESS_PROFILE":{"description":"This is a summary representation of an access profile.","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"revocable":{"type":"boolean","example":true}}}]},"ENTITLEMENT":{"description":"EntitlementReference","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"attribute":{"type":"string","example":"memberOf"},"value":{"type":"string","example":"CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"},"standalone":{"type":"boolean","example":false}}}]},"ROLE":{"description":"Role","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"disabled":{"type":"boolean"},"revocable":{"type":"boolean"}}}]}}},"oneOf":[{"description":"This is a summary representation of an access profile.","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"revocable":{"type":"boolean","example":true}}}]},{"description":"EntitlementReference","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"attribute":{"type":"string","example":"memberOf"},"value":{"type":"string","example":"CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"},"standalone":{"type":"boolean","example":false}}}]},{"description":"Role","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"disabled":{"type":"boolean"},"revocable":{"type":"boolean"}}}]}]}},"accessCount":{"type":"integer","format":"int32","description":"The number of access items assigned to the identity","example":5},"accessProfileCount":{"type":"integer","description":"The number of access profiles assigned to the identity","example":1},"entitlementCount":{"type":"integer","description":"The number of entitlements assigned to the identity","example":10},"roleCount":{"type":"integer","description":"The number of roles assigned to the identity","example":1},"owns":{"type":"object","properties":{"sources":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"entitlements":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"accessProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"apps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"governanceGroups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"fallbackApprover":{"type":"boolean","example":false}}},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},"role":{"description":"Role","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the access item","example":"The admin role"},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"enabled":{"type":"boolean","example":true},"requestable":{"type":"boolean","example":true,"description":"Indicates if the access can be requested"},"requestCommentsRequired":{"type":"boolean","description":"Indicates if comments are required when requesting access","example":false},"owner":{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}}]},{"type":"object","properties":{"email":{"type":"string","example":"john.doe@sailpoint.com","description":"The email of the identity"}}}]}}}]},{"type":"object","properties":{"accessProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"accessProfileCount":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]}}},"oneOf":[{"description":"This is more of a complete representation of an access profile. ","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the access item","example":"The admin role"},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"enabled":{"type":"boolean","example":true},"requestable":{"type":"boolean","example":true,"description":"Indicates if the access can be requested"},"requestCommentsRequired":{"type":"boolean","description":"Indicates if comments are required when requesting access","example":false},"owner":{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}}]},{"type":"object","properties":{"email":{"type":"string","example":"john.doe@sailpoint.com","description":"The email of the identity"}}}]}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"entitlements":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"A description of the entitlement","example":"The admin privilege"},"attribute":{"type":"string","description":"The name of the entitlement attribute","example":"admin"},"value":{"type":"string","description":"The value of the entitlement","example":"true"}}}]}},"entitlementCount":{"type":"integer","example":5},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},{"description":"AccountActivity","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"type":"object","properties":{"action":{"type":"string","description":"The type of action that this activity performed","externalDocs":{"description":"Learn more about account activity action types","url":"https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data"},"example":"Identity Refresh."},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"stage":{"type":"string","description":"The current stage of the activity","example":"Completed"},"origin":{"type":"string","nullable":true,"example":null},"status":{"type":"string","description":"the current status of the activity","example":"Complete"},"requester":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"recipient":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"trackingNumber":{"type":"string","example":"61aad0c9e8134eca89e76a35e0cabe3f"},"errors":{"type":"array","items":{"type":"string"},"nullable":true,"example":null},"warnings":{"type":"array","items":{"type":"string"},"nullable":true,"example":null},"approvals":{"type":"array","items":{"type":"object","properties":{"comments":{"type":"array","items":{"type":"object","properties":{"comment":{"type":"string","description":"The comment text","example":"This request was autoapproved by our automated ETS subscriber."},"commenter":{"type":"string","description":"The name of the commenter","example":"Automated AR Approval"},"date":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}}}},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"result":{"type":"string","description":"The result of the approval","example":"Finished"},"type":{"type":"string","nullable":true,"example":null}}}},"originalRequests":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","description":"the account id","example":"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com"},"attributeRequests":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name","example":"groups"},"op":{"type":"string","description":"The operation to perform","example":"Add"},"value":{"type":"string","description":"The value of the attribute","example":"3203537556531076"}}}},"op":{"type":"string","description":"the operation that was used","example":"add"},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]}}}},"expansionItems":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","description":"The ID of the account","example":"2c91808981f58ea601821c3e93482e6f"},"cause":{"type":"string","example":"Role"},"name":{"type":"string","description":"The name of the item","example":"smartsheet-role"},"attributeRequests":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name","example":"groups"},"op":{"type":"string","description":"The operation to perform","example":"Add"},"value":{"type":"string","description":"The value of the attribute","example":"3203537556531076"}}}},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]}}}},"accountRequests":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","description":"Unique ID of the account","example":"John.Doe"},"attributeRequests":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name","example":"groups"},"op":{"type":"string","description":"The operation to perform","example":"Add"},"value":{"type":"string","description":"The value of the attribute","example":"3203537556531076"}}}},"op":{"type":"string","example":"Modify","description":"The operation that was performed"},"provisioningTarget":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"result":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","example":"[ConnectorError] [\n {\n \"code\": \"unrecognized_keys\",\n \"keys\": [\n \"groups\"\n ],\n \"path\": [],\n \"message\": \"Unrecognized key(s) in object: 'groups'\"\n }\n] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e)"}},"status":{"type":"string","description":"The status of the account request","example":"failed"},"ticketId":{"type":"string","nullable":true,"example":null}}},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]}}}},"sources":{"type":"string","example":"smartsheet-test, airtable-v4, IdentityNow"}}}]},{"description":"Account","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"accountId":{"type":"string","description":"The ID of the account","example":"john.doe"},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"disabled":{"type":"boolean","description":"Indicates if the account is disabled","example":false},"locked":{"type":"boolean","description":"Indicates if the account is locked","example":false},"privileged":{"type":"boolean","example":false},"manuallyCorrelated":{"type":"boolean","description":"Indicates if the account has been manually correlated to an identity","example":false},"passwordLastSet":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"entitlementAttributes":{"type":"object","nullable":true,"description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"moderator":true,"admin":true,"trust_level":"4"}},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}}}]},{"type":"object","properties":{"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"attributes":{"type":"object","description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"firstName":"John","lastName":"Doe","displayName":"John.Doe"}},"identity":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"access":{"type":"array","items":{"description":"EntitlementReference","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"attribute":{"type":"string","example":"memberOf"},"value":{"type":"string","example":"CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"},"standalone":{"type":"boolean","example":false}}}]}},"entitlementCount":{"type":"integer","description":"The number of entitlements assigned to the account","format":"int32","example":2},"uncorrelated":{"type":"boolean","description":"Indicates if the account is not correlated to an identity","example":false},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},{"description":"Aggregation","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"type":"object","properties":{"status":{"type":"string","example":"Success"},"duration":{"type":"integer","format":"int32","example":20},"avgDuration":{"type":"integer","format":"int32","example":20},"changedAccounts":{"type":"integer","format":"int32","example":1},"nextScheduled":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"startTime":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"sourceOwner":{"type":"string","description":"John Doe"}}}]},{"description":"Entitlement","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"A description of the entitlement","example":"The admin privilege"},"attribute":{"type":"string","description":"The name of the entitlement attribute","example":"admin"},"value":{"type":"string","description":"The value of the entitlement","example":"true"}}}]},{"type":"object","properties":{"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"displayName":{"type":"string","description":"The display name of the entitlement","example":"Admin"},"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"identityCount":{"type":"integer","format":"int32","example":3},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},{"description":"Event","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"type":"object","properties":{"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"action":{"type":"string","description":"The action that was performed","example":"update"},"type":{"type":"string","description":"The type of event","example":"SYSTEM_CONFIG"},"actor":{"type":"object","properties":{"name":{"type":"string","example":"John Doe","description":"the actor or target name"},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}},"target":{"type":"object","properties":{"name":{"type":"string","example":"John Doe","description":"the actor or target name"},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}},"stack":{"type":"string","example":"tpe"},"trackingNumber":{"type":"string","example":"63f891e0735f4cc8bf1968144a1e7440"},"ipAddress":{"type":"string","example":"52.52.97.85"},"details":{"type":"string","example":"73b65dfbed1842548c207432a18c84b0"},"attributes":{"type":"object","additionalProperties":true,"example":{"pod":"stg03-useast1","org":"acme","sourceName":"SailPoint"}},"objects":{"type":"array","items":{"type":"string","example":"AUTHENTICATION"}},"operation":{"type":"string","example":"REQUEST"},"status":{"type":"string","example":"PASSED"},"technicalName":{"type":"string","example":"AUTHENTICATION_REQUEST_PASSED"}}}]},{"description":"Identity","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the identity","example":"Carol"},"lastName":{"type":"string","description":"The last name of the identity","example":"Adams"},"displayName":{"type":"string","example":"Carol.Adams","description":"The display name of the identity"},"email":{"type":"string","description":"The identity's primary email address","example":"Carol.Adams@sailpointdemo.com"},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"phone":{"type":"string","description":"The phone number of the identity","example":"+1 440-527-3672"},"inactive":{"type":"boolean","description":"Indicates if the identity is inactive","example":false},"protected":{"type":"boolean","example":false},"status":{"type":"string","description":"The identity's status in SailPoint","example":"UNREGISTERED"},"employeeNumber":{"type":"string","example":"1a2a3d4e"},"manager":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}],"nullable":true},"isManager":{"type":"boolean","description":"Indicates if this identity is a manager of other identities","example":false},"identityProfile":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"attributes":{"type":"object","description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"country":"US","firstname":"Carol","cloudStatus":"UNREGISTERED"}},"processingState":{"type":"string","nullable":true,"example":null},"processingDetails":{"nullable":true,"type":"object","properties":{"date":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"stage":{"type":"string","example":"In Process"},"retryCount":{"type":"integer","example":0,"format":"int32"},"stackTrace":{"type":"string","example":""},"message":{"type":"string","example":""}}},"accounts":{"type":"array","description":"List of accounts associated with the identity","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"accountId":{"type":"string","description":"The ID of the account","example":"john.doe"},"source":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","example":"Delimited File","description":"the type of source returned"}}}]},"disabled":{"type":"boolean","description":"Indicates if the account is disabled","example":false},"locked":{"type":"boolean","description":"Indicates if the account is locked","example":false},"privileged":{"type":"boolean","example":false},"manuallyCorrelated":{"type":"boolean","description":"Indicates if the account has been manually correlated to an identity","example":false},"passwordLastSet":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"entitlementAttributes":{"type":"object","nullable":true,"description":"a map or dictionary of key/value pairs","additionalProperties":true,"example":{"moderator":true,"admin":true,"trust_level":"4"}},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}}}]}},"accountCount":{"type":"integer","description":"Number of accounts associated with the identity","format":"int32","example":3},"apps":{"type":"array","description":"The list of applications the identity has access to","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"account":{"type":"object","properties":{"id":{"type":"string","description":"The SailPoint generated unique ID","example":"2c9180837dfe6949017e21f3d8cd6d49"},"accountId":{"type":"string","description":"The account ID generated by the source","example":"CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"}}}}}]}},"appCount":{"type":"integer","format":"int32","description":"The number of applications the identity has access to","example":2},"access":{"type":"array","description":"The list of access items assigned to the identity","items":{"discriminator":{"propertyName":"type","mapping":{"ACCESS_PROFILE":{"description":"This is a summary representation of an access profile.","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"revocable":{"type":"boolean","example":true}}}]},"ENTITLEMENT":{"description":"EntitlementReference","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"attribute":{"type":"string","example":"memberOf"},"value":{"type":"string","example":"CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"},"standalone":{"type":"boolean","example":false}}}]},"ROLE":{"description":"Role","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"disabled":{"type":"boolean"},"revocable":{"type":"boolean"}}}]}}},"oneOf":[{"description":"This is a summary representation of an access profile.","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"revocable":{"type":"boolean","example":true}}}]},{"description":"EntitlementReference","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},"privileged":{"type":"boolean","example":false},"attribute":{"type":"string","example":"memberOf"},"value":{"type":"string","example":"CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"},"standalone":{"type":"boolean","example":false}}}]},{"description":"Role","allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"description":{"type":"string","nullable":true,"example":null}}}]},{"type":"object","properties":{"owner":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"displayName":{"type":"string","example":"John Q. Doe"}}}]},"disabled":{"type":"boolean"},"revocable":{"type":"boolean"}}}]}]}},"accessCount":{"type":"integer","format":"int32","description":"The number of access items assigned to the identity","example":5},"accessProfileCount":{"type":"integer","description":"The number of access profiles assigned to the identity","example":1},"entitlementCount":{"type":"integer","description":"The number of entitlements assigned to the identity","example":10},"roleCount":{"type":"integer","description":"The number of roles assigned to the identity","example":1},"owns":{"type":"object","properties":{"sources":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"entitlements":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"accessProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"apps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"governanceGroups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"fallbackApprover":{"type":"boolean","example":false}}},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]},{"description":"Role","allOf":[{"type":"object","required":["id","name","_type"],"properties":{"id":{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"},"name":{"type":"string","example":"john.doe"},"_type":{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity"}}},{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the access item","example":"The admin role"},"created":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"modified":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"synced":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"enabled":{"type":"boolean","example":true},"requestable":{"type":"boolean","example":true,"description":"Indicates if the access can be requested"},"requestCommentsRequired":{"type":"boolean","description":"Indicates if comments are required when requesting access","example":false},"owner":{"allOf":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"}}}]},{"type":"object","properties":{"email":{"type":"string","example":"john.doe@sailpoint.com","description":"The email of the identity"}}}]}}}]},{"type":"object","properties":{"accessProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."},"name":{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}}},"accessProfileCount":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"},"example":["TAG_1","TAG_2"]}}}]}]}},"examples":{"accessProfiles":{"summary":"A collection of AccessProfiles","value":[{"id":"2c9180825a6c1adc015a71c9023f0818","name":"Cloud Eng","_type":"accessprofile","description":"Cloud Eng","created":"2017-02-24T20:21:23.145Z","modified":"2019-05-24T20:36:04.312Z","synced":"2020-02-18T05:30:20.414Z","enabled":true,"requestable":true,"requestCommentsRequired":false,"owner":{"id":"ff8081815757d36a015757d42e56031e","name":"SailPoint Support","type":"IDENTITY","email":"cloud-support@sailpoint.com"},"source":{"id":"ff8081815757d4fb0157588f3d9d008f","name":"Employees"},"entitlements":[{"id":"2c918084575812550157589064f33b89","name":"CN=Cloud Engineering,DC=sailpoint,DC=COM","description":"mull","attribute":"memberOf","value":"CN=Cloud Engineering,DC=sailpoint,DC=COM"}],"entitlementCount":1,"tags":["TAG_1","TAG_2"]}]},"entitlements":{"summary":"A collection of Entitlements","value":[{"id":"2c9180946ed0c43d016eec1a80892fbd","name":"entitlement.aa415ae7","_type":"entitlement","description":"null","attribute":"groups","value":"entitlement.aa415ae7","modified":"2019-12-09T19:19:50.154Z","synced":"2020-02-19T04:30:32.906Z","displayName":"entitlement.aa415ae7","source":{"id":"2c91808b6e9e6fb8016eec1a2b6f7b5f","name":"ODS-HR-Employees"},"privileged":false,"identityCount":68,"tags":["TAG_1","TAG_2"]}]},"events":{"summary":"A collection of Events","value":[{"id":"e092842f-c904-4b59-aac8-2544abeeef4b","name":"Update Task Schedule Passed","_type":"event","created":"2020-02-17T16:23:18.327Z","synced":"2020-02-17T16:23:18.388Z","action":"TASK_SCHEDULE_UPDATE_PASSED","type":"SYSTEM_CONFIG","actor":{"name":"MantisTaskScheduler"},"target":{"name":"Perform provisioning activity search delete synchronization"},"stack":"tpe","trackingNumber":"c6b98bc39ece48b080826d16c76b166c","ipAddress":"207.189.160.158","details":"null","attributes":{"sourceName":"SailPoint"},"objects":["TASK","SCHEDULE"],"operation":"UPDATE","status":"PASSED","technicalName":"TASK_SCHEDULE_UPDATE_PASSED"}]},"identities":{"summary":"A collection of Identities","value":[{"id":"2c9180865c45e7e3015c46c434a80622","name":"ad.admin","_type":"identity","firstName":"AD","lastName":"Admin","displayName":"AD Admin","email":"SLPT.CLOUD.SAILPOINT.TEST+AD-ADMIN@GMAIL.COM","created":"2018-08-22T19:54:54.302Z","modified":"2018-08-22T19:54:54.302Z","synced":"2018-08-22T19:54:54.302Z","phone":"512-942-7578","inactive":false,"protected":false,"status":"UNREGISTERED","employeeNumber":"O349804","manager":null,"isManager":false,"identityProfile":{"id":"2c918085605c8d0601606f357cb231e6","name":"E2E AD"},"source":{"id":"2c9180855c45b230015c46c19b9c0202","name":"EndToEnd-ADSource"},"attributes":{"uid":"ad.admin","firstname":"AD","cloudAuthoritativeSource":"2c9180855c45b230015c46c19b9c0202","cloudStatus":"UNREGISTERED","iplanet-am-user-alias-list":null,"displayName":"AD Admin","internalCloudStatus":"UNREGISTERED","workPhone":"512-942-7578","email":"SLPT.CLOUD.SAILPOINT.TEST+AD-ADMIN@GMAIL.COM","lastname":"Admin"},"processingState":null,"processingDetails":null,"accounts":[{"id":"2c9180865c45e7e3015c46c434a80623","name":"ad.admin","accountId":"CN=AD Admin,OU=slpt-automation,DC=TestAutomationAD,DC=local","source":{"id":"2c9180855c45b230015c46c19b9c0202","name":"EndToEnd-ADSource","type":"Active Directory - Direct"},"disabled":false,"locked":false,"privileged":false,"manuallyCorrelated":false,"passwordLastSet":"2018-08-22T19:54:54.302Z","entitlementAttributes":{"memberOf":["CN=Group Policy Creator Owners,CN=Users,DC=TestAutomationAD,DC=local","CN=Domain Guests,CN=Users,DC=TestAutomationAD,DC=local","CN=Domain Admins,CN=Users,DC=TestAutomationAD,DC=local","CN=Enterprise Admins,CN=Users,DC=TestAutomationAD,DC=local","CN=Schema Admins,CN=Users,DC=TestAutomationAD,DC=local","CN=Guests,CN=Builtin,DC=TestAutomationAD,DC=local","CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local"]},"created":"2018-08-22T19:54:54.302Z"},{"id":"2c918083606d670c01606f35a30a0349","name":"ad.admin","accountId":"ad.admin","source":{"id":"ff8081815c46b85b015c46b90c7c02a6","name":"IdentityNow","type":"IdentityNowConnector"},"disabled":false,"locked":false,"privileged":false,"manuallyCorrelated":false,"passwordLastSet":null,"entitlementAttributes":null,"created":"2018-08-22T19:54:54.302Z"}],"accountCount":2,"apps":[{"id":"22751","name":"ADP Workforce Now","source":{"id":"2c9180855c45b230015c46e2f6a8026a","name":"Corporate Active Directory"},"account":{"id":"2c9180865c45efa4015c470be0de1606","accountId":"CN=Bob Wilson,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com"}}],"appCount":1,"access":[{"id":"2c918083634bc6cb01639808d40270ba","name":"test [AccessProfile-1527264105448]","displayName":"test","type":"ACCESS_PROFILE","description":"test","source":{"id":"2c9180855c45b230015c46c19b9c0202","name":"EndToEnd-ADSource"},"owner":{"id":"2c9180865c45e7e3015c46c434a80622","name":"ad.admin","displayName":"AD Admin"}},{"id":"2c9180865c45e7e3015c46c457c50755","name":"Administrators","displayName":"Administrators","type":"ENTITLEMENT","description":null,"source":{"id":"2c9180855c45b230015c46c19b9c0202","name":"EndToEnd-ADSource"},"privileged":false,"attribute":"memberOf","value":"CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local","standalone":false},{"id":"2c9180865decdaa5015e06598b293108","name":"test [cloudRole-1503345085223]","displayName":"test","type":"ROLE","description":"test","owner":{"id":"2c9180865c45e7e3015c46c5030707a0","name":"will.albin","displayName":"Albin Will"},"disabled":false}],"accessCount":3,"accessProfileCount":1,"entitlementCount":1,"roleCount":1,"tags":["TAG_1","TAG_2"]}]},"roles":{"summary":"A collection of Roles","value":[{"id":"2c91808c6faadea6016fb4f2bc69077b","name":"IT Role","_type":"role","description":"IT role","created":"2020-01-17T19:20:15.040Z","modified":null,"synced":"2020-02-18T05:30:20.145Z","enabled":true,"requestable":false,"requestCommentsRequired":false,"owner":{"id":"2c9180a46faadee4016fb4e018c20639","name":"Cloud Support","type":"IDENTITY","email":"thomas.edison@acme-solar.com"},"accessProfiles":[{"id":"2c91809c6faade77016fb4f0b63407ae","name":"Admin Access"}],"accessProfileCount":1,"tags":["TAG_1","TAG_2"]}]}}}},"headers":{"X-Total-Count":{"schema":{"type":"integer"},"description":"The total result count (returned only if the *count* parameter is specified as *true*).","example":30}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/search","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"indices":["identities"],"queryType":"SAILPOINT","queryVersion":"5.2","query":{"query":"name:a*","fields":["name"],"timeZone":"America/Chicago","innerHit":{"query":"source.name:\\\"Active Directory\\\"","type":"access"}},"queryDsl":{"match":{"name":"john.doe"}},"typeAheadQuery":{"query":"Work","field":"source.name","nestedType":"access","maxExpansions":10},"includeNested":true,"queryResultFilter":{"includes":["name","displayName"],"excludes":["stacktrace"]},"aggregationType":"DSL","aggregationsVersion":"5.2","aggregationsDsl":{},"aggregations":{"nested":{"name":"id","type":"access"},"metric":{"name":"Access Name Count","type":"COUNT","field":"@access.name"},"filter":{"name":"Entitlements","type":"TERM","field":"access.type","value":"ENTITLEMENT"},"bucket":{"name":"Identity Locations","type":"TERMS","field":"attributes.city","size":100,"minDocCount":2},"subAggregation":{"nested":{"name":"id","type":"access"},"metric":{"name":"Access Name Count","type":"COUNT","field":"@access.name"},"filter":{"name":"Entitlements","type":"TERM","field":"access.type","value":"ENTITLEMENT"},"bucket":{"name":"Identity Locations","type":"TERMS","field":"attributes.city","size":100,"minDocCount":2},"subAggregation":{"nested":{"name":"id","type":"access"},"metric":{"name":"Access Name Count","type":"COUNT","field":"@access.name"},"filter":{"name":"Entitlements","type":"TERM","field":"access.type","value":"ENTITLEMENT"},"bucket":{"name":"Identity Locations","type":"TERMS","field":"attributes.city","size":100,"minDocCount":2}}}},"sort":[["displayName","+id"]],"searchAfter":[["John Doe","2c91808375d8e80a0175e1f88a575221"]],"filters":{}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Perform Search","description":{"content":"Performs a search with the provided query and returns a matching result collection. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. ","type":"text/plain"},"url":{"path":["search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"offset","value":""},{"disabled":false,"description":{"content":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","type":"text/plain"},"key":"count","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Perform Search' (search-post)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Perform Search + + + +Performs a search with the provided query and returns a matching result collection. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. + +
    Query Parameters
    Request Body required
      query object
      + +Query parameters used to construct an Elasticsearch query object. + +
      innerHit object
      + +The innerHit query object returns a flattened list of results for the specified nested type. + +
      typeAheadQuery object
      + +Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing "Jo" results in top hits matching "Jo." Typing "Job" results in top hits matching "Job." + +
      = 1` and `<= 1000`"} defaultValue={10}>
      queryResultFilter object
      + +Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. + +
      aggregations object
      nested object
      + +The nested aggregation object. + +
      metric object
      + +The calculation done on the results of the query + +
      filter object
      + +An additional filter to constrain the results of the search query. + +
      bucket object
      + +The bucket to group the results of the aggregation query by. + +
      subAggregation object
      + +Aggregation to be performed on the result of the parent bucket aggregation. + +
      nested object
      + +The nested aggregation object. + +
      metric object
      + +The calculation done on the results of the query + +
      filter object
      + +An additional filter to constrain the results of the search query. + +
      bucket object
      + +The bucket to group the results of the aggregation query by. + +
      subAggregation object
      + +Aggregation to be performed on the result of the parent bucket aggregation. + +
      nested object
      + +The nested aggregation object. + +
      metric object
      + +The calculation done on the results of the query + +
      filter object
      + +An additional filter to constrain the results of the search query. + +
      bucket object
      + +The bucket to group the results of the aggregation query by. + +
      filters object
      + +The filters to be applied for each filtered field name. + +
    • property name* object
    + +List of matching documents. + +
    Response Headers
    • X-Total-Count integer
      Example: 30 + +The total result count (returned only if the *count* parameter is specified as *true*). + +
    Schema array
      oneOf
      owner object
      source object
      entitlements object[]
      requester object
      recipient object
      approvals object[]
      comments object[]
      owner object
      originalRequests object[]
      attributeRequests object[]
      source object
      expansionItems object[]
      attributeRequests object[]
      source object
      accountRequests object[]
      attributeRequests object[]
      provisioningTarget object
      result object
      source object
      source object
      entitlementAttributes object
      + +a map or dictionary of key/value pairs + +
      attributes object
      + +a map or dictionary of key/value pairs + +
      identity object
      access object[]
      source object
      source object
      actor object
      target object
      attributes object
      manager object
      identityProfile object
      source object
      attributes object
      + +a map or dictionary of key/value pairs + +
      processingDetails object
      accounts object[]
      + +List of accounts associated with the identity + +
      source object
      entitlementAttributes object
      + +a map or dictionary of key/value pairs + +
      apps object[]
      + +The list of applications the identity has access to + +
      source object
      account object
      access object[]
      + +The list of access items assigned to the identity + +
      oneOf
      source object
      owner object
      source object
      owner object
      owns object
      sources object[]
      entitlements object[]
      accessProfiles object[]
      roles object[]
      apps object[]
      governanceGroups object[]
      owner object
      accessProfiles object[]
    \",\n \"message\": \"\"\n },\n \"accounts\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"accountId\": \"john.doe\",\n \"source\": {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"type\": \"Delimited File\"\n },\n \"disabled\": false,\n \"locked\": false,\n \"privileged\": false,\n \"manuallyCorrelated\": false,\n \"passwordLastSet\": \"2018-06-25T20:22:28.104Z\",\n \"entitlementAttributes\": {\n \"moderator\": true,\n \"admin\": true,\n \"trust_level\": \"4\"\n },\n \"created\": \"2018-06-25T20:22:28.104Z\"\n }\n ],\n \"accountCount\": 3,\n \"apps\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"source\": {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\"\n },\n \"account\": {\n \"id\": \"2c9180837dfe6949017e21f3d8cd6d49\",\n \"accountId\": \"CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\"\n }\n }\n ],\n \"appCount\": 2,\n \"access\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"displayName\": \"John Q. Doe\",\n \"type\": \"IDENTITY\",\n \"description\": null,\n \"source\": {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\"\n },\n \"owner\": {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"displayName\": \"John Q. Doe\"\n },\n \"revocable\": true\n },\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"displayName\": \"John Q. Doe\",\n \"type\": \"IDENTITY\",\n \"description\": null,\n \"source\": {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\"\n },\n \"privileged\": false,\n \"attribute\": \"memberOf\",\n \"value\": \"CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com\",\n \"standalone\": false\n },\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"displayName\": \"John Q. Doe\",\n \"type\": \"IDENTITY\",\n \"description\": null,\n \"owner\": {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"displayName\": \"John Q. Doe\"\n },\n \"disabled\": true,\n \"revocable\": true\n }\n ],\n \"accessCount\": 5,\n \"accessProfileCount\": 1,\n \"entitlementCount\": 10,\n \"roleCount\": 1,\n \"owns\": {\n \"sources\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\"\n }\n ],\n \"entitlements\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\"\n }\n ],\n \"accessProfiles\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\"\n }\n ],\n \"roles\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\"\n }\n ],\n \"apps\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\"\n }\n ],\n \"governanceGroups\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\"\n }\n ],\n \"fallbackApprover\": false\n },\n \"tags\": [\n \"TAG_1\",\n \"TAG_2\"\n ]\n },\n {\n \"id\": true,\n \"name\": true,\n \"_type\": \"identity\",\n \"description\": \"The admin role\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"synced\": \"2018-06-25T20:22:28.104Z\",\n \"enabled\": true,\n \"requestable\": true,\n \"requestCommentsRequired\": false,\n \"owner\": {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\",\n \"type\": \"IDENTITY\",\n \"email\": \"john.doe@sailpoint.com\"\n },\n \"accessProfiles\": [\n {\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"John Doe\"\n }\n ],\n \"accessProfileCount\": 0,\n \"tags\": [\n \"TAG_1\",\n \"TAG_2\"\n ]\n }\n]"} language={"json"}>

    A collection of AccessProfiles

    A collection of Entitlements

    A collection of Events

    A collection of Identities

    A collection of Roles

    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/search.tag.mdx b/products/idn/api/v3/search.tag.mdx new file mode 100644 index 000000000..773e20bd1 --- /dev/null +++ b/products/idn/api/v3/search.tag.mdx @@ -0,0 +1,43 @@ +--- +id: search +title: "Search" +description: "Search" +custom_edit_url: null +--- + + + +Use this API to implement search functionality. +With search functionality in place, users can search their tenants for nearly any information from throughout their organizations. + +IdentityNow enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential. +Its search goes through all those sources and finds the results quickly and specifically. + +The search query is flexible - it can be very broad or very narrow. +The search only returns results for searchable objects it is filtering for. +The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities. +By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator." + +Users can further narrow their results by using IdentityNow's specific syntax and punctuation to structure their queries. +For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross. +Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries. + +Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about IdentityNow's search and its different possibilities. + +The search feature uses Elasticsearch as a datastore and query engine. +The power of Elasticsearch makes this feature suitable for ad-hoc reporting. +However, data from the operational databases (ex. identities, roles, events, etc) has to be ingested into Elasticsearch. +This ingestion process introduces a latency from when the operational data is created to when it is available in search. +Depending on the system load, this can take a few seconds to a few minutes. +Please keep this latency in mind when you use search. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/segments.tag.mdx b/products/idn/api/v3/segments.tag.mdx new file mode 100644 index 000000000..fe6a9112b --- /dev/null +++ b/products/idn/api/v3/segments.tag.mdx @@ -0,0 +1,16 @@ +--- +id: segments +title: "Segments" +description: "Segments" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/service-desk-integration.tag.mdx b/products/idn/api/v3/service-desk-integration.tag.mdx new file mode 100644 index 000000000..cf0b7fafc --- /dev/null +++ b/products/idn/api/v3/service-desk-integration.tag.mdx @@ -0,0 +1,44 @@ +--- +id: service-desk-integration +title: "Service Desk Integration" +description: "Service Desk Integration" +custom_edit_url: null +--- + + + +Use this API to build an integration between IdentityNow and a service desk ITSM (IT service management) solution. +Once an administrator builds this integration between IdentityNow and a service desk, users can use IdentityNow to raise and track tickets that are synchronized between IdentityNow and the service desk. + +In IdentityNow, administrators can create a service desk integration (sometimes also called an SDIM, or Service Desk Integration Module) by going to Admin > Connections > Service Desk and selecting 'Create.' + +To create a Generic Service Desk integration, for example, administrators must provide the required information on the General Settings page, the Connectivity and Authentication information, Ticket Creation information, Status Mapping information, and Requester Source information on the Configure page. +Refer to [Integrating SailPoint with Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) for more information about the process of setting up a Generic Service Desk in IdentityNow. + +Administrators can create various service desk integrations, all with their own nuances. +The following service desk integrations are available: + +- [Atlassian Cloud Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_cloud/help/integrating_jira_cloud_sd/introduction.html) + +- [Atlassian Server Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_server/help/integrating_jira_server_sd/introduction.html) + +- [BMC Helix ITSM Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_ITSM_sd/help/integrating_bmc_helix_itsm_sd/intro.html) + +- [BMC Helix Remedyforce Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_remedyforce_sd/help/integrating_bmc_helix_remedyforce_sd/intro.html) + +- [Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) + +- [ServiceNow Service Desk](https://documentation.sailpoint.com/connectors/servicenow/sdim/help/integrating_servicenow_sdim/intro.html) + +- [Zendesk Service Desk](https://documentation.sailpoint.com/connectors/zendesk/help/integrating_zendesk_sd/introduction.html) + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/set-lifecycle-state.api.mdx b/products/idn/api/v3/set-lifecycle-state.api.mdx new file mode 100644 index 000000000..ef7cc7d4f --- /dev/null +++ b/products/idn/api/v3/set-lifecycle-state.api.mdx @@ -0,0 +1,88 @@ +--- +id: set-lifecycle-state +sidebar_label: Set Lifecycle State +hide_title: true +hide_table_of_contents: true +api: {"operationId":"setLifecycleState","tags":["Lifecycle States"],"description":"This endpoint will set/update an identity's lifecycle state to the one provided and updates the corresponding Identity Profile.\nA token with ORG_ADMIN or API authority is required to call this API.","security":[{"oauth2":["idn:identity-lifecycle-state:update"]}],"parameters":[{"in":"path","name":"identity-id","description":"The ID of the identity to update","required":true,"example":"2c9180857893f1290178944561990364","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"lifecycleStateId":{"type":"string","description":"The ID of the lifecycle state to set","example":"2c9180877a86e408017a8c19fefe046c"}}}}}},"responses":{"200":{"description":"The request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object","properties":{"accountActivityId":{"type":"string","example":"2c9180837ab5b716017ab7c6c9ef1e20","description":"The ID of the IdentityRequest object that was generated when the workflow launches"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/identities/{identity-id}/set-lifecycle-state","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"lifecycleStateId":"2c9180877a86e408017a8c19fefe046c"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Set Lifecycle State","description":{"content":"This endpoint will set/update an identity's lifecycle state to the one provided and updates the corresponding Identity Profile.\nA token with ORG_ADMIN or API authority is required to call this API.","type":"text/plain"},"url":{"path":["identities",":identity-id","set-lifecycle-state"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the identity to update","type":"text/plain"},"type":"any","value":"","key":"identity-id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Set Lifecycle State' (set-lifecycle-state)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Set Lifecycle State + + + +This endpoint will set/update an identity's lifecycle state to the one provided and updates the corresponding Identity Profile. +A token with ORG_ADMIN or API authority is required to call this API. + +
    Path Parameters
    Request Body required
    + +The request was successfully accepted into the system. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/set-password.api.mdx b/products/idn/api/v3/set-password.api.mdx new file mode 100644 index 000000000..34039f373 --- /dev/null +++ b/products/idn/api/v3/set-password.api.mdx @@ -0,0 +1,116 @@ +--- +id: set-password +sidebar_label: Set Identity's Password +hide_title: true +hide_table_of_contents: true +api: {"operationId":"setPassword","tags":["Password Management"],"description":"This API is used to set a password for an identity. \n\nAn identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their IDN user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow).\n\nA token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity's password or the password of any of the identity's accounts. \n\"API authority\" refers to a token that only has the \"client_credentials\" grant type.\n\nYou can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). \nTo do so, follow these steps:\n\n1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. \n\n2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. \n\n3. Use [Set Identity's Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password:\n\n```java\nimport javax.crypto.Cipher;\nimport java.security.KeyFactory;\nimport java.security.PublicKey;\nimport java.security.spec.X509EncodedKeySpec;\nimport java util.Base64;\n\nString encrypt(String publicKey, String toEncrypt) throws Exception {\n byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey);\n byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes(\"UTF-8\"));\n return Base64.getEncoder().encodeToString(encryptedBytes);\n}\n\nprivate byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception {\n PublicKey key = KeyFactory.getInstance(\"RSA\").generatePublic(new X509EncodedKeySpec(publicKeyBytes));\n String transformation = \"RSA/ECB/PKCS1Padding\";\n Cipher cipher = Cipher.getInstance(transformation);\n cipher.init(1, key);\n return cipher.doFinal(toEncryptBytes);\n}\n``` \n\nIn this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. \n\nYou can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. \n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","description":"The identity ID that requested the password change","example":"8a807d4c73c545510173c545f0a002ff"},"encryptedPassword":{"type":"string","description":"The RSA encrypted password","example":"XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A=="},"publicKeyId":{"type":"string","description":"The encryption key ID","example":"YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2"},"accountId":{"type":"string","description":"Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350","example":"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com"},"sourceId":{"type":"string","description":"The ID of the source for which identity is requesting the password change","example":"8a807d4c73c545510173c545d4b60246"}}}}}},"responses":{"202":{"description":"Reference to the password change.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","nullable":true,"description":"The password change request ID","example":"089899f13a8f4da7824996191587bab9"},"state":{"type":"string","enum":["IN_PROGRESS","FINISHED","FAILED"],"description":"Password change state","example":"IN_PROGRESS"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/set-password","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"identityId":"8a807d4c73c545510173c545f0a002ff","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","sourceId":"8a807d4c73c545510173c545d4b60246"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Set Identity's Password","description":{"content":"This API is used to set a password for an identity. \n\nAn identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their IDN user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow).\n\nA token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity's password or the password of any of the identity's accounts. \n\"API authority\" refers to a token that only has the \"client_credentials\" grant type.\n\nYou can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). \nTo do so, follow these steps:\n\n1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. \n\n2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. \n\n3. Use [Set Identity's Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password:\n\n```java\nimport javax.crypto.Cipher;\nimport java.security.KeyFactory;\nimport java.security.PublicKey;\nimport java.security.spec.X509EncodedKeySpec;\nimport java util.Base64;\n\nString encrypt(String publicKey, String toEncrypt) throws Exception {\n byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey);\n byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes(\"UTF-8\"));\n return Base64.getEncoder().encodeToString(encryptedBytes);\n}\n\nprivate byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception {\n PublicKey key = KeyFactory.getInstance(\"RSA\").generatePublic(new X509EncodedKeySpec(publicKeyBytes));\n String transformation = \"RSA/ECB/PKCS1Padding\";\n Cipher cipher = Cipher.getInstance(transformation);\n cipher.init(1, key);\n return cipher.doFinal(toEncryptBytes);\n}\n``` \n\nIn this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. \n\nYou can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. \n","type":"text/plain"},"url":{"path":["set-password"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Set Identity's Password' (set-password)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Set Identity's Password + + + +This API is used to set a password for an identity. + +An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their IDN user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). + +A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity's password or the password of any of the identity's accounts. +"API authority" refers to a token that only has the "client_credentials" grant type. + +You can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). +To do so, follow these steps: + +1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. + +2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. + +3. Use [Set Identity's Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password: + +```java +import javax.crypto.Cipher; +import java.security.KeyFactory; +import java.security.PublicKey; +import java.security.spec.X509EncodedKeySpec; +import java util.Base64; + +String encrypt(String publicKey, String toEncrypt) throws Exception { + byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey); + byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes("UTF-8")); + return Base64.getEncoder().encodeToString(encryptedBytes); +} + +private byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception { + PublicKey key = KeyFactory.getInstance("RSA").generatePublic(new X509EncodedKeySpec(publicKeyBytes)); + String transformation = "RSA/ECB/PKCS1Padding"; + Cipher cipher = Cipher.getInstance(transformation); + cipher.init(1, key); + return cipher.doFinal(toEncryptBytes); +} +``` + +In this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. + +You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. + + +
    Request Body required
    + +Reference to the password change. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/set-policy-schedule.api.mdx b/products/idn/api/v3/set-policy-schedule.api.mdx new file mode 100644 index 000000000..1c8b2c664 --- /dev/null +++ b/products/idn/api/v3/set-policy-schedule.api.mdx @@ -0,0 +1,109 @@ +--- +id: set-policy-schedule +sidebar_label: Update SOD Policy schedule +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:sod-policy:write"]}],"operationId":"setPolicySchedule","tags":["SOD Policy"],"description":"This updates schedule for a specified SOD policy.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the SOD policy to update its schedule.","example":"ef38f943-47e9-4562-b5bb-8424a56397d8"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"SOD Policy schedule name","example":"SCH-1584312283015"},"created":{"type":"string","format":"date-time","description":"The time when this SOD policy schedule is created.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"modified":{"type":"string","format":"date-time","description":"The time when this SOD policy schedule is modified.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"description":{"type":"string","description":"SOD Policy schedule description","example":"Schedule for policy xyz"},"schedule":{"type":"object","description":"The schedule information.","properties":{"type":{"description":"Enum representing the currently supported schedule types.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["DAILY","WEEKLY","MONTHLY","CALENDAR"],"example":"WEEKLY"},"days":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The days to execute the search.\n\nIf `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`.\n\nIf `type` is `MONTHLY`, the values will be a number in double quotes, like `\"1\"`, `\"10\"`, or `\"28\"`. Optionally, the value `\"L\"` can be used to refer to the last day of the month.\n","example":{"type":"LIST","values":["MON","WED","FRI"]},"nullable":true}]},"hours":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The hours selected.","example":{"type":"RANGE","values":["9","18"],"interval":3}}]},"expiration":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"timeZoneId":{"description":"The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org's default timezone is used.","nullable":true,"type":"string","example":"GMT-06:00"}},"required":["type","hours"]},"recipients":{"type":"array","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}},"emailEmptyResults":{"type":"boolean","description":"Indicates if empty results need to be emailed","example":false,"default":false},"creatorId":{"type":"string","description":"Policy's creator ID","example":"0f11f2a47c944bf3a2bd742580fe3bde","readOnly":true},"modifierId":{"type":"string","description":"Policy's modifier ID","example":"0f11f2a47c944bf3a2bd742580fe3bde","readOnly":true}}}}}},"responses":{"200":{"description":"Created or updated SOD policy schedule.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"SOD Policy schedule name","example":"SCH-1584312283015"},"created":{"type":"string","format":"date-time","description":"The time when this SOD policy schedule is created.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"modified":{"type":"string","format":"date-time","description":"The time when this SOD policy schedule is modified.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"description":{"type":"string","description":"SOD Policy schedule description","example":"Schedule for policy xyz"},"schedule":{"type":"object","description":"The schedule information.","properties":{"type":{"description":"Enum representing the currently supported schedule types.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["DAILY","WEEKLY","MONTHLY","CALENDAR"],"example":"WEEKLY"},"days":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The days to execute the search.\n\nIf `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`.\n\nIf `type` is `MONTHLY`, the values will be a number in double quotes, like `\"1\"`, `\"10\"`, or `\"28\"`. Optionally, the value `\"L\"` can be used to refer to the last day of the month.\n","example":{"type":"LIST","values":["MON","WED","FRI"]},"nullable":true}]},"hours":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The hours selected.","example":{"type":"RANGE","values":["9","18"],"interval":3}}]},"expiration":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"timeZoneId":{"description":"The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org's default timezone is used.","nullable":true,"type":"string","example":"GMT-06:00"}},"required":["type","hours"]},"recipients":{"type":"array","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}},"emailEmptyResults":{"type":"boolean","description":"Indicates if empty results need to be emailed","example":false,"default":false},"creatorId":{"type":"string","description":"Policy's creator ID","example":"0f11f2a47c944bf3a2bd742580fe3bde","readOnly":true},"modifierId":{"type":"string","description":"Policy's modifier ID","example":"0f11f2a47c944bf3a2bd742580fe3bde","readOnly":true}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/sod-policies/{id}/schedule","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"SCH-1584312283015","description":"Schedule for policy xyz","schedule":{"type":"WEEKLY","days":{"type":"LIST","values":["MON","WED","FRI"]},"hours":{"type":"RANGE","values":["9","18"],"interval":3},"expiration":"2018-06-25T20:22:28.104Z","timeZoneId":"GMT-06:00"},"recipients":[{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"}],"emailEmptyResults":false},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Update SOD Policy schedule","description":{"content":"This updates schedule for a specified SOD policy.","type":"text/plain"},"url":{"path":["sod-policies",":id","schedule"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the SOD policy to update its schedule.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update SOD Policy schedule' (set-policy-schedule)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update SOD Policy schedule + + + +This updates schedule for a specified SOD policy. + +
    Path Parameters
    Request Body required
      schedule object
      + +The schedule information. + +
      days object
      + +The days to execute the search. + +If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. + +If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. + + +
      hours object
      + +The hours selected. + +
      recipients object[]
    + +Created or updated SOD policy schedule. + +
    Schema
      schedule object
      + +The schedule information. + +
      days object
      + +The days to execute the search. + +If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. + +If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. + + +
      hours object
      + +The hours selected. + +
      recipients object[]
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/set-sod-policy.api.mdx b/products/idn/api/v3/set-sod-policy.api.mdx new file mode 100644 index 000000000..dbb421546 --- /dev/null +++ b/products/idn/api/v3/set-sod-policy.api.mdx @@ -0,0 +1,120 @@ +--- +id: set-sod-policy +sidebar_label: Update SOD policy by ID +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:sod-policy:write"]}],"operationId":"setSodPolicy","tags":["SOD Policy"],"description":"This updates a specified SOD policy.\nRequires role of ORG_ADMIN.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the SOD policy to update.","example":"ef38f943-47e9-4562-b5bb-8424a56397d8"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Policy id","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"name":{"type":"string","description":"Policy Business Name","example":"policy-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this SOD policy is created.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"modified":{"type":"string","format":"date-time","description":"The time when this SOD policy is modified.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"description":{"type":"string","description":"Optional description of the SOD policy","example":"This policy ensures compliance of xyz","nullable":true},"ownerRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"externalPolicyReference":{"type":"string","description":"Optional External Policy Reference","example":"XYZ policy","nullable":true},"policyQuery":{"type":"string","description":"Search query of the SOD policy","example":"@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)"},"compensatingControls":{"type":"string","description":"Optional compensating controls(Mitigating Controls)","example":"Have a manager review the transaction decisions for their \"out of compliance\" employee","nullable":true},"correctionAdvice":{"type":"string","description":"Optional correction advice","example":"Based on the role of the employee, managers should remove access that is not required for their job function.","nullable":true},"state":{"type":"string","description":"whether the policy is enforced or not","enum":["ENFORCED","NOT_ENFORCED"],"example":"ENFORCED"},"tags":{"type":"array","description":"tags for this policy object","example":["TAG1","TAG2"],"items":{"type":"string"}},"creatorId":{"type":"string","description":"Policy's creator ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"modifierId":{"type":"string","description":"Policy's modifier ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","nullable":true,"readOnly":true},"violationOwnerAssignmentConfig":{"nullable":true,"type":"object","properties":{"assignmentRule":{"type":"string","enum":["MANAGER","STATIC",null],"description":"Details about the violations owner.\nMANAGER - identity's manager\nSTATIC - Governance Group or Identity","example":"MANAGER","nullable":true},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"nullable":true}]}}},"scheduled":{"type":"boolean","description":"defines whether a policy has been scheduled or not","example":true,"default":false},"type":{"type":"string","description":"whether a policy is query based or conflicting access based","default":"GENERAL","enum":["GENERAL","CONFLICTING_ACCESS_BASED"],"example":"GENERAL"},"conflictingAccessCriteria":{"allOf":[{"type":"object","properties":{"leftCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","minItems":1,"maxItems":50,"items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"Type of the propery to which this reference applies to","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}},"rightCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","minItems":1,"maxItems":50,"items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"Type of the propery to which this reference applies to","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}}}},{"nullable":true}]}}},"examples":{"Conflicting Access Based Policy":{"value":{"name":"Conflicting-Policy-Name","description":"Modified Description","externalPolicyReference":"XYZ policy","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":["string"],"violationOwnerAssignmentConfig":{"assignmentRule":"MANAGER","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Violation Owner Name"}},"scheduled":true,"type":"CONFLICTING_ACCESS_BASED","conflictingAccessCriteria":{"leftCriteria":{"name":"money-in","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67"}]},"rightCriteria":{"name":"money-out","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a68"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a69"}]}}}},"General Policy":{"value":{"description":"Modified Description","ownerRef":{"type":"IDENTITY","id":"2c918087682f9a86016839c05e8f1aff","name":"Owner Name"},"externalPolicyReference":"New policy","policyQuery":"policy query implementation","compensatingControls":"Compensating controls","correctionAdvice":"Correction advice","tags":[],"state":"ENFORCED","scheduled":false,"creatorId":"2c918087682f9a86016839c05e8f1aff","modifierId":null,"violationOwnerAssignmentConfig":null,"type":"GENERAL","conflictingAccessCriteria":null,"id":"52c11db4-733e-4c31-949a-766c95ec95f1","name":"General-Policy-Name","created":"2020-05-12T19:47:38Z","modified":"2020-05-12T19:47:38Z"}}}}}},"responses":{"200":{"description":"SOD Policy by ID","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Policy id","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"name":{"type":"string","description":"Policy Business Name","example":"policy-xyz"},"created":{"type":"string","format":"date-time","description":"The time when this SOD policy is created.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"modified":{"type":"string","format":"date-time","description":"The time when this SOD policy is modified.","example":"2020-01-01T00:00:00.000000Z","readOnly":true},"description":{"type":"string","description":"Optional description of the SOD policy","example":"This policy ensures compliance of xyz","nullable":true},"ownerRef":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"externalPolicyReference":{"type":"string","description":"Optional External Policy Reference","example":"XYZ policy","nullable":true},"policyQuery":{"type":"string","description":"Search query of the SOD policy","example":"@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)"},"compensatingControls":{"type":"string","description":"Optional compensating controls(Mitigating Controls)","example":"Have a manager review the transaction decisions for their \"out of compliance\" employee","nullable":true},"correctionAdvice":{"type":"string","description":"Optional correction advice","example":"Based on the role of the employee, managers should remove access that is not required for their job function.","nullable":true},"state":{"type":"string","description":"whether the policy is enforced or not","enum":["ENFORCED","NOT_ENFORCED"],"example":"ENFORCED"},"tags":{"type":"array","description":"tags for this policy object","example":["TAG1","TAG2"],"items":{"type":"string"}},"creatorId":{"type":"string","description":"Policy's creator ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","readOnly":true},"modifierId":{"type":"string","description":"Policy's modifier ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","nullable":true,"readOnly":true},"violationOwnerAssignmentConfig":{"nullable":true,"type":"object","properties":{"assignmentRule":{"type":"string","enum":["MANAGER","STATIC",null],"description":"Details about the violations owner.\nMANAGER - identity's manager\nSTATIC - Governance Group or Identity","example":"MANAGER","nullable":true},"ownerRef":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"nullable":true}]}}},"scheduled":{"type":"boolean","description":"defines whether a policy has been scheduled or not","example":true,"default":false},"type":{"type":"string","description":"whether a policy is query based or conflicting access based","default":"GENERAL","enum":["GENERAL","CONFLICTING_ACCESS_BASED"],"example":"GENERAL"},"conflictingAccessCriteria":{"allOf":[{"type":"object","properties":{"leftCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","minItems":1,"maxItems":50,"items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"Type of the propery to which this reference applies to","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}},"rightCriteria":{"type":"object","properties":{"name":{"type":"string","description":"Business name for the access construct list","example":"money-in"},"criteriaList":{"type":"array","description":"List of criteria. There is a min of 1 and max of 50 items in the list.","minItems":1,"maxItems":50,"items":{"type":"object","properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"Type of the propery to which this reference applies to","example":"ENTITLEMENT"},"id":{"type":"string","description":"ID of the object to which this reference applies to","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies to","example":"Administrator"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","name":"Administrator"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","name":"Administrator"}]}}}}},{"nullable":true}]}}},"examples":{"Conflicting Access Based Policy":{"value":{"id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"Conflicting-Policy-Name","created":"2020-01-01T00:00:00.000000Z","modified":"2020-01-01T00:00:00.000000Z","description":"Modified description","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Owner Name"},"externalPolicyReference":"XYZ policy","policyQuery":"@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)","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":["string"],"creatorId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","modifierId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","violationOwnerAssignmentConfig":{"assignmentRule":"MANAGER","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Violation Owner Name"}},"scheduled":true,"type":"CONFLICTING_ACCESS_BASED","conflictingAccessCriteria":{"leftCriteria":{"name":"money-in","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67"}]},"rightCriteria":{"name":"money-out","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a68"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a69"}]}}}},"General Policy":{"value":{"description":"Modified Description","ownerRef":{"type":"IDENTITY","id":"2c918087682f9a86016839c05e8f1aff","name":"Owner Name"},"externalPolicyReference":"New policy","policyQuery":"policy query implementation","compensatingControls":"Compensating controls","correctionAdvice":"Correction advice","tags":[],"state":"ENFORCED","scheduled":false,"creatorId":"2c918087682f9a86016839c05e8f1aff","modifierId":null,"violationOwnerAssignmentConfig":null,"type":"GENERAL","conflictingAccessCriteria":null,"id":"52c11db4-733e-4c31-949a-766c95ec95f1","name":"General-Policy-Name","created":"2020-05-12T19:47:38Z","modified":"2020-05-12T19:47:38Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/sod-policies/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"policy-xyz","description":"This policy ensures compliance of xyz","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"},"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","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"],"violationOwnerAssignmentConfig":{"assignmentRule":"MANAGER","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"}},"scheduled":true,"type":"GENERAL","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"}]}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Update SOD policy by ID","description":{"content":"This updates a specified SOD policy.\nRequires role of ORG_ADMIN.","type":"text/plain"},"url":{"path":["sod-policies",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the SOD policy to update.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update SOD policy by ID' (set-sod-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update SOD policy by ID + + + +This updates a specified SOD policy. +Requires role of ORG_ADMIN. + +
    Path Parameters
    Request Body required
      ownerRef object
      violationOwnerAssignmentConfig object
      ownerRef object
      conflictingAccessCriteria object
      leftCriteria object
      criteriaList object[]
      + +**Possible values:** `>= 1`, `<= 50` + +
      + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
      rightCriteria object
      criteriaList object[]
      + +**Possible values:** `>= 1`, `<= 50` + +
      + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
    + +SOD Policy by ID + +
    Schema
      ownerRef object
      violationOwnerAssignmentConfig object
      ownerRef object
      conflictingAccessCriteria object
      leftCriteria object
      criteriaList object[]
      + +**Possible values:** `>= 1`, `<= 50` + +
      + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
      rightCriteria object
      criteriaList object[]
      + +**Possible values:** `>= 1`, `<= 50` + +
      + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/set-tag-to-object.api.mdx b/products/idn/api/v3/set-tag-to-object.api.mdx new file mode 100644 index 000000000..ea452fe1a --- /dev/null +++ b/products/idn/api/v3/set-tag-to-object.api.mdx @@ -0,0 +1,81 @@ +--- +id: set-tag-to-object +sidebar_label: Add Tag to Object +hide_title: true +hide_table_of_contents: true +api: {"operationId":"setTagToObject","security":[{"oauth2":["idn:tag:manage"]}],"tags":["Tagged Objects"],"description":"This adds a tag to an object.\n\nAny authenticated token may be used to call this API.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"objectRef":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","nullable":true,"description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"tags":{"type":"array","items":{"type":"string"},"description":"Labels to be applied to an Object","example":["BU_FINANCE","PCI"]}}}}}},"responses":{"200":{"description":"Request succeeded.","content":{"application/json":{"schema":{"type":"object","properties":{"objectRef":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","nullable":true,"description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"tags":{"type":"array","items":{"type":"string"},"description":"Labels to be applied to an Object","example":["BU_FINANCE","PCI"]}}}}}},"201":{"description":"Created."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/tagged-objects","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"objectRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"},"tags":["BU_FINANCE","PCI"]},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Add Tag to Object","description":{"content":"This adds a tag to an object.\n\nAny authenticated token may be used to call this API.","type":"text/plain"},"url":{"path":["tagged-objects"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Add Tag to Object' (set-tag-to-object)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Add Tag to Object + + + +This adds a tag to an object. + +Any authenticated token may be used to call this API. + +
    Request Body required
      objectRef object
    + +Request succeeded. + +
    Schema
      objectRef object
    + +Created. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/set-tags-to-many-objects.api.mdx b/products/idn/api/v3/set-tags-to-many-objects.api.mdx new file mode 100644 index 000000000..8516e128f --- /dev/null +++ b/products/idn/api/v3/set-tags-to-many-objects.api.mdx @@ -0,0 +1,81 @@ +--- +id: set-tags-to-many-objects +sidebar_label: Tag Multiple Objects +hide_title: true +hide_table_of_contents: true +api: {"operationId":"setTagsToManyObjects","security":[{"oauth2":["idn:tag:manage"]}],"tags":["Tagged Objects"],"description":"This API adds tags to multiple objects.\n\nA token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","requestBody":{"required":true,"description":"Supported object types are ROLE, IDENTITY and SOD_POLICY.","content":{"application/json":{"schema":{"type":"object","properties":{"objectRefs":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","nullable":true,"description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}},"tags":{"type":"array","items":{"type":"string"},"description":"Label to be applied to an Object","example":["BU_FINANCE","PCI"]},"operation":{"type":"string","enum":["APPEND","MERGE"],"default":"APPEND","description":"If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object.\n\nIf MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored.","example":"MERGE"}}}}}},"responses":{"200":{"description":"Request succeeded.","content":{"application/json":{"schema":{"type":"object","properties":{"objectRefs":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","nullable":true,"description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}},"tags":{"type":"array","items":{"type":"string"},"description":"Label to be applied to an Object","example":["BU_FINANCE","PCI"]},"operation":{"type":"string","enum":["APPEND","MERGE"],"default":"APPEND","description":"If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object.\n\nIf MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored.","example":"MERGE"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/tagged-objects/bulk-add","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"objectRefs":[{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"}],"tags":["BU_FINANCE","PCI"],"operation":"MERGE"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Tag Multiple Objects","description":{"content":"This API adds tags to multiple objects.\n\nA token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["tagged-objects","bulk-add"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Tag Multiple Objects' (set-tags-to-many-objects)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Tag Multiple Objects + + + +This API adds tags to multiple objects. + +A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +
    Request Body required
    + +Supported object types are ROLE, IDENTITY and SOD_POLICY. + +
      objectRefs object[]
    + +Request succeeded. + +
    Schema
      objectRefs object[]
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/sidebar.js b/products/idn/api/v3/sidebar.js new file mode 100644 index 000000000..467ee5074 --- /dev/null +++ b/products/idn/api/v3/sidebar.js @@ -0,0 +1 @@ +module.exports = [{"type":"doc","id":"api/v3/identitynow-v-3-api"},{"type":"category","label":"Access Profiles","link":{"type":"doc","id":"api/v3/access-profiles"},"items":[{"type":"doc","id":"api/v3/list-access-profiles","label":"List Access Profiles","className":"api-method get"},{"type":"doc","id":"api/v3/create-access-profile","label":"Create an Access Profile","className":"api-method post"},{"type":"doc","id":"api/v3/get-access-profile","label":"Get an Access Profile","className":"api-method get"},{"type":"doc","id":"api/v3/patch-access-profile","label":"Patch a specified Access Profile","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-access-profiles-in-bulk","label":"Delete Access Profile(s)","className":"api-method post"},{"type":"doc","id":"api/v3/get-access-profile-entitlements","label":"List Access Profile's Entitlements","className":"api-method get"}]},{"type":"category","label":"Access Request Approvals","link":{"type":"doc","id":"api/v3/access-request-approvals"},"items":[{"type":"doc","id":"api/v3/list-pending-approvals","label":"Pending Access Request Approvals List","className":"api-method get"},{"type":"doc","id":"api/v3/list-completed-approvals","label":"Completed Access Request Approvals List","className":"api-method get"},{"type":"doc","id":"api/v3/approve-access-request","label":"Approves an access request approval.","className":"api-method post"},{"type":"doc","id":"api/v3/reject-access-request","label":"Rejects an access request approval.","className":"api-method post"},{"type":"doc","id":"api/v3/forward-access-request","label":"Forwards an access request approval.","className":"api-method post"},{"type":"doc","id":"api/v3/get-access-request-approval-summary","label":"Get the number of access-requests-approvals","className":"api-method get"}]},{"type":"category","label":"Access Requests","link":{"type":"doc","id":"api/v3/access-requests"},"items":[{"type":"doc","id":"api/v3/create-access-request","label":"Submit an Access Request","className":"api-method post"},{"type":"doc","id":"api/v3/cancel-access-request","label":"Cancel Access Request","className":"api-method post"},{"type":"doc","id":"api/v3/get-access-request-config","label":"Get Access Request Configuration","className":"api-method get"},{"type":"doc","id":"api/v3/update-access-request-config","label":"Update Access Request Configuration","className":"api-method put"},{"type":"doc","id":"api/v3/list-access-request-status","label":"Access Request Status","className":"api-method get"}]},{"type":"category","label":"Accounts","link":{"type":"doc","id":"api/v3/accounts"},"items":[{"type":"doc","id":"api/v3/list-accounts","label":"Accounts List","className":"api-method get"},{"type":"doc","id":"api/v3/create-account","label":"Create Account","className":"api-method post"},{"type":"doc","id":"api/v3/get-account","label":"Account Details","className":"api-method get"},{"type":"doc","id":"api/v3/update-account","label":"Update Account","className":"api-method patch"},{"type":"doc","id":"api/v3/put-account","label":"Update Account","className":"api-method put"},{"type":"doc","id":"api/v3/delete-account","label":"Delete Account","className":"api-method delete"},{"type":"doc","id":"api/v3/get-account-entitlements","label":"Account Entitlements","className":"api-method get"},{"type":"doc","id":"api/v3/reload-account","label":"Reload Account","className":"api-method post"},{"type":"doc","id":"api/v3/enable-account","label":"Enable Account","className":"api-method post"},{"type":"doc","id":"api/v3/disable-account","label":"Disable Account","className":"api-method post"},{"type":"doc","id":"api/v3/unlock-account","label":"Unlock Account","className":"api-method post"}]},{"type":"category","label":"Account Activities","link":{"type":"doc","id":"api/v3/account-activities"},"items":[{"type":"doc","id":"api/v3/list-account-activities","label":"List Account Activities","className":"api-method get"},{"type":"doc","id":"api/v3/get-account-activity","label":"Get an Account Activity","className":"api-method get"}]},{"type":"category","label":"Certification Campaigns","link":{"type":"doc","id":"api/v3/certification-campaigns"},"items":[{"type":"doc","id":"api/v3/get-active-campaigns","label":"List Campaigns","className":"api-method get"},{"type":"doc","id":"api/v3/create-campaign","label":"Create a campaign","className":"api-method post"},{"type":"doc","id":"api/v3/get-campaign","label":"Get a campaign","className":"api-method get"},{"type":"doc","id":"api/v3/move","label":"Reassign Certifications","className":"api-method post"},{"type":"doc","id":"api/v3/start-campaign","label":"Activate a Campaign","className":"api-method post"}]},{"type":"category","label":"Certifications","link":{"type":"doc","id":"api/v3/certifications"},"items":[{"type":"doc","id":"api/v3/list-identity-certifications","label":"Identity Campaign Certifications by IDs","className":"api-method get"},{"type":"doc","id":"api/v3/get-identity-certification","label":"Identity Certification by ID","className":"api-method get"},{"type":"doc","id":"api/v3/list-identity-access-review-items","label":"List of Access Review Items","className":"api-method get"},{"type":"doc","id":"api/v3/make-identity-decision","label":"Decide on a Certification Item","className":"api-method post"},{"type":"doc","id":"api/v3/reassign-identity-certifications","label":"Reassign Identities or Items","className":"api-method post"},{"type":"doc","id":"api/v3/sign-off-identity-certification","label":"Finalize Identity Certification Decisions","className":"api-method post"}]},{"type":"category","label":"Certification Summaries","link":{"type":"doc","id":"api/v3/certification-summaries"},"items":[{"type":"doc","id":"api/v3/get-identity-decision-summary","label":"Summary of Certification Decisions","className":"api-method get"},{"type":"doc","id":"api/v3/get-identity-summaries","label":"Identity Summaries for Campaign Certification","className":"api-method get"},{"type":"doc","id":"api/v3/get-identity-access-summaries","label":"Access Summaries","className":"api-method get"},{"type":"doc","id":"api/v3/get-identity-summary","label":"Summary for Identity","className":"api-method get"}]},{"type":"category","label":"Lifecycle States","link":{"type":"doc","id":"api/v3/lifecycle-states"},"items":[{"type":"doc","id":"api/v3/set-lifecycle-state","label":"Set Lifecycle State","className":"api-method post"},{"type":"doc","id":"api/v3/list-lifecycle-states","label":"Lists LifecycleStates","className":"api-method get"},{"type":"doc","id":"api/v3/create-lifecycle-state","label":"Create Lifecycle State","className":"api-method post"},{"type":"doc","id":"api/v3/get-lifecycle-state","label":"Retrieves Lifecycle State","className":"api-method get"},{"type":"doc","id":"api/v3/update-lifecycle-states","label":"Update Lifecycle State","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-lifecycle-state","label":"Delete Lifecycle State by ID","className":"api-method delete"}]},{"type":"category","label":"Identity Profiles","link":{"type":"doc","id":"api/v3/identity-profiles"},"items":[{"type":"doc","id":"api/v3/list-identity-profiles","label":"Identity Profiles List","className":"api-method get"},{"type":"doc","id":"api/v3/export-identity-profiles","label":"Export Identity Profiles","className":"api-method get"},{"type":"doc","id":"api/v3/import-identity-profiles","label":"Import Identity Profiles","className":"api-method post"},{"type":"doc","id":"api/v3/get-identity-profile","label":"Get single Identity Profile","className":"api-method get"},{"type":"doc","id":"api/v3/get-default-identity-attribute-config","label":"Get default Identity Attribute Config","className":"api-method get"}]},{"type":"category","label":"Non-Employee Lifecycle Management","link":{"type":"doc","id":"api/v3/non-employee-lifecycle-management"},"items":[{"type":"doc","id":"api/v3/create-non-employee-record","label":"Create Non-Employee Record","className":"api-method post"},{"type":"doc","id":"api/v3/list-non-employee-records","label":"List Non-Employee Records","className":"api-method get"},{"type":"doc","id":"api/v3/get-non-employee-record","label":"Get a Non-Employee Record","className":"api-method get"},{"type":"doc","id":"api/v3/update-non-employee-record","label":"Update Non-Employee Record","className":"api-method put"},{"type":"doc","id":"api/v3/patch-non-employee-record","label":"Patch Non-Employee Record","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-non-employee-record","label":"Delete Non-Employee Record","className":"api-method delete"},{"type":"doc","id":"api/v3/delete-non-employee-records-in-bulk","label":"Delete Multiple Non-Employee Records","className":"api-method post"},{"type":"doc","id":"api/v3/create-non-employee-request","label":"Create Non-Employee Request","className":"api-method post"},{"type":"doc","id":"api/v3/list-non-employee-requests","label":"List Non-Employee Requests","className":"api-method get"},{"type":"doc","id":"api/v3/get-non-employee-request","label":"Get a Non-Employee Request","className":"api-method get"},{"type":"doc","id":"api/v3/delete-non-employee-request","label":"Delete Non-Employee Request","className":"api-method delete"},{"type":"doc","id":"api/v3/get-non-employee-request-summary","label":"Get Summary of Non-Employee Requests","className":"api-method get"},{"type":"doc","id":"api/v3/create-non-employee-source","label":"Create Non-Employee Source","className":"api-method post"},{"type":"doc","id":"api/v3/list-non-employee-sources","label":"List Non-Employee Sources","className":"api-method get"},{"type":"doc","id":"api/v3/get-non-employee-source","label":"Get a Non-Employee Source","className":"api-method get"},{"type":"doc","id":"api/v3/patch-non-employee-source","label":"Patch a Non-Employee Source","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-non-employee-source","label":"Delete Non-Employee Source","className":"api-method delete"},{"type":"doc","id":"api/v3/export-non-employee-records","label":"Exports Non-Employee Records to CSV","className":"api-method get"},{"type":"doc","id":"api/v3/import-non-employee-records-in-bulk","label":"Imports, or Updates, Non-Employee Records","className":"api-method post"},{"type":"doc","id":"api/v3/get-non-employee-bulk-upload-status","label":"Obtain the status of bulk upload on the source","className":"api-method get"},{"type":"doc","id":"api/v3/export-non-employee-source-schema-template","label":"Exports Source Schema Template","className":"api-method get"},{"type":"doc","id":"api/v3/list-non-employee-approvals","label":"Get List of Non-Employee Approval Requests","className":"api-method get"},{"type":"doc","id":"api/v3/get-non-employee-approval","label":"Get a non-employee approval item detail","className":"api-method get"},{"type":"doc","id":"api/v3/approve-non-employee-request","label":"Approve a Non-Employee Request","className":"api-method post"},{"type":"doc","id":"api/v3/reject-non-employee-request","label":"Reject a Non-Employee Request","className":"api-method post"},{"type":"doc","id":"api/v3/get-non-employee-approval-summary","label":"Get Summary of Non-Employee Approval Requests","className":"api-method get"},{"type":"doc","id":"api/v3/get-non-employee-source-schema-attributes","label":"List Schema Attributes Non-Employee Source","className":"api-method get"},{"type":"doc","id":"api/v3/create-non-employee-source-schema-attributes","label":"Create a new Schema Attribute for Non-Employee Source","className":"api-method post"},{"type":"doc","id":"api/v3/delete-non-employee-source-schema-attributes","label":"Delete all custom schema attributes for Non-Employee Source","className":"api-method delete"},{"type":"doc","id":"api/v3/get-non-employee-schema-attribute","label":"Get Schema Attribute Non-Employee Source","className":"api-method get"},{"type":"doc","id":"api/v3/patch-non-employee-schema-attribute","label":"Patch a Schema Attribute for Non-Employee Source","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-non-employee-schema-attribute","label":"Delete a Schema Attribute for Non-Employee Source","className":"api-method delete"}]},{"type":"category","label":"OAuth Clients","link":{"type":"doc","id":"api/v3/o-auth-clients"},"items":[{"type":"doc","id":"api/v3/list-oauth-clients","label":"List OAuth Clients","className":"api-method get"},{"type":"doc","id":"api/v3/create-oauth-client","label":"Create OAuth Client","className":"api-method post"},{"type":"doc","id":"api/v3/get-oauth-client","label":"Get OAuth Client","className":"api-method get"},{"type":"doc","id":"api/v3/delete-oauth-client","label":"Delete OAuth Client","className":"api-method delete"},{"type":"doc","id":"api/v3/patch-oauth-client","label":"Patch OAuth Client","className":"api-method patch"}]},{"type":"category","label":"Password Configuration","link":{"type":"doc","id":"api/v3/password-configuration"},"items":[{"type":"doc","id":"api/v3/get-password-org-config","label":"Get Password Org Config","className":"api-method get"},{"type":"doc","id":"api/v3/update-password-org-config","label":"Update Password Org Config","className":"api-method put"},{"type":"doc","id":"api/v3/create-password-org-config","label":"Create Password Org Config","className":"api-method post"}]},{"type":"category","label":"Password Management","link":{"type":"doc","id":"api/v3/password-management"},"items":[{"type":"doc","id":"api/v3/query-password-info","label":"Query Password Info","className":"api-method post"},{"type":"doc","id":"api/v3/set-password","label":"Set Identity's Password","className":"api-method post"},{"type":"doc","id":"api/v3/get-password-change-status","label":"Get Password Change Request Status","className":"api-method get"}]},{"type":"category","label":"Password Dictionary","link":{"type":"doc","id":"api/v3/password-dictionary"},"items":[{"type":"doc","id":"api/v3/get-password-dictionary","label":"Get Password Dictionary","className":"api-method get"},{"type":"doc","id":"api/v3/update-password-dictionary","label":"Update Password Dictionary","className":"api-method put"}]},{"type":"category","label":"Password Sync Groups","link":{"type":"doc","id":"api/v3/password-sync-groups"},"items":[{"type":"doc","id":"api/v3/get-password-sync-groups","label":"Get Password Sync Group List","className":"api-method get"},{"type":"doc","id":"api/v3/create-password-sync-group","label":"Create Password Sync Group","className":"api-method post"},{"type":"doc","id":"api/v3/get-password-sync-group","label":"Get Password Sync Group by ID","className":"api-method get"},{"type":"doc","id":"api/v3/update-password-sync-group","label":"Update Password Sync Group by ID","className":"api-method put"},{"type":"doc","id":"api/v3/delete-password-sync-group","label":"Delete Password Sync Group by ID","className":"api-method delete"}]},{"type":"category","label":"Personal Access Tokens","link":{"type":"doc","id":"api/v3/personal-access-tokens"},"items":[{"type":"doc","id":"api/v3/list-personal-access-tokens","label":"List Personal Access Tokens","className":"api-method get"},{"type":"doc","id":"api/v3/create-personal-access-token","label":"Create Personal Access Token","className":"api-method post"},{"type":"doc","id":"api/v3/patch-personal-access-token","label":"Patch Personal Access Token","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-personal-access-token","label":"Delete Personal Access Token","className":"api-method delete"}]},{"type":"category","label":"Public Identities","link":{"type":"doc","id":"api/v3/public-identities"},"items":[{"type":"doc","id":"api/v3/get-public-identities","label":"Get a list of public identities","className":"api-method get"}]},{"type":"category","label":"Public Identities Config","link":{"type":"doc","id":"api/v3/public-identities-config"},"items":[{"type":"doc","id":"api/v3/get-public-identity-config","label":"Get the Public Identities Configuration","className":"api-method get"},{"type":"doc","id":"api/v3/update-public-identity-config","label":"Update the Public Identities Configuration","className":"api-method put"}]},{"type":"category","label":"Requestable Objects","link":{"type":"doc","id":"api/v3/requestable-objects"},"items":[{"type":"doc","id":"api/v3/list-requestable-objects","label":"Requestable Objects List","className":"api-method get"}]},{"type":"category","label":"Roles","link":{"type":"doc","id":"api/v3/roles"},"items":[{"type":"doc","id":"api/v3/list-roles","label":"List Roles","className":"api-method get"},{"type":"doc","id":"api/v3/create-role","label":"Create a Role","className":"api-method post"},{"type":"doc","id":"api/v3/get-role","label":"Get a Role","className":"api-method get"},{"type":"doc","id":"api/v3/patch-role","label":"Patch a specified Role","className":"api-method patch"},{"type":"doc","id":"api/v3/get-role-assigned-identities","label":"List Identities assigned a Role","className":"api-method get"}]},{"type":"category","label":"Saved Search","link":{"type":"doc","id":"api/v3/saved-search"},"items":[{"type":"doc","id":"api/v3/create-saved-search","label":"Create a saved search","className":"api-method post"},{"type":"doc","id":"api/v3/list-saved-searches","label":"Return a list of Saved Searches","className":"api-method get"},{"type":"doc","id":"api/v3/put-saved-search","label":"Updates an existing saved search\n","className":"api-method put"},{"type":"doc","id":"api/v3/get-saved-search","label":"Return saved search by ID","className":"api-method get"},{"type":"doc","id":"api/v3/delete-saved-search","label":"Delete document by ID","className":"api-method delete"},{"type":"doc","id":"api/v3/execute-saved-search","label":"Execute a saved search by ID","className":"api-method post"}]},{"type":"category","label":"Scheduled Search","link":{"type":"doc","id":"api/v3/scheduled-search"},"items":[{"type":"doc","id":"api/v3/create-scheduled-search","label":"Create a new scheduled search","className":"api-method post"},{"type":"doc","id":"api/v3/list-scheduled-search","label":"List scheduled searches","className":"api-method get"},{"type":"doc","id":"api/v3/update-scheduled-search","label":"Update an existing Scheduled Search","className":"api-method put"},{"type":"doc","id":"api/v3/get-scheduled-search","label":"Get a Scheduled Search","className":"api-method get"},{"type":"doc","id":"api/v3/delete-scheduled-search","label":"Delete a Scheduled Search","className":"api-method delete"},{"type":"doc","id":"api/v3/unsubscribe-scheduled-search","label":"Unsubscribe a recipient from Scheduled Search","className":"api-method post"}]},{"type":"category","label":"Search","link":{"type":"doc","id":"api/v3/search"},"items":[{"type":"doc","id":"api/v3/search-post","label":"Perform Search","className":"api-method post"},{"type":"doc","id":"api/v3/search-count","label":"Count Documents Satisfying a Query","className":"api-method post"},{"type":"doc","id":"api/v3/search-aggregate","label":"Perform a Search Query Aggregation","className":"api-method post"},{"type":"doc","id":"api/v3/search-get","label":"Get a Document by ID","className":"api-method get"}]},{"type":"category","label":"Segments","link":{"type":"doc","id":"api/v3/segments"},"items":[{"type":"doc","id":"api/v3/create-segment","label":"Create Segment","className":"api-method post"},{"type":"doc","id":"api/v3/list-segments","label":"List Segments","className":"api-method get"},{"type":"doc","id":"api/v3/get-segment","label":"Get a Segment by ID","className":"api-method get"},{"type":"doc","id":"api/v3/delete-segment","label":"Delete Segment by ID","className":"api-method delete"},{"type":"doc","id":"api/v3/patch-segment","label":"Update a Segment","className":"api-method patch"}]},{"type":"category","label":"Service Desk Integration","link":{"type":"doc","id":"api/v3/service-desk-integration"},"items":[{"type":"doc","id":"api/v3/get-service-desk-integrations","label":"List existing Service Desk Integrations","className":"api-method get"},{"type":"doc","id":"api/v3/create-service-desk-integration","label":"Create new Service Desk integration","className":"api-method post"},{"type":"doc","id":"api/v3/get-service-desk-integration","label":"Get a Service Desk integration","className":"api-method get"},{"type":"doc","id":"api/v3/put-service-desk-integration","label":"Update a Service Desk integration","className":"api-method put"},{"type":"doc","id":"api/v3/delete-service-desk-integration","label":"Delete a Service Desk integration","className":"api-method delete"},{"type":"doc","id":"api/v3/patch-service-desk-integration","label":"Service Desk Integration Update PATCH","className":"api-method patch"},{"type":"doc","id":"api/v3/get-service-desk-integration-types","label":"Service Desk Integration Types List.","className":"api-method get"},{"type":"doc","id":"api/v3/get-service-desk-integration-template","label":"Service Desk integration template by scriptName.","className":"api-method get"},{"type":"doc","id":"api/v3/get-status-check-details","label":"Get the time check configuration","className":"api-method get"},{"type":"doc","id":"api/v3/update-status-check-details","label":"Update the time check configuration","className":"api-method put"}]},{"type":"category","label":"SOD Policy","link":{"type":"doc","id":"api/v3/sod-policy"},"items":[{"type":"doc","id":"api/v3/create-sod-policy","label":"Create SOD policy","className":"api-method post"},{"type":"doc","id":"api/v3/list-sod-policies","label":"List SOD policies","className":"api-method get"},{"type":"doc","id":"api/v3/get-sod-policy","label":"Get SOD policy by ID","className":"api-method get"},{"type":"doc","id":"api/v3/set-sod-policy","label":"Update SOD policy by ID","className":"api-method put"},{"type":"doc","id":"api/v3/delete-sod-policy","label":"Delete SOD policy by ID","className":"api-method delete"},{"type":"doc","id":"api/v3/patch-sod-policy","label":"Patch SOD policy by ID","className":"api-method patch"},{"type":"doc","id":"api/v3/start-evaluate-sod-policy","label":"Evaluate one policy by ID","className":"api-method post"},{"type":"doc","id":"api/v3/get-sod-policy-schedule","label":"Get SOD policy schedule","className":"api-method get"},{"type":"doc","id":"api/v3/set-policy-schedule","label":"Update SOD Policy schedule","className":"api-method put"},{"type":"doc","id":"api/v3/delete-sod-policy-schedule","label":"Delete SOD policy schedule","className":"api-method delete"},{"type":"doc","id":"api/v3/start-sod-policy","label":"Runs SOD policy violation report","className":"api-method post"},{"type":"doc","id":"api/v3/get-sod-violation-report-status","label":"Get SOD violation report status","className":"api-method get"},{"type":"doc","id":"api/v3/get-sod-violation-report-run-status","label":"Get violation report run status","className":"api-method get"},{"type":"doc","id":"api/v3/start-sod-all-policies-for-org","label":"Runs all policies for org","className":"api-method post"},{"type":"doc","id":"api/v3/get-sod-all-report-run-status","label":"Get multi-report run task status","className":"api-method get"},{"type":"doc","id":"api/v3/get-default-violation-report","label":"Download violation report","className":"api-method get"},{"type":"doc","id":"api/v3/get-custom-violation-report","label":"Download custom violation report","className":"api-method get"}]},{"type":"category","label":"SOD Violations","link":{"type":"doc","id":"api/v3/sod-violations"},"items":[{"type":"doc","id":"api/v3/start-predict-sod-violations","label":"Predict SOD violations for identity.","className":"api-method post"},{"type":"doc","id":"api/v3/start-violation-check","label":"Check SOD violations","className":"api-method post"}]},{"type":"category","label":"Sources","link":{"type":"doc","id":"api/v3/sources"},"items":[{"type":"doc","id":"api/v3/list-sources","label":"Lists all sources in IdentityNow.","className":"api-method get"},{"type":"doc","id":"api/v3/create-source","label":"Creates a source in IdentityNow.","className":"api-method post"},{"type":"doc","id":"api/v3/get-source","label":"Get Source by ID","className":"api-method get"},{"type":"doc","id":"api/v3/put-source","label":"Update Source (Full)","className":"api-method put"},{"type":"doc","id":"api/v3/update-source","label":"Update Source (Partial)","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-source","label":"Delete Source by ID","className":"api-method delete"},{"type":"doc","id":"api/v3/list-provisioning-policies","label":"Lists ProvisioningPolicies","className":"api-method get"},{"type":"doc","id":"api/v3/create-provisioning-policy","label":"Create Provisioning Policy","className":"api-method post"},{"type":"doc","id":"api/v3/get-provisioning-policy","label":"Get Provisioning Policy by UsageType","className":"api-method get"},{"type":"doc","id":"api/v3/put-provisioning-policy","label":"Update Provisioning Policy by UsageType","className":"api-method put"},{"type":"doc","id":"api/v3/update-provisioning-policy","label":"Partial update of Provisioning Policy","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-provisioning-policy","label":"Delete Provisioning Policy by UsageType","className":"api-method delete"},{"type":"doc","id":"api/v3/update-provisioning-policies-in-bulk","label":"Bulk Update Provisioning Policies","className":"api-method post"},{"type":"doc","id":"api/v3/list-source-schemas","label":"List Schemas on a Source","className":"api-method get"},{"type":"doc","id":"api/v3/create-source-schema","label":"Create Schema on a Source","className":"api-method post"},{"type":"doc","id":"api/v3/get-source-schema","label":"Get Source Schema by ID","className":"api-method get"},{"type":"doc","id":"api/v3/put-source-schema","label":"Update Source Schema (Full)","className":"api-method put"},{"type":"doc","id":"api/v3/update-source-schema","label":"Update Source Schema (Partial)","className":"api-method patch"},{"type":"doc","id":"api/v3/delete-source-schema","label":"Delete Source Schema by ID","className":"api-method delete"},{"type":"doc","id":"api/v3/get-source-health","label":"Fetches source health by id","className":"api-method get"},{"type":"doc","id":"api/v3/get-accounts-schema","label":"Downloads source accounts schema template","className":"api-method get"},{"type":"doc","id":"api/v3/import-accounts-schema","label":"Uploads source accounts schema template","className":"api-method post"},{"type":"doc","id":"api/v3/get-entitlements-schema","label":"Downloads source entitlements schema template","className":"api-method get"},{"type":"doc","id":"api/v3/import-entitlements-schema","label":"Uploads source entitlements schema template","className":"api-method post"},{"type":"doc","id":"api/v3/import-connector-file","label":"Upload connector file to source","className":"api-method post"}]},{"type":"category","label":"Tagged Objects","link":{"type":"doc","id":"api/v3/tagged-objects"},"items":[{"type":"doc","id":"api/v3/list-tagged-objects","label":"List Tagged Objects","className":"api-method get"},{"type":"doc","id":"api/v3/set-tag-to-object","label":"Add Tag to Object","className":"api-method post"},{"type":"doc","id":"api/v3/list-tagged-objects-by-type","label":"List Tagged Objects","className":"api-method get"},{"type":"doc","id":"api/v3/get-tagged-object","label":"Get Tagged Object","className":"api-method get"},{"type":"doc","id":"api/v3/put-tagged-object","label":"Update Tagged Object","className":"api-method put"},{"type":"doc","id":"api/v3/delete-tagged-object","label":"Delete Tagged Object","className":"api-method delete"},{"type":"doc","id":"api/v3/set-tags-to-many-objects","label":"Tag Multiple Objects","className":"api-method post"},{"type":"doc","id":"api/v3/delete-tags-to-many-object","label":"Remove Tags from Multiple Objects","className":"api-method post"}]},{"type":"category","label":"Transforms","link":{"type":"doc","id":"api/v3/transforms"},"items":[{"type":"doc","id":"api/v3/list-transforms","label":"List transforms","className":"api-method get"},{"type":"doc","id":"api/v3/create-transform","label":"Create transform","className":"api-method post"},{"type":"doc","id":"api/v3/get-transform","label":"Transform by ID","className":"api-method get"},{"type":"doc","id":"api/v3/update-transform","label":"Update a transform","className":"api-method put"},{"type":"doc","id":"api/v3/delete-transform","label":"Delete a transform","className":"api-method delete"}]},{"type":"category","label":"Work Items","link":{"type":"doc","id":"api/v3/work-items"},"items":[{"type":"doc","id":"api/v3/list-work-items","label":"List Work Items","className":"api-method get"},{"type":"doc","id":"api/v3/get-completed-work-items","label":"Completed Work Items","className":"api-method get"},{"type":"doc","id":"api/v3/get-count-work-items","label":"Count Work Items","className":"api-method get"},{"type":"doc","id":"api/v3/get-count-completed-work-items","label":"Count Completed Work Items","className":"api-method get"},{"type":"doc","id":"api/v3/get-work-items-summary","label":"Work Items Summary","className":"api-method get"},{"type":"doc","id":"api/v3/get-work-item","label":"Get a Work Item","className":"api-method get"},{"type":"doc","id":"api/v3/complete-work-item","label":"Complete a Work Item","className":"api-method post"},{"type":"doc","id":"api/v3/approve-approval-item","label":"Approve an Approval Item","className":"api-method post"},{"type":"doc","id":"api/v3/reject-approval-item","label":"Reject an Approval Item","className":"api-method post"},{"type":"doc","id":"api/v3/approve-approval-items-in-bulk","label":"Bulk approve Approval Items","className":"api-method post"},{"type":"doc","id":"api/v3/reject-approval-items-in-bulk","label":"Bulk reject Approval Items","className":"api-method post"},{"type":"doc","id":"api/v3/submit-account-selection","label":"Submit Account Selections","className":"api-method post"}]}]; \ No newline at end of file diff --git a/products/idn/api/v3/sign-off-identity-certification.api.mdx b/products/idn/api/v3/sign-off-identity-certification.api.mdx new file mode 100644 index 000000000..e00d86e04 --- /dev/null +++ b/products/idn/api/v3/sign-off-identity-certification.api.mdx @@ -0,0 +1,87 @@ +--- +id: sign-off-identity-certification +sidebar_label: Finalize Identity Certification Decisions +hide_title: true +hide_table_of_contents: true +api: {"operationId":"signOffIdentityCertification","tags":["Certifications"],"description":"This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity campaign certification ID","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"200":{"description":"An identity campaign certification object","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"example":"2c9180835d2e5168015d32f890ca1581","type":"string","description":"id of the certification"},"name":{"example":"Source Owner Access Review for Employees [source]","type":"string","description":"name of the certification"},"campaign":{"type":"object","required":["id","name","type","campaignType","description","correlatedStatus","mandatoryCommentRequirement"],"properties":{"id":{"type":"string","description":"The unique ID of the campaign.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the campaign.","example":"Campaign Name"},"type":{"type":"string","enum":["CAMPAIGN"],"description":"The type of object that is being referenced.","example":"CAMPAIGN"},"campaignType":{"type":"string","enum":["MANAGER","SOURCE_OWNER","SEARCH"],"description":"The type of the campaign.","example":"MANAGER"},"description":{"type":"string","description":"The description of the campaign set by the admin who created it.","nullable":true,"example":"A description of the campaign"},"correlatedStatus":{"description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"},"mandatoryCommentRequirement":{"type":"string","description":"Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.","enum":["ALL_DECISIONS","REVOKE_ONLY_DECISIONS","NO_DECISIONS"],"example":"NO_DECISIONS"}}},"completed":{"type":"boolean","description":"Have all decisions been made?","example":true},"identitiesCompleted":{"type":"integer","description":"The number of identities for whom all decisions have been made and are complete.","example":5,"format":"int32"},"identitiesTotal":{"type":"integer","description":"The total number of identities in the Certification, both complete and incomplete.","example":10,"format":"int32"},"created":{"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"created date"},"modified":{"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"modified date"},"decisionsMade":{"type":"integer","description":"The number of approve/revoke/acknowledge decisions that have been made.","example":20,"format":"int32"},"decisionsTotal":{"type":"integer","description":"The total number of approve/revoke/acknowledge decisions.","example":40,"format":"int32"},"due":{"type":"string","format":"date-time","description":"The due date of the certification.","example":"2018-10-19T13:49:37.385Z"},"signed":{"type":"string","format":"date-time","nullable":true,"description":"The date the reviewer signed off on the Certification.","example":"2018-10-19T13:49:37.385Z"},"reviewer":{"type":"object","properties":{"id":{"type":"string","description":"The id of the reviewer.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the reviewer.","example":"Reviewer Name"},"email":{"type":"string","description":"The email of the reviewing identity.","example":"reviewer@test.com"},"type":{"type":"string","enum":["IDENTITY"],"description":"The type of the reviewing identity.","example":"IDENTITY"},"created":{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The created date of the reviewing identity."},"modified":{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The modified date of the reviewing identity."}}},"reassignment":{"type":"object","nullable":true,"properties":{"from":{"type":"object","properties":{"id":{"type":"string","description":"The id of the certification.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the certification.","example":"Certification Name"},"type":{"type":"string","enum":["CERTIFICATION"],"example":"CERTIFICATION"},"reviewer":{"type":"object","properties":{"id":{"type":"string","description":"The id of the reviewer.","example":"ef38f94347e94562b5bb8424a56397d8"},"name":{"type":"string","description":"The name of the reviewer.","example":"Reviewer Name"},"email":{"type":"string","description":"The email of the reviewing identity.","example":"reviewer@test.com"},"type":{"type":"string","enum":["IDENTITY"],"description":"The type of the reviewing identity.","example":"IDENTITY"},"created":{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The created date of the reviewing identity."},"modified":{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The modified date of the reviewing identity."}}}}},"comment":{"type":"string","description":"The comment entered when the Certification was reassigned","example":"Reassigned for a reason"}}},"hasErrors":{"description":"Identifies if the certification has an error","type":"boolean","example":false},"errorMessage":{"description":"Description of the certification error","nullable":true,"type":"string","example":"The certification has an error"},"phase":{"type":"string","description":"The current phase of the campaign.\n* `STAGED`: The campaign is waiting to be activated.\n* `ACTIVE`: The campaign is active.\n* `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete.\n","enum":["STAGED","ACTIVE","SIGNED"],"example":"ACTIVE"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/certifications/{id}/sign-off","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Finalize Identity Certification Decisions","description":{"content":"This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.","type":"text/plain"},"url":{"path":["certifications",":id","sign-off"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identity campaign certification ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Finalize Identity Certification Decisions' (sign-off-identity-certification)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Finalize Identity Certification Decisions + + + +This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +
    Path Parameters
    + +An identity campaign certification object + +
    Schema
      campaign object
      reviewer object
      reassignment object
      from object
      reviewer object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/sod-policy.tag.mdx b/products/idn/api/v3/sod-policy.tag.mdx new file mode 100644 index 000000000..4736e94d2 --- /dev/null +++ b/products/idn/api/v3/sod-policy.tag.mdx @@ -0,0 +1,20 @@ +--- +id: sod-policy +title: "SOD Policy" +description: "SOD Policy" +custom_edit_url: null +--- + + + +Operations for Creating & Executing SOD (Seperation of Duties) policies + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/sod-violations.tag.mdx b/products/idn/api/v3/sod-violations.tag.mdx new file mode 100644 index 000000000..ef462d139 --- /dev/null +++ b/products/idn/api/v3/sod-violations.tag.mdx @@ -0,0 +1,20 @@ +--- +id: sod-violations +title: "SOD Violations" +description: "SOD Violations" +custom_edit_url: null +--- + + + +Operations for Predicting SOD (Seperation of Duties) violations + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/sources.tag.mdx b/products/idn/api/v3/sources.tag.mdx new file mode 100644 index 000000000..eeddafb63 --- /dev/null +++ b/products/idn/api/v3/sources.tag.mdx @@ -0,0 +1,77 @@ +--- +id: sources +title: "Sources" +description: "Sources" +custom_edit_url: null +--- + + + +Use this API to implement and customize source functionality. +With source functionality in place, organizations can use IdentityNow to connect their various sources and user data sets and manage access across all those different sources in a secure, scalable way. + +[Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) refer to the IdentityNow representations for external applications, databases, and directory management systems that maintain their own sets of users, like Dropbox, GitHub, and Workday, for example. +Organizations may use hundreds, if not thousands, of different source systems, and any one employee within an organization likely has a different user record on each source, often with different permissions on many of those records. +Connecting these sources to IdentityNow makes it possible to manage user access across them all. +Then, if a new hire starts at an organization, IdentityNow can grant the new hire access to all the sources they need. +If an employee moves to a new department and needs access to new sources but no longer needs access to others, IdentityNow can grant the necessary access and revoke the unnecessary access for all the employee's various sources. +If an employee leaves the company, IdentityNow can revoke access to all the employee's various source accounts immediately. +These are just a few examples of the many ways that source functionality makes identity governance easier, more efficient, and more secure. + +In IdentityNow, administrators can create configure, manage, and edit sources, and they can designate other users as source admins to be able to do so. +They can also designate users as source sub-admins, who can perform the same source actions but only on sources associated with their governance groups. +Admins go to Connections > Sources to see a list of the existing source representations in their organizations. +They can create new sources or select existing ones. + +To create a new source, the following must be specified: Source Name, Description, Source Owner, and Connection Type. +Refer to [Configuring a Source](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html#configuring-a-source) for more information about the source configuration process. + +IdentityNow connects with its sources either by a direct communication with the source server (connection information specific to the source must be provided) or a flat file feed, a CSV file containing all the relevant information about the accounts to be loaded in. +Different sources use different connectors to share data with IdentityNow, and each connector's setup process is specific to that connector. +SailPoint has built a number of connectors to come out of the box and connect to the most common sources, and SailPoint actively maintains these connectors. +Refer to [IdentityNow Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about these SailPoint supported connectors. +Refer to the following links for more information about two useful connectors: + +- [JDBC Connector](https://documentation.sailpoint.com/connectors/jdbc/help/integrating_jdbc/introduction.html): This customizable connector an directly connect to databases that support JDBC (Java Database Connectivity). + +- [Web Services Connector](https://documentation.sailpoint.com/connectors/webservices/help/integrating_webservices/introduction.html): This connector can directly connect to databases that support Web Services. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/idn/docs/saas-connectivity) for more information about SailPoint's new connectivity framework that makes it easy to build and manage custom connectors to SaaS sources. + +When admins select existing sources, they can view the following information about the source: + +- Associated connections (any associated identity profiles, apps, or references to the source in a transform). + +- Associated user accounts. These accounts are linked to their identities - this provides a more complete picture of each user's access across sources. + +- Associated entitlements (sets of access rights on sources). + +- Associated access profiles (groupings of entitlements). + +The user account data and the entitlements update with each data aggregation from the source. +Organizations generally run scheduled, automated data aggregations to ensure that their data is always in sync between their sources and their IdentityNow tenants so an access change on a source is detected quickly in IdentityNow. +Admins can view a history of these aggregations, and they can also run manual imports. +Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about manual and scheduled aggregations. + +Admins can also make changes to determine which user account data IdentityNow collects from the source and how it correlates that account data with identity data. +To define which account attributes the source shares with IdentityNow, admins can edit the account schema on the source. +Refer to [Managing Source Account Schemas](https://documentation.sailpoint.com/saas/help/accounts/schema.html) for more information about source account schemas and how to edit them. +To define the mapping between the source account attributes and their correlating identity attributes, admins can edit the correlation configuration on the source. +Refer to [Assigning Source Accounts to Identities](https://documentation.sailpoint.com/saas/help/accounts/correlation.html) for more information about this correlation process between source accounts and identities. + +Admins can also delete sources, but they must first ensure that the sources no longer have any active connections: the source must not be associated with any identity profile or any app, and it must not be referenced by any transform. +Refer to [Deleting Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html#deleting-sources) for more information about deleting sources. + +Well organized, mappped out connections between sources and IdentityNow are essential to achieving comprehensive identity access governance across all the source systems organizations need. +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about all the different things admins can do with sources once they are connected. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/start-campaign.api.mdx b/products/idn/api/v3/start-campaign.api.mdx new file mode 100644 index 000000000..87f89d6be --- /dev/null +++ b/products/idn/api/v3/start-campaign.api.mdx @@ -0,0 +1,92 @@ +--- +id: start-campaign +sidebar_label: Activate a Campaign +hide_title: true +hide_table_of_contents: true +api: {"operationId":"startCampaign","tags":["Certification Campaigns"],"description":"Submits a job to activate the campaign with the given Id. The campaign must be staged.\nRequires roles of CERT_ADMIN and ORG_ADMIN","security":[{"oauth2":["idn:campaign:update"]}],"requestBody":{"description":"Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format.","required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"timeZone":{"type":"string","description":"The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as 'Z') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh.","default":"Z","example":"-05:00"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The campaign id","example":"ef38f94347e94562b5bb8424a56397d8"}],"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/campaigns/{id}/activate","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"timeZone":"-05:00"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Activate a Campaign","description":{"content":"Submits a job to activate the campaign with the given Id. The campaign must be staged.\nRequires roles of CERT_ADMIN and ORG_ADMIN","type":"text/plain"},"url":{"path":["campaigns",":id","activate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The campaign id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Activate a Campaign' (start-campaign)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Activate a Campaign + + + +Submits a job to activate the campaign with the given Id. The campaign must be staged. +Requires roles of CERT_ADMIN and ORG_ADMIN + +
    Path Parameters
    Request Body
    + +Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. + +
    + +Accepted - Returned if the request was successfully accepted into the system. + +
    Schema
    • object
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/start-evaluate-sod-policy.api.mdx b/products/idn/api/v3/start-evaluate-sod-policy.api.mdx new file mode 100644 index 000000000..cfd0d2c02 --- /dev/null +++ b/products/idn/api/v3/start-evaluate-sod-policy.api.mdx @@ -0,0 +1,75 @@ +--- +id: start-evaluate-sod-policy +sidebar_label: Evaluate one policy by ID +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:sod-violation:write"]}],"operationId":"startEvaluateSodPolicy","tags":["SOD Policy"],"description":"Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The SOD policy ID to run.","example":"ef38f943-47e9-4562-b5bb-8424a56397d8"}],"responses":{"200":{"description":"Reference to the violation report run task.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object","properties":{"status":{"type":"string","description":"Status of a violation report","enum":["SUCCESS","WARNING","ERROR","TERMINATED","TEMP_ERROR","PENDING"],"example":"PENDING"}}}]},"example":{"status":"PENDING","type":"REPORT_RESULT","id":"37b3b32a-f394-46f8-acad-b5223969fa68","name":"Multi Query Report"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sod-policies/{id}/evaluate","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Evaluate one policy by ID","description":{"content":"Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID.","type":"text/plain"},"url":{"path":["sod-policies",":id","evaluate"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The SOD policy ID to run.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Evaluate one policy by ID' (start-evaluate-sod-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Evaluate one policy by ID + + + +Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. + +
    Path Parameters
    + +Reference to the violation report run task. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/start-predict-sod-violations.api.mdx b/products/idn/api/v3/start-predict-sod-violations.api.mdx new file mode 100644 index 000000000..10dba845c --- /dev/null +++ b/products/idn/api/v3/start-predict-sod-violations.api.mdx @@ -0,0 +1,109 @@ +--- +id: start-predict-sod-violations +sidebar_label: Predict SOD violations for identity. +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:sod-violation:read"]}],"operationId":"startPredictSodViolations","tags":["SOD Violations"],"description":"This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused.\n\nA token with ORG_ADMIN or API authority is required to call this API.","requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"An identity with a set of access to be added","required":["identityId","accessRefs"],"type":"object","properties":{"identityId":{"description":"Identity id to be checked.","type":"string","example":"2c91808568c529c60168cca6f90c1313"},"accessRefs":{"description":"The list of ENTITLEMENTs to consider for calculating possible violations in a preventive check.","type":"array","items":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}],"description":"The types of objects supported for SOD violations","properties":{"type":{"enum":["ENTITLEMENT"],"example":"ENTITLEMENT","description":"The type of object that is referenced"}}},"example":[{"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"}]}}},"example":{"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"}]}}}},"responses":{"200":{"description":"Violation Contexts","content":{"application/json":{"schema":{"description":"An object containing a listing of the SOD violation reasons detected by this check.","required":["requestId"],"type":"object","properties":{"violationContexts":{"type":"array","description":"List of Violation Contexts","items":{"type":"object","properties":{"policy":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object","properties":{"type":{"type":"string","example":"SOD_POLICY"},"name":{"type":"string","example":"A very cool policy name"}}}],"description":"The types of objects supported for SOD violations","properties":{"type":{"enum":["ENTITLEMENT"],"example":"ENTITLEMENT","description":"The type of object that is referenced"}}},"conflictingAccessCriteria":{"nullable":false,"description":"The object which contains the left and right hand side of the entitlements that got violated according to the policy.","type":"object","properties":{"leftCriteria":{"type":"object","properties":{"criteriaList":{"type":"array","description":"List of exception criteria. There is a min of 1 and max of 50 items in the list.","items":{"allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local"},"existing":{"type":"boolean","description":"Whether the subject identity already had that access or not","default":false,"example":true}},"description":"Access reference with addition of boolean existing flag to indicate whether the access was extant"}],"description":"The types of objects supported for SOD violations","properties":{"type":{"enum":["ENTITLEMENT"],"example":"ENTITLEMENT","description":"The type of object that is referenced"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","existing":true},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","existing":false}]}}},"rightCriteria":{"type":"object","properties":{"criteriaList":{"type":"array","description":"List of exception criteria. There is a min of 1 and max of 50 items in the list.","items":{"allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local"},"existing":{"type":"boolean","description":"Whether the subject identity already had that access or not","default":false,"example":true}},"description":"Access reference with addition of boolean existing flag to indicate whether the access was extant"}],"description":"The types of objects supported for SOD violations","properties":{"type":{"enum":["ENTITLEMENT"],"example":"ENTITLEMENT","description":"The type of object that is referenced"}}},"example":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66","existing":true},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67","existing":false}]}}}}}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sod-violations/predict","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"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"}]},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Predict SOD violations for identity.","description":{"content":"This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused.\n\nA token with ORG_ADMIN or API authority is required to call this API.","type":"text/plain"},"url":{"path":["sod-violations","predict"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Predict SOD violations for identity.' (start-predict-sod-violations)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Predict SOD violations for identity. + + + +This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. + +A token with ORG_ADMIN or API authority is required to call this API. + +
    Request Body required
      accessRefs object[] required
      + +The list of ENTITLEMENTs to consider for calculating possible violations in a preventive check. + +
    + +Violation Contexts + +
    Schema
      violationContexts object[]
      + +List of Violation Contexts + +
      policy object
      conflictingAccessCriteria object
      + +The object which contains the left and right hand side of the entitlements that got violated according to the policy. + +
      leftCriteria object
      criteriaList object[]
      + +List of exception criteria. There is a min of 1 and max of 50 items in the list. + +
      rightCriteria object
      criteriaList object[]
      + +List of exception criteria. There is a min of 1 and max of 50 items in the list. + +
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/start-sod-all-policies-for-org.api.mdx b/products/idn/api/v3/start-sod-all-policies-for-org.api.mdx new file mode 100644 index 000000000..37ba4eb1c --- /dev/null +++ b/products/idn/api/v3/start-sod-all-policies-for-org.api.mdx @@ -0,0 +1,75 @@ +--- +id: start-sod-all-policies-for-org +sidebar_label: Runs all policies for org +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:sod-violation:write"]}],"operationId":"startSodAllPoliciesForOrg","tags":["SOD Policy"],"description":"Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided.","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"filteredPolicyList":{"type":"array","description":"Multi-policy report will be run for this list of ids","items":{"type":"string","example":["b868cd40-ffa4-4337-9c07-1a51846cfa94","63a07a7b-39a4-48aa-956d-50c827deba2a"]}}}},"example":{"filteredPolicyList":["b868cd40-ffa4-4337-9c07-1a51846cfa94","63a07a7b-39a4-48aa-956d-50c827deba2a"]}}}},"responses":{"200":{"description":"Reference to the violation report run task.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object","properties":{"status":{"type":"string","description":"Status of a violation report","enum":["SUCCESS","WARNING","ERROR","TERMINATED","TEMP_ERROR","PENDING"],"example":"PENDING"}}}]},"example":{"status":"PENDING","type":"REPORT_RESULT","id":"37b3b32a-f394-46f8-acad-b5223969fa68","name":"Multi Query Report"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sod-violation-report/run","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"filteredPolicyList":[["b868cd40-ffa4-4337-9c07-1a51846cfa94","63a07a7b-39a4-48aa-956d-50c827deba2a"]]},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Runs all policies for org","description":{"content":"Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided.","type":"text/plain"},"url":{"path":["sod-violation-report","run"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Runs all policies for org' (start-sod-all-policies-for-org)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Runs all policies for org + + + +Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. + +
    Request Body
    + +Reference to the violation report run task. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/start-sod-policy.api.mdx b/products/idn/api/v3/start-sod-policy.api.mdx new file mode 100644 index 000000000..3d72bf399 --- /dev/null +++ b/products/idn/api/v3/start-sod-policy.api.mdx @@ -0,0 +1,87 @@ +--- +id: start-sod-policy +sidebar_label: Runs SOD policy violation report +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:sod-violation:write"]}],"operationId":"startSodPolicy","tags":["SOD Policy"],"description":"This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The SOD policy ID to run.","example":"ef38f943-47e9-4562-b5bb-8424a56397d8"}],"responses":{"200":{"description":"Reference to the violation report run task.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},{"type":"object","properties":{"status":{"type":"string","description":"Status of a violation report","enum":["SUCCESS","WARNING","ERROR","TERMINATED","TEMP_ERROR","PENDING"],"example":"PENDING"}}}]},"example":{"status":"PENDING","type":"REPORT_RESULT","id":"2e8d8180-24bc-4d21-91c6-7affdb473b0d","name":"policy-xyz"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sod-policies/{id}/violation-report/run","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Runs SOD policy violation report","description":{"content":"This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message.","type":"text/plain"},"url":{"path":["sod-policies",":id","violation-report","run"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The SOD policy ID to run.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Runs SOD policy violation report' (start-sod-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Runs SOD policy violation report + + + +This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. + +
    Path Parameters
    + +Reference to the violation report run task. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/start-violation-check.api.mdx b/products/idn/api/v3/start-violation-check.api.mdx new file mode 100644 index 000000000..4cd6c610e --- /dev/null +++ b/products/idn/api/v3/start-violation-check.api.mdx @@ -0,0 +1,97 @@ +--- +id: start-violation-check +sidebar_label: Check SOD violations +hide_title: true +hide_table_of_contents: true +api: {"security":[{"oauth2":["idn:sod-violation:read"]}],"operationId":"startViolationCheck","tags":["SOD Violations"],"description":"This API initiates a SOD policy verification asynchronously.\n\nA token with ORG_ADMIN authority is required to call this API.","requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"An identity with a set of access to be added","required":["identityId","accessRefs"],"type":"object","properties":{"identityId":{"description":"Set of identity id's to be checked.","type":"string","example":"2c91809050db617d0150e0bf3215385e"},"accessRefs":{"description":"The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type.","type":"array","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}}},"clientMetadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check.","example":{"clientName":"client1","clientId":"2c91808f7892918f0178b78da4a305a1"}}}},"example":{"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"}}}}},"responses":{"202":{"description":"Request ID with a timestamp.","content":{"application/json":{"schema":{"description":"An object referencing an SOD violation check","required":["requestId"],"type":"object","properties":{"requestId":{"description":"The id of the original request","example":"089899f13a8f4da7824996191587bab9","type":"string"},"created":{"type":"string","format":"date-time","readOnly":true,"description":"The date-time when this request was created.","example":"2020-01-01T00:00:00.000000Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sod-violations/check","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"identityId":"2c91809050db617d0150e0bf3215385e","accessRefs":[{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"}],"clientMetadata":{"clientName":"client1","clientId":"2c91808f7892918f0178b78da4a305a1"}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Check SOD violations","description":{"content":"This API initiates a SOD policy verification asynchronously.\n\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sod-violations","check"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Check SOD violations' (start-violation-check)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Check SOD violations + + + +This API initiates a SOD policy verification asynchronously. + +A token with ORG_ADMIN authority is required to call this API. + +
    Request Body required
      accessRefs object[] required
      + +The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type. + +
      clientMetadata object
      + +Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. + +
    • property name* string
    + +Request ID with a timestamp. + +
    Schema
    + +Client Error - Returned if the request body is invalid. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
    + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
    Schema
    + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 403 response object

    + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 404 response object

    + +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. + +
    Schema
    + +Internal Server Error - Returned if there is an unexpected error. + +
    Schema
      messages object[]
      + +Generic localized reason for error + +
      causes object[]
      + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

    An example of a 500 response object

    \ No newline at end of file diff --git a/products/idn/api/v3/submit-account-selection.api.mdx b/products/idn/api/v3/submit-account-selection.api.mdx new file mode 100644 index 000000000..7da399f27 --- /dev/null +++ b/products/idn/api/v3/submit-account-selection.api.mdx @@ -0,0 +1,91 @@ +--- +id: submit-account-selection +sidebar_label: Submit Account Selections +hide_title: true +hide_table_of_contents: true +api: {"operationId":"submitAccountSelection","tags":["Work Items"],"description":"This API submits account selections. Either an admin, or the owning/current user must make this request.","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the work item","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"fieldName":"fieldValue"}}},"description":"Account Selection Data map, keyed on fieldName"},"responses":{"200":{"description":"A work items details object.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the work item","example":"2c9180835d2e5168015d32f890ca1581"},"requesterId":{"type":"string","description":"ID of the requester","example":"2c9180835d2e5168015d32f890ca1581"},"requesterDisplayName":{"type":"string","description":"The displayname of the requester","example":"John Smith"},"ownerId":{"type":"string","description":"The ID of the owner","example":"2c9180835d2e5168015d32f890ca1581"},"ownerName":{"type":"string","description":"The name of the owner","example":"Jason Smith"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z","description":"Time when the work item was created"},"modified":{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"Time when the work item was last updated"},"description":{"type":"string","description":"The description of the work item","example":"Create account on source 'AD'"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"},"type":{"type":"string","enum":["UNKNOWN","GENERIC","CERTIFICATION","REMEDIATION","DELEGATION","APPROVAL","VIOLATIONREVIEW","FORM","POLICYVIOLATION","CHALLENGE","IMPACTANALYSIS","SIGNOFF","EVENT","MANUALACTION","TEST"],"example":"GENERIC","description":"The type of the work item"},"remediationItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the certification","example":"2c9180835d2e5168015d32f890ca1581"},"targetId":{"type":"string","description":"The ID of the certification target","example":"2c9180835d2e5168015d32f890ca1581"},"targetName":{"type":"string","description":"The name of the certification target","example":"john.smith"},"targetDisplayName":{"type":"string","description":"The display name of the certification target","example":"emailAddress"},"applicationName":{"type":"string","description":"The name of the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute being certified","example":"phoneNumber"},"attributeOperation":{"type":"string","description":"The operation of the certification on the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute being certified","example":"512-555-1212"},"nativeIdentity":{"type":"string","description":"The native identity of the target","example":"jason.smith2"}}},"approvalItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the approval item","example":"2c9180835d2e5168015d32f890ca1581"},"account":{"type":"string","description":"The account referenced by the approval item","example":"john.smith"},"application":{"type":"string","description":"The name the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute","example":"emailAddress"},"attributeOperation":{"type":"string","description":"The operation of the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute","example":"a@b.com"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"],"example":"FINISHED","description":"The state of a work item"}}},"name":{"type":"string","description":"The work item name","example":"Account Create"},"completed":{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z","description":"The time at which the work item completed"},"numItems":{"type":"integer","format":"int32","description":"The number of items in the work item","example":19},"form":{"type":"object","properties":{"id":{"type":"string","description":"ID of the form","example":"2c9180835d2e5168015d32f890ca1581"},"name":{"type":"string","description":"Name of the form","example":"AccountSelection Form"},"title":{"type":"string","description":"The form title","example":"Account Selection for John.Doe"},"subtitle":{"type":"string","description":"The form subtitle.","example":"Please select from the following"},"targetUser":{"type":"string","description":"The name of the user that should be shown this form","example":"Jane.Doe"},"sections":{"type":"object","allOf":[{"type":"object","properties":{"name":{"type":"string","description":"Name of the FormItem","example":"Field1"}}},{"type":"object","properties":{"label":{"type":"string","description":"Label of the section","example":"Section 1"},"formItems":{"type":"array","items":{"type":"object"},"description":"List of FormItems. FormItems can be SectionDetails and/or FieldDetails","example":[]}}}]}}},"errors":{"type":"array","items":{"type":"string"},"example":["The work item ID that was specified was not found."],"description":"An array of errors that ocurred during the work item"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/work-items/{id}/submit-account-selection","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Submit Account Selections","description":{"content":"This API submits account selections. Either an admin, or the owning/current user must make this request.","type":"text/plain"},"url":{"path":["work-items",":id","submit-account-selection"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the work item","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Submit Account Selections' (submit-account-selection)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Submit Account Selections + + + +This API submits account selections. Either an admin, or the owning/current user must make this request. + +
    Path Parameters
    Request Body required
    + +Account Selection Data map, keyed on fieldName + +
      + +A work items details object. + +
      Schema
        remediationItems object
        approvalItems object
        form object
        sections object
      + +Client Error - Returned if the request body is invalid. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
      + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
      Schema
      + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 403 response object

      + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 404 response object

      + +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. + +
      Schema
      + +Internal Server Error - Returned if there is an unexpected error. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 500 response object

      \ No newline at end of file diff --git a/products/idn/api/v3/tagged-objects.tag.mdx b/products/idn/api/v3/tagged-objects.tag.mdx new file mode 100644 index 000000000..f3476c34c --- /dev/null +++ b/products/idn/api/v3/tagged-objects.tag.mdx @@ -0,0 +1,16 @@ +--- +id: tagged-objects +title: "Tagged Objects" +description: "Tagged Objects" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/transforms.tag.mdx b/products/idn/api/v3/transforms.tag.mdx new file mode 100644 index 000000000..9e15c49fd --- /dev/null +++ b/products/idn/api/v3/transforms.tag.mdx @@ -0,0 +1,26 @@ +--- +id: transforms +title: "Transforms" +description: "Transforms" +custom_edit_url: null +--- + + + +The purpose of this API is to expose functionality for the manipulation of Transform objects. +Transforms are a form of configurable objects which define an easy way to manipulate attribute data without having +to write code. These endpoints don't require API calls to other resources, audit service is used for keeping track +of which users have made changes to the Transforms. + +Refer to [Transforms](https://developer.sailpoint.com/idn/docs/transforms) for more information about transforms. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/api/v3/unlock-account.api.mdx b/products/idn/api/v3/unlock-account.api.mdx new file mode 100644 index 000000000..64a5a5016 --- /dev/null +++ b/products/idn/api/v3/unlock-account.api.mdx @@ -0,0 +1,88 @@ +--- +id: unlock-account +sidebar_label: Unlock Account +hide_title: true +hide_table_of_contents: true +api: {"operationId":"unlockAccount","tags":["Accounts"],"description":"This API submits a task to unlock an account and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:accounts-state:manage"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The account id","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"Request used for account unlock","type":"object","properties":{"externalVerificationId":{"description":"If set, an external process validates that the user wants to proceed with this request.","type":"string","example":"3f9180835d2e5168015d32f890ca1581"},"unlockIDNAccount":{"description":"If set, the IDN account is unlocked after the workflow completes.","type":"boolean","example":false},"forceProvisioning":{"description":"If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated.","type":"boolean","example":false}}}}}},"responses":{"202":{"description":"Async task details","content":{"application/json":{"schema":{"description":"Accounts async response containing details on started async process","required":["id"],"type":"object","properties":{"id":{"description":"id of the task","type":"string","example":"2c91808474683da6017468693c260195"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/accounts/{id}/unlock","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"externalVerificationId":"3f9180835d2e5168015d32f890ca1581","unlockIDNAccount":false,"forceProvisioning":false},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Unlock Account","description":{"content":"This API submits a task to unlock an account and returns the task ID. \nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts",":id","unlock"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The account id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Unlock Account' (unlock-account)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Unlock Account + + + +This API submits a task to unlock an account and returns the task ID. +A token with ORG_ADMIN authority is required to call this API. + +
      Path Parameters
      Request Body required
      + +Async task details + +
      Schema
      + +Client Error - Returned if the request body is invalid. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
      + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
      Schema
      + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 403 response object

      + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 404 response object

      + +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. + +
      Schema
      + +Internal Server Error - Returned if there is an unexpected error. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 500 response object

      \ No newline at end of file diff --git a/products/idn/api/v3/unsubscribe-scheduled-search.api.mdx b/products/idn/api/v3/unsubscribe-scheduled-search.api.mdx new file mode 100644 index 000000000..9090c5307 --- /dev/null +++ b/products/idn/api/v3/unsubscribe-scheduled-search.api.mdx @@ -0,0 +1,73 @@ +--- +id: unsubscribe-scheduled-search +sidebar_label: Unsubscribe a recipient from Scheduled Search +hide_title: true +hide_table_of_contents: true +api: {"tags":["Scheduled Search"],"description":"Unsubscribes a recipient from the specified scheduled search.\n","operationId":"unsubscribeScheduledSearch","parameters":[{"in":"path","name":"id","description":"ID of the requested document.","schema":{"type":"string"},"required":true,"example":"2c91808568c529c60168cca6f90c1313"}],"requestBody":{"description":"The recipient to be removed from the scheduled search.\n","content":{"application/json":{"schema":{"type":"object","description":"A typed reference to the object.\n","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"description":"The id of the object.\n","type":"string","example":"2c91808568c529c60168cca6f90c1313"}},"required":["type","id"]}}},"required":true},"responses":{"204":{"description":"No Content - Indicates the request was successful but there is no content to be returned in the response."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}}},"method":"post","path":"/scheduled-searches/{id}/unsubscribe","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Unsubscribe a recipient from Scheduled Search","description":{"content":"Unsubscribes a recipient from the specified scheduled search.\n","type":"text/plain"},"url":{"path":["scheduled-searches",":id","unsubscribe"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the requested document.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Unsubscribe a recipient from Scheduled Search' (unsubscribe-scheduled-search)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Unsubscribe a recipient from Scheduled Search + + + +Unsubscribes a recipient from the specified scheduled search. + + +
      Path Parameters
      Request Body required
      + +The recipient to be removed from the scheduled search. + + +
      + +No Content - Indicates the request was successful but there is no content to be returned in the response. + +
      + +Client Error - Returned if the request body is invalid. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
      + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 403 response object

      + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 404 response object

      \ No newline at end of file diff --git a/products/idn/api/v3/update-access-request-config.api.mdx b/products/idn/api/v3/update-access-request-config.api.mdx new file mode 100644 index 000000000..cf427ee85 --- /dev/null +++ b/products/idn/api/v3/update-access-request-config.api.mdx @@ -0,0 +1,100 @@ +--- +id: update-access-request-config +sidebar_label: Update Access Request Configuration +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateAccessRequestConfig","tags":["Access Requests"],"description":"This endpoint replaces the current access-request configuration.\nA token with ORG_ADMIN authority is required to call this API.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"approvalsMustBeExternal":{"type":"boolean","description":"If true, then approvals must be processed by external system.","example":true},"autoApprovalEnabled":{"type":"boolean","description":"If true and requester and reviewer are the same, then automatically approve the approval.","example":true},"requestOnBehalfOfConfig":{"description":"Request On Behalf Of Configuration.","type":"object","properties":{"allowRequestOnBehalfOfAnyoneByAnyone":{"type":"boolean","description":"If anyone can request access for anyone.","example":true},"allowRequestOnBehalfOfEmployeeByManager":{"type":"boolean","description":"If a manager can request access for his/her direct reports.","example":true}}},"approvalReminderAndEscalationConfig":{"description":"Approval Reminder and Escalation Configuration.","type":"object","properties":{"daysUntilEscalation":{"type":"integer","description":"Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation.","format":"int32","example":0},"daysBetweenReminders":{"type":"integer","description":"Number of days to wait between reminder notifications.","format":"int32","example":0},"maxReminders":{"type":"integer","description":"Maximum number of reminder notification to send to the reviewer before approval escalation.","format":"int32","example":0},"fallbackApproverRef":{"type":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"},"id":{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"},"name":{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"},"email":{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}}}},"entitlementRequestConfig":{"description":"Entitlement Request Configuration.","type":"object","properties":{"allowEntitlementRequest":{"type":"boolean","description":"Flag for allowing entitlement request.","example":true},"requestCommentsRequired":{"type":"boolean","description":"Flag for requiring comments while submitting an entitlement request.","default":false,"example":false},"deniedCommentsRequired":{"type":"boolean","description":"Flag for requiring comments while rejecting an entitlement request.","default":false,"example":false},"grantRequestApprovalSchemes":{"type":"string","description":"Approval schemes for granting entitlement request. This can be empty if no approval is needed.\nMultiple schemes must be comma-separated. The valid schemes are \"entitlementOwner\", \"sourceOwner\", \"manager\" and \"workgroup:{id}\".\nMultiple workgroups (governance groups) can be used.\n","default":"sourceOwner","example":"entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584"}}}}}}}},"responses":{"200":{"description":"Access Request Configuration Details.","content":{"application/json":{"schema":{"type":"object","properties":{"approvalsMustBeExternal":{"type":"boolean","description":"If true, then approvals must be processed by external system.","example":true},"autoApprovalEnabled":{"type":"boolean","description":"If true and requester and reviewer are the same, then automatically approve the approval.","example":true},"requestOnBehalfOfConfig":{"description":"Request On Behalf Of Configuration.","type":"object","properties":{"allowRequestOnBehalfOfAnyoneByAnyone":{"type":"boolean","description":"If anyone can request access for anyone.","example":true},"allowRequestOnBehalfOfEmployeeByManager":{"type":"boolean","description":"If a manager can request access for his/her direct reports.","example":true}}},"approvalReminderAndEscalationConfig":{"description":"Approval Reminder and Escalation Configuration.","type":"object","properties":{"daysUntilEscalation":{"type":"integer","description":"Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation.","format":"int32","example":0},"daysBetweenReminders":{"type":"integer","description":"Number of days to wait between reminder notifications.","format":"int32","example":0},"maxReminders":{"type":"integer","description":"Maximum number of reminder notification to send to the reviewer before approval escalation.","format":"int32","example":0},"fallbackApproverRef":{"type":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"},"id":{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"},"name":{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"},"email":{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}}}},"entitlementRequestConfig":{"description":"Entitlement Request Configuration.","type":"object","properties":{"allowEntitlementRequest":{"type":"boolean","description":"Flag for allowing entitlement request.","example":true},"requestCommentsRequired":{"type":"boolean","description":"Flag for requiring comments while submitting an entitlement request.","default":false,"example":false},"deniedCommentsRequired":{"type":"boolean","description":"Flag for requiring comments while rejecting an entitlement request.","default":false,"example":false},"grantRequestApprovalSchemes":{"type":"string","description":"Approval schemes for granting entitlement request. This can be empty if no approval is needed.\nMultiple schemes must be comma-separated. The valid schemes are \"entitlementOwner\", \"sourceOwner\", \"manager\" and \"workgroup:{id}\".\nMultiple workgroups (governance groups) can be used.\n","default":"sourceOwner","example":"entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584"}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/access-request-config","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"approvalsMustBeExternal":true,"autoApprovalEnabled":true,"requestOnBehalfOfConfig":{"allowRequestOnBehalfOfAnyoneByAnyone":true,"allowRequestOnBehalfOfEmployeeByManager":true},"approvalReminderAndEscalationConfig":{"daysUntilEscalation":0,"daysBetweenReminders":0,"maxReminders":0,"fallbackApproverRef":{"type":"IDENTITY","id":"5168015d32f890ca15812c9180835d2e","name":"Alison Ferguso","email":"alison.ferguso@identitysoon.com"}},"entitlementRequestConfig":{"allowEntitlementRequest":true,"requestCommentsRequired":false,"deniedCommentsRequired":false,"grantRequestApprovalSchemes":"entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584"}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Update Access Request Configuration","description":{"content":"This endpoint replaces the current access-request configuration.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["access-request-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "put api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Access Request Configuration' (update-access-request-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Access Request Configuration + + + +This endpoint replaces the current access-request configuration. +A token with ORG_ADMIN authority is required to call this API. + +
      Request Body required
        requestOnBehalfOfConfig object
        + +Request On Behalf Of Configuration. + +
        approvalReminderAndEscalationConfig object
        + +Approval Reminder and Escalation Configuration. + +
        fallbackApproverRef object
        entitlementRequestConfig object
        + +Entitlement Request Configuration. + +
      + +Access Request Configuration Details. + +
      Schema
        requestOnBehalfOfConfig object
        + +Request On Behalf Of Configuration. + +
        approvalReminderAndEscalationConfig object
        + +Approval Reminder and Escalation Configuration. + +
        fallbackApproverRef object
        entitlementRequestConfig object
        + +Entitlement Request Configuration. + +
      + +Client Error - Returned if the request body is invalid. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
      + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
      Schema
      + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 403 response object

      + +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. + +
      Schema
      + +Internal Server Error - Returned if there is an unexpected error. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 500 response object

      \ No newline at end of file diff --git a/products/idn/api/v3/update-account.api.mdx b/products/idn/api/v3/update-account.api.mdx new file mode 100644 index 000000000..91934f271 --- /dev/null +++ b/products/idn/api/v3/update-account.api.mdx @@ -0,0 +1,104 @@ +--- +id: update-account +sidebar_label: Update Account +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateAccount","tags":["Accounts"],"description":"Use this API to modify the following fields:\n* `identityId`\n\n* `manuallyCorrelated`\n\n>**NOTE: All other fields cannot be modified.**\n\nThe request must provide a JSONPatch payload.\n\nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:accounts:manage"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The account ID","example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"description":"A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"example":[{"op":"replace","path":"/identityId","value":"2c9180845d1edece015d27a975983e21"}]}}},"responses":{"202":{"description":"Accepted - Returned if the request was successfully accepted into the system.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/accounts/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Update Account","description":{"content":"Use this API to modify the following fields:\n* `identityId`\n\n* `manuallyCorrelated`\n\n>**NOTE: All other fields cannot be modified.**\n\nThe request must provide a JSONPatch payload.\n\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["accounts",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The account ID","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Account' (update-account)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Account + + + +Use this API to modify the following fields: +* `identityId` + +* `manuallyCorrelated` + +>**NOTE: All other fields cannot be modified.** + +The request must provide a JSONPatch payload. + +A token with ORG_ADMIN authority is required to call this API. + +
      Path Parameters
      Request Body array required
      + +A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +
        value object
        + +The value to be used for the operation, required for "add" and "replace" operations + +
        anyOf
      • string
      • integer
        • anyOf
      • string
      • integer
      + +Accepted - Returned if the request was successfully accepted into the system. + +
      Schema
      • object
      + +Client Error - Returned if the request body is invalid. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
      + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
      Schema
      + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 403 response object

      + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 404 response object

      + +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. + +
      Schema
      + +Internal Server Error - Returned if there is an unexpected error. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 500 response object

      \ No newline at end of file diff --git a/products/idn/api/v3/update-lifecycle-states.api.mdx b/products/idn/api/v3/update-lifecycle-states.api.mdx new file mode 100644 index 000000000..ce80a17e7 --- /dev/null +++ b/products/idn/api/v3/update-lifecycle-states.api.mdx @@ -0,0 +1,108 @@ +--- +id: update-lifecycle-states +sidebar_label: Update Lifecycle State +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateLifecycleStates","tags":["Lifecycle States"],"description":"This endpoint updates individual Lifecycle State fields using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\nA token with ORG_ADMIN or API authority is required to call this API.","security":[{"oauth2":["idn:identity-profile-lifecycle-state:manage"]}],"parameters":[{"in":"path","name":"identity-profile-id","description":"Identity Profile ID","required":true,"schema":{"type":"string"},"example":"2b838de9-db9b-abcf-e646-d4f274ad4238"},{"in":"path","name":"lifecycle-state-id","description":"Lifecycle State ID","required":true,"schema":{"type":"string"},"example":"ef38f94347e94562b5bb8424a56397d8"}],"requestBody":{"required":true,"description":"A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nThe following fields can be updated:\n* enabled\n* description\n* accountActions\n* accessProfileIds\n* emailNotificationOption\n","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"example":[{"op":"replace","path":"/description","value":"Updated description!"},{"op":"replace","path":"/accessProfileIds","value":["2c918087742bab150174407a80f3125e","2c918087742bab150174407a80f3124f"]},{"op":"replace","path":"/accountActions","value":[{"action":"ENABLE","sourceIds":["2c9180846a2f82fb016a481c1b1560c5","2c9180846a2f82fb016a481c1b1560cc"]},{"action":"DISABLE","sourceIds":["2c91808869a0c9980169a207258513fb"]}]},{"op":"replace","path":"/emailNotificationOption","value":{"notifyManagers":true,"notifyAllAdmins":false,"notifySpecificUsers":false,"emailAddressList":[]}}]}}},"responses":{"200":{"description":"The LifecycleState was successfully updated.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"id":{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true},"name":{"description":"Name of the Object","type":"string","example":"aName"},"created":{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true},"modified":{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}},{"type":"object","required":["technicalName"],"properties":{"enabled":{"type":"boolean","example":true,"description":"Whether the lifecycle state is enabled or disabled."},"technicalName":{"type":"string","example":"Technical Name","description":"The technical name for lifecycle state. This is for internal use."},"description":{"type":"string","example":"Lifecycle description","description":"Lifecycle state description."},"identityCount":{"type":"integer","format":"int32","example":42,"readOnly":true,"description":"Number of identities that have the lifecycle state."},"emailNotificationOption":{"type":"object","description":"This is used for representing email configuration for a lifecycle state","properties":{"notifyManagers":{"type":"boolean","example":true,"description":"If true, then the manager is notified of the lifecycle state change."},"notifyAllAdmins":{"type":"boolean","example":true,"description":"If true, then all the admins are notified of the lifecycle state change."},"notifySpecificUsers":{"type":"boolean","example":true,"description":"If true, then the users specified in \"emailAddressList\" below are notified of lifecycle state change."},"emailAddressList":{"type":"array","example":["test@test.com","test2@test.com"],"items":{"type":"string"},"description":"List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change."}}},"accountActions":{"type":"array","items":{"type":"object","description":"Object for specifying Actions to be performed on a specified list of sources' account.","properties":{"action":{"example":"ENABLE","type":"string","description":"Describes if action will be enabled or disabled","enum":["ENABLE","DISABLE"]},"sourceIds":{"type":"array","items":{"type":"string"},"uniqueItems":true,"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"],"description":"List of unique source IDs. The sources must have the ENABLE feature or flat file source. See \"/sources\" endpoint for source features."}}}},"accessProfileIds":{"type":"array","items":{"type":"string"},"uniqueItems":true,"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"],"description":"List of unique access-profile IDs that are associated with the lifecycle state."}}}]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Update Lifecycle State","description":{"content":"This endpoint updates individual Lifecycle State fields using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\nA token with ORG_ADMIN or API authority is required to call this API.","type":"text/plain"},"url":{"path":["identity-profiles",":identity-profile-id","lifecycle-states",":lifecycle-state-id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Identity Profile ID","type":"text/plain"},"type":"any","value":"","key":"identity-profile-id"},{"disabled":false,"description":{"content":"(Required) Lifecycle State ID","type":"text/plain"},"type":"any","value":"","key":"lifecycle-state-id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Lifecycle State' (update-lifecycle-states)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Lifecycle State + + + +This endpoint updates individual Lifecycle State fields using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +A token with ORG_ADMIN or API authority is required to call this API. + +
      Path Parameters
      Request Body array required
      + +A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +The following fields can be updated: +* enabled +* description +* accountActions +* accessProfileIds +* emailNotificationOption + + +
        value object
        + +The value to be used for the operation, required for "add" and "replace" operations + +
        anyOf
      • string
      • integer
        • anyOf
      • string
      • integer
      + +The LifecycleState was successfully updated. + +
      Schema
        emailNotificationOption object
        + +This is used for representing email configuration for a lifecycle state + +
        accountActions object[]
      + +Client Error - Returned if the request body is invalid. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
      + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
      Schema
      + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 403 response object

      + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 404 response object

      + +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. + +
      Schema
      + +Internal Server Error - Returned if there is an unexpected error. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 500 response object

      \ No newline at end of file diff --git a/products/idn/api/v3/update-non-employee-record.api.mdx b/products/idn/api/v3/update-non-employee-record.api.mdx new file mode 100644 index 000000000..b7388214a --- /dev/null +++ b/products/idn/api/v3/update-non-employee-record.api.mdx @@ -0,0 +1,103 @@ +--- +id: update-non-employee-record +sidebar_label: Update Non-Employee Record +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateNonEmployeeRecord","security":[{"oauth2":[]}],"tags":["Non-Employee Lifecycle Management"],"description":"This request will update a non-employee record. There are two contextual uses for this endpoint:\n 1. The user has the role context of `idn:nesr:update`, in which case they\nupdate all available fields.\n 2. The user is owner of the source, in this case they can only update the\nend date.","parameters":[{"in":"path","name":"id","description":"Non-employee record id (UUID)","example":"ef38f94347e94562b5bb8424a56397d8","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accountName":{"type":"string","description":"Requested identity account name.","example":"william.smith"},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"sourceId":{"type":"string","description":"Non-Employee's source id.","example":"2c91808568c529c60168cca6f90c1313"},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported.","example":{"description":"Auditing"}},"startDate":{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2020-03-24T00:00:00-05:00"},"endDate":{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2021-03-25T00:00:00-05:00"}},"required":["accountName","firstName","lastName","email","phone","manager","sourceId","startDate","endDate"]}}}},"responses":{"200":{"description":"An updated non-employee record.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"Non-Employee record id.","example":"ef38f94347e94562b5bb8424a56397d8"},"accountName":{"type":"string","description":"Requested identity account name.","example":"Abby.Smith"},"firstName":{"type":"string","description":"Non-Employee's first name.","example":"William"},"lastName":{"type":"string","description":"Non-Employee's last name.","example":"Smith"},"email":{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"},"phone":{"type":"string","description":"Non-Employee's phone.","example":"5555555555"},"manager":{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"},"sourceId":{"type":"string","description":"Non-Employee's source id.","example":"2c91808568c529c60168cca6f90c1313"},"data":{"type":"object","additionalProperties":{"type":"string"},"description":"Attribute blob/bag for a non-employee.","example":{"description":"Auditing"}},"startDate":{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2019-08-23T18:52:59.162Z"},"endDate":{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2020-08-23T18:52:59.162Z"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/non-employee-records/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"accountName":"william.smith","firstName":"William","lastName":"Smith","email":"william.smith@example.com","phone":"5555555555","manager":"jane.doe","sourceId":"2c91808568c529c60168cca6f90c1313","data":{"description":"Auditing"},"startDate":"2020-03-24T00:00:00-05:00","endDate":"2021-03-25T00:00:00-05:00"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Update Non-Employee Record","description":{"content":"This request will update a non-employee record. There are two contextual uses for this endpoint:\n 1. The user has the role context of `idn:nesr:update`, in which case they\nupdate all available fields.\n 2. The user is owner of the source, in this case they can only update the\nend date.","type":"text/plain"},"url":{"path":["non-employee-records",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Non-employee record id (UUID)","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Non-Employee Record' (update-non-employee-record)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Non-Employee Record + + + +This request will update a non-employee record. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:update`, in which case they +update all available fields. + 2. The user is owner of the source, in this case they can only update the +end date. + +
      Path Parameters
      Request Body required
      + +Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + +
        data object
        + +Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported. + +
      • property name* string
      + +An updated non-employee record. + +
      Schema
        data object
        + +Attribute blob/bag for a non-employee. + +
      • property name* string
      + +Client Error - Returned if the request body is invalid. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
      + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
      Schema
      + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 403 response object

      + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 404 response object

      + +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. + +
      Schema
      + +Internal Server Error - Returned if there is an unexpected error. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 500 response object

      \ No newline at end of file diff --git a/products/idn/api/v3/update-password-dictionary.api.mdx b/products/idn/api/v3/update-password-dictionary.api.mdx new file mode 100644 index 000000000..e9e715be9 --- /dev/null +++ b/products/idn/api/v3/update-password-dictionary.api.mdx @@ -0,0 +1,124 @@ +--- +id: update-password-dictionary +sidebar_label: Update Password Dictionary +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updatePasswordDictionary","tags":["Password Dictionary"],"description":"This updates password dictionary for the organization.\nA token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:password-dictionary:manage"]}],"requestBody":{"required":true,"description":"\nThe password dictionary file can contain lines that are:\n1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing\n2. empty lines\n3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines\n4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed;\n maximum length of the line is 128 Unicode codepoints\n\n\nPassword dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line).\n Password dict file must contain UTF-8 characters only.\n\n# Sample password text file\n\n```\n\n# Password dictionary small test file\n\nlocale=en_US\n\n# Password dictionary prohibited words\n\nqwerty\nabcd\naaaaa\npassword\nqazxsws\n\n```","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Successfully updated."},"201":{"description":"Created."},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/password-dictionary","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Update Password Dictionary","description":{"content":"This updates password dictionary for the organization.\nA token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["password-dictionary"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"formdata","formdata":[]},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Password Dictionary' (update-password-dictionary)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Password Dictionary + + + +This updates password dictionary for the organization. +A token with ORG_ADMIN authority is required to call this API. + +
      Request Body required
      + + +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +
      + +Successfully updated. + +
      + +Created. + +
      + +Client Error - Returned if the request body is invalid. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
      + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
      Schema
      + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 403 response object

      + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 404 response object

      + +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. + +
      Schema
      + +Internal Server Error - Returned if there is an unexpected error. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 500 response object

      \ No newline at end of file diff --git a/products/idn/api/v3/update-password-org-config.api.mdx b/products/idn/api/v3/update-password-org-config.api.mdx new file mode 100644 index 000000000..f1432bc2c --- /dev/null +++ b/products/idn/api/v3/update-password-org-config.api.mdx @@ -0,0 +1,75 @@ +--- +id: update-password-org-config +sidebar_label: Update Password Org Config +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updatePasswordOrgConfig","tags":["Password Configuration"],"description":"This API updates the password org config for specified fields. Other fields will keep original value. Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'","security":[{"oauth2":["idn:password-org-config:write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customInstructionsEnabled":{"type":"boolean","description":"Indicator whether custom password instructions feature is enabled. The default value is false.","default":false,"example":true},"digitTokenEnabled":{"type":"boolean","description":"Indicator whether \"digit token\" feature is enabled. The default value is false.","default":false,"example":true},"digitTokenDurationMinutes":{"type":"integer","format":"int32","description":"The duration of \"digit token\" in minutes. The default value is 5.","minimum":1,"maximum":60,"default":5,"example":10},"digitTokenLength":{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}},"example":{"digitTokenEnabled":true,"digitTokenDurationMinutes":12}}}},"responses":{"200":{"description":"Reference to the password org config.","content":{"application/json":{"schema":{"type":"object","properties":{"customInstructionsEnabled":{"type":"boolean","description":"Indicator whether custom password instructions feature is enabled. The default value is false.","default":false,"example":true},"digitTokenEnabled":{"type":"boolean","description":"Indicator whether \"digit token\" feature is enabled. The default value is false.","default":false,"example":true},"digitTokenDurationMinutes":{"type":"integer","format":"int32","description":"The duration of \"digit token\" in minutes. The default value is 5.","minimum":1,"maximum":60,"default":5,"example":10},"digitTokenLength":{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}},"example":{"customInstructionsEnabled":true,"digitTokenDurationMinutes":12,"digitTokenEnabled":true,"digitTokenLength":6}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/password-org-config","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"customInstructionsEnabled":true,"digitTokenEnabled":true,"digitTokenDurationMinutes":10,"digitTokenLength":9},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Update Password Org Config","description":{"content":"This API updates the password org config for specified fields. Other fields will keep original value. Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'","type":"text/plain"},"url":{"path":["password-org-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Password Org Config' (update-password-org-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Password Org Config + + + +This API updates the password org config for specified fields. Other fields will keep original value. Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +
      Request Body required
        = 1` and `<= 60`"} defaultValue={5}>= 6` and `<= 18`"} defaultValue={6}>
      + +Reference to the password org config. + +
      Schema
        = 1` and `<= 60`"} defaultValue={5}>= 6` and `<= 18`"} defaultValue={6}>
      + +Client Error - Returned if the request body is invalid. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
      + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
      Schema
      + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 403 response object

      + +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. + +
      Schema
      + +Internal Server Error - Returned if there is an unexpected error. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 500 response object

      \ No newline at end of file diff --git a/products/idn/api/v3/update-password-sync-group.api.mdx b/products/idn/api/v3/update-password-sync-group.api.mdx new file mode 100644 index 000000000..c6d20cba2 --- /dev/null +++ b/products/idn/api/v3/update-password-sync-group.api.mdx @@ -0,0 +1,87 @@ +--- +id: update-password-sync-group +sidebar_label: Update Password Sync Group by ID +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updatePasswordSyncGroup","tags":["Password Sync Groups"],"description":"This API updates the specified password sync group. A token with ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:password-sync-group-management:write"]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of password sync group to update.","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the sync group","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"},"name":{"description":"Name of the sync group","type":"string","example":"Password Sync Group 1"},"passwordPolicyId":{"type":"string","description":"ID of the password policy","example":"2c91808d744ba0ce01746f93b6204501"},"sourceIds":{"type":"array","description":"List of password managed sources IDs","items":{"type":"string"},"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}},"example":{"id":"6881f631-3bd5-4213-9c75-8e05cc3e35dd","name":"Password Sync Group 2","passwordPolicyId":"2c91808d744ba0ce01746f93b6204501","sourceIds":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}}},"responses":{"200":{"description":"Reference to the password sync group.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the sync group","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"},"name":{"description":"Name of the sync group","type":"string","example":"Password Sync Group 1"},"passwordPolicyId":{"type":"string","description":"ID of the password policy","example":"2c91808d744ba0ce01746f93b6204501"},"sourceIds":{"type":"array","description":"List of password managed sources IDs","items":{"type":"string"},"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}},"example":{"id":"6881f631-3bd5-4213-9c75-8e05cc3e35dd","name":"Password Sync Group 2","passwordPolicyId":"2c91808d744ba0ce01746f93b6204501","sourceIds":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/password-sync-groups/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"id":"6881f631-3bd5-4213-9c75-8e05cc3e35dd","name":"Password Sync Group 1","passwordPolicyId":"2c91808d744ba0ce01746f93b6204501","sourceIds":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Update Password Sync Group by ID","description":{"content":"This API updates the specified password sync group. A token with ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["password-sync-groups",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of password sync group to update.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Password Sync Group by ID' (update-password-sync-group)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Password Sync Group by ID + + + +This API updates the specified password sync group. A token with ORG_ADMIN authority is required to call this API. + +
      Path Parameters
      Request Body required
      + +Reference to the password sync group. + +
      Schema
      + +Client Error - Returned if the request body is invalid. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
      + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
      Schema
      + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 403 response object

      + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 404 response object

      + +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. + +
      Schema
      + +Internal Server Error - Returned if there is an unexpected error. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 500 response object

      \ No newline at end of file diff --git a/products/idn/api/v3/update-provisioning-policies-in-bulk.api.mdx b/products/idn/api/v3/update-provisioning-policies-in-bulk.api.mdx new file mode 100644 index 000000000..28055defc --- /dev/null +++ b/products/idn/api/v3/update-provisioning-policies-in-bulk.api.mdx @@ -0,0 +1,88 @@ +--- +id: update-provisioning-policies-in-bulk +sidebar_label: Bulk Update Provisioning Policies +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateProvisioningPoliciesInBulk","tags":["Sources"],"description":"This end-point updates a list of provisioning policies on the specified source in IdentityNow.\nA token with API, or ORG_ADMIN authority is required to call this API.","security":[{"oauth2":["idn:provisioning-policy:manage"]}],"parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source id.","example":"2c9180835d191a86015d28455b4a2329"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"the provisioning policy name","example":"example provisioning policy for inactive identities"},"description":{"type":"string","description":"the description of the provisioning policy","example":"this provisioning policy creates access based on an identity going inactive"},"usageType":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"userName"},"transform":{"type":"object","description":"The transform to apply to the field","example":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"default":{}},"attributes":{"type":"object","description":"Attributes required for the transform","example":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"}},"type":{"type":"string","description":"The type of the attribute.","example":"string"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","default":false,"example":false}}}}}}}}}},"responses":{"200":{"description":"A list of the ProvisioningPolicyDto was successfully replaced.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"the provisioning policy name","example":"example provisioning policy for inactive identities"},"description":{"type":"string","description":"the description of the provisioning policy","example":"this provisioning policy creates access based on an identity going inactive"},"usageType":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"userName"},"transform":{"type":"object","description":"The transform to apply to the field","example":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"default":{}},"attributes":{"type":"object","description":"Attributes required for the transform","example":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"}},"isRequired":{"type":"boolean","readOnly":true,"description":"Flag indicating whether or not the attribute is required.","default":false,"example":false},"type":{"type":"string","description":"The type of the attribute.","example":"string"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","default":false,"example":false}}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"post","path":"/sources/{sourceId}/provisioning-policies/bulk-update","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"name":"example provisioning policy for inactive identities","description":"this provisioning policy creates access based on an identity going inactive","usageType":"CREATE","fields":[{"name":"userName","transform":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"attributes":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"},"type":"string","isMultiValued":false}]}],"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Bulk Update Provisioning Policies","description":{"content":"This end-point updates a list of provisioning policies on the specified source in IdentityNow.\nA token with API, or ORG_ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":sourceId","provisioning-policies","bulk-update"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id.","type":"text/plain"},"type":"any","value":"","key":"sourceId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "post api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Bulk Update Provisioning Policies' (update-provisioning-policies-in-bulk)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Bulk Update Provisioning Policies + + + +This end-point updates a list of provisioning policies on the specified source in IdentityNow. +A token with API, or ORG_ADMIN authority is required to call this API. + +
      Path Parameters
      Request Body array required
        fields object[]
      + +A list of the ProvisioningPolicyDto was successfully replaced. + +
      Schema array
        fields object[]
      + +Client Error - Returned if the request body is invalid. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
      + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
      Schema
      + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 403 response object

      + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 404 response object

      + +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. + +
      Schema
      + +Internal Server Error - Returned if there is an unexpected error. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 500 response object

      \ No newline at end of file diff --git a/products/idn/api/v3/update-provisioning-policy.api.mdx b/products/idn/api/v3/update-provisioning-policy.api.mdx new file mode 100644 index 000000000..990f1f3a6 --- /dev/null +++ b/products/idn/api/v3/update-provisioning-policy.api.mdx @@ -0,0 +1,98 @@ +--- +id: update-provisioning-policy +sidebar_label: Partial update of Provisioning Policy +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateProvisioningPolicy","tags":["Sources"],"description":"This API selectively updates an existing Provisioning Policy using a JSONPatch payload.\nTransforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.\nRefer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","security":[{"oauth2":["idn:provisioning-policy:update"]}],"parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source id.","example":"2c9180835d191a86015d28455b4a2329"},{"in":"path","name":"usageType","required":true,"schema":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"description":"The type of ProvisioningPolicy usage."}],"requestBody":{"required":true,"description":"The JSONPatch payload used to update the schema.","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"examples":{"add-field":{"summary":"Add a field to the beginning of the list","value":[{"op":"add","path":"/fields/0","value":{"name":"email","transform":{"type":"identityAttribute","attributes":{"name":"email"}},"attributes":{},"isRequired":false,"type":"string","isMultiValued":false}}]}}}}},"responses":{"200":{"description":"The ProvisioningPolicyDto was successfully updated.","content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"the provisioning policy name","example":"example provisioning policy for inactive identities"},"description":{"type":"string","description":"the description of the provisioning policy","example":"this provisioning policy creates access based on an identity going inactive"},"usageType":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","ENABLE","DISABLE","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of ProvisioningPolicy usage."},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"userName"},"transform":{"type":"object","description":"The transform to apply to the field","example":{"type":"rule","attributes":{"name":"Create Unique LDAP Attribute"}},"default":{}},"attributes":{"type":"object","description":"Attributes required for the transform","example":{"template":"${firstname}.${lastname}${uniqueCounter}","cloudMaxUniqueChecks":"50","cloudMaxSize":"20","cloudRequired":"true"}},"isRequired":{"type":"boolean","readOnly":true,"description":"Flag indicating whether or not the attribute is required.","default":false,"example":false},"type":{"type":"string","description":"The type of the attribute.","example":"string"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","default":false,"example":false}}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/sources/{sourceId}/provisioning-policies/{usageType}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Partial update of Provisioning Policy","description":{"content":"This API selectively updates an existing Provisioning Policy using a JSONPatch payload.\nTransforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.\nRefer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.\nA token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["sources",":sourceId","provisioning-policies",":usageType"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id.","type":"text/plain"},"type":"any","value":"","key":"sourceId"},{"disabled":false,"description":{"content":"(Required) The type of ProvisioningPolicy usage.","type":"text/plain"},"type":"any","value":"","key":"usageType"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Partial update of Provisioning Policy' (update-provisioning-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Partial update of Provisioning Policy + + + +This API selectively updates an existing Provisioning Policy using a JSONPatch payload. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. +A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +
      Path Parameters
      Request Body array required
      + +The JSONPatch payload used to update the schema. + +
        value object
        + +The value to be used for the operation, required for "add" and "replace" operations + +
        anyOf
      • string
      • integer
        • anyOf
      • string
      • integer
      + +The ProvisioningPolicyDto was successfully updated. + +
      Schema
        fields object[]
      + +Client Error - Returned if the request body is invalid. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
      + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
      Schema
      + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 403 response object

      + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 404 response object

      + +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. + +
      Schema
      + +Internal Server Error - Returned if there is an unexpected error. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 500 response object

      \ No newline at end of file diff --git a/products/idn/api/v3/update-public-identity-config.api.mdx b/products/idn/api/v3/update-public-identity-config.api.mdx new file mode 100644 index 000000000..3ad99b099 --- /dev/null +++ b/products/idn/api/v3/update-public-identity-config.api.mdx @@ -0,0 +1,91 @@ +--- +id: update-public-identity-config +sidebar_label: Update the Public Identities Configuration +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updatePublicIdentityConfig","tags":["Public Identities Config"],"description":"Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. A token with ORG ADMIN authority is required to call this API.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org.","properties":{"attributes":{"type":"array","description":"Up to 5 identity attributes that will be available to everyone in the org for all users in the org.","items":{"type":"object","description":"Used to map an attribute key for an Identity to its display name.","properties":{"key":{"type":"string","description":"The attribute key","example":"country"},"name":{"type":"string","description":"The attribute display name","example":"Country"}}}},"modified":{"nullable":true,"type":"string","description":"When this configuration was last modified.","format":"date-time","example":"2018-06-25T20:22:28.104Z"},"modifiedBy":{"description":"The identity who last modified this configuration.","type":"object","nullable":true,"properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of identity.","example":"Thomas Edison"}}}}}}}},"responses":{"200":{"description":"Request succeeded.","content":{"application/json":{"schema":{"type":"object","description":"Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org.","properties":{"attributes":{"type":"array","description":"Up to 5 identity attributes that will be available to everyone in the org for all users in the org.","items":{"type":"object","description":"Used to map an attribute key for an Identity to its display name.","properties":{"key":{"type":"string","description":"The attribute key","example":"country"},"name":{"type":"string","description":"The attribute display name","example":"Country"}}}},"modified":{"nullable":true,"type":"string","description":"When this configuration was last modified.","format":"date-time","example":"2018-06-25T20:22:28.104Z"},"modifiedBy":{"description":"The identity who last modified this configuration.","type":"object","nullable":true,"properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"},"name":{"type":"string","description":"Human-readable display name of identity.","example":"Thomas Edison"}}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/public-identities-config","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"attributes":[{"key":"country","name":"Country"}],"modified":"2018-06-25T20:22:28.104Z","modifiedBy":{"type":"IDENTITY","id":"2c9180a46faadee4016fb4e018c20639","name":"Thomas Edison"}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Update the Public Identities Configuration","description":{"content":"Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. A token with ORG ADMIN authority is required to call this API.","type":"text/plain"},"url":{"path":["public-identities-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "put api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update the Public Identities Configuration' (update-public-identity-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update the Public Identities Configuration + + + +Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. A token with ORG ADMIN authority is required to call this API. + +
      Request Body required
        attributes object[]
        + +Up to 5 identity attributes that will be available to everyone in the org for all users in the org. + +
        modifiedBy object
        + +The identity who last modified this configuration. + +
      + +Request succeeded. + +
      Schema
        attributes object[]
        + +Up to 5 identity attributes that will be available to everyone in the org for all users in the org. + +
        modifiedBy object
        + +The identity who last modified this configuration. + +
      + +Client Error - Returned if the request body is invalid. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
      + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
      Schema
      + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 403 response object

      + +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. + +
      Schema
      + +Internal Server Error - Returned if there is an unexpected error. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 500 response object

      \ No newline at end of file diff --git a/products/idn/api/v3/update-scheduled-search.api.mdx b/products/idn/api/v3/update-scheduled-search.api.mdx new file mode 100644 index 000000000..0b9712c46 --- /dev/null +++ b/products/idn/api/v3/update-scheduled-search.api.mdx @@ -0,0 +1,142 @@ +--- +id: update-scheduled-search +sidebar_label: Update an existing Scheduled Search +hide_title: true +hide_table_of_contents: true +api: {"tags":["Scheduled Search"],"description":"Updates an existing scheduled search.\n","operationId":"updateScheduledSearch","parameters":[{"in":"path","name":"id","description":"ID of the requested document.","schema":{"type":"string"},"required":true,"example":"2c91808568c529c60168cca6f90c1313"}],"requestBody":{"description":"The scheduled search to persist.","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"id":{"description":"The scheduled search ID.","type":"string","example":"0de46054-fe90-434a-b84e-c6b3359d0c64","readOnly":true},"owner":{"description":"The owner of the scheduled search","readOnly":true,"type":"object","properties":{"type":{"type":"string","description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"The ID of the referenced object","example":"2c9180867624cbd7017642d8c8c81f67"}},"required":["type","id"]},"ownerId":{"description":"The ID of the scheduled search owner.\n\nPlease use the `id` in the `owner` object instead.\n","type":"string","example":"2c9180867624cbd7017642d8c8c81f67","readOnly":true,"deprecated":true}}},{"type":"object","properties":{"name":{"description":"The name of the scheduled search.\n","type":"string","example":"Daily disabled accounts","nullable":true},"description":{"description":"The description of the scheduled search.\n","type":"string","nullable":true,"example":"Daily disabled accounts"}}},{"type":"object","properties":{"savedSearchId":{"description":"The ID of the saved search that will be executed.","type":"string","example":"554f1511-f0a1-4744-ab14-599514d3e57c"},"created":{"allOf":[{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}],"description":"The date the scheduled search was initially created.","readOnly":true},"modified":{"allOf":[{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}],"description":"The last date the scheduled search was modified.","readOnly":true},"schedule":{"type":"object","description":"The schedule information.","properties":{"type":{"description":"Enum representing the currently supported schedule types.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["DAILY","WEEKLY","MONTHLY","CALENDAR"],"example":"WEEKLY"},"days":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The days to execute the search.\n\nIf `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`.\n\nIf `type` is `MONTHLY`, the values will be a number in double quotes, like `\"1\"`, `\"10\"`, or `\"28\"`. Optionally, the value `\"L\"` can be used to refer to the last day of the month.\n","example":{"type":"LIST","values":["MON","WED","FRI"]},"nullable":true}]},"hours":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The hours selected.","example":{"type":"RANGE","values":["9","18"],"interval":3}}]},"expiration":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"timeZoneId":{"description":"The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org's default timezone is used.","nullable":true,"type":"string","example":"GMT-06:00"}},"required":["type","hours"]},"recipients":{"description":"A list of identities that should receive the scheduled search report via email.","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"The ID of the referenced object","example":"2c9180867624cbd7017642d8c8c81f67"}},"required":["type","id"]}},"enabled":{"description":"Indicates if the scheduled search is enabled.\n","type":"boolean","default":false,"example":false},"emailEmptyResults":{"description":"Indicates if email generation should not be suppressed if search returns no results.\n","type":"boolean","default":false,"example":false},"displayQueryDetails":{"description":"Indicates if the generated email should include the query and search results preview (which could include PII).\n","type":"boolean","default":false,"example":false}},"required":["savedSearchId","schedule","recipients"]}],"required":["id","owner","ownerId"]}}},"required":true},"responses":{"200":{"description":"The persisted scheduled search.","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"id":{"description":"The scheduled search ID.","type":"string","example":"0de46054-fe90-434a-b84e-c6b3359d0c64","readOnly":true},"owner":{"description":"The owner of the scheduled search","readOnly":true,"type":"object","properties":{"type":{"type":"string","description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"The ID of the referenced object","example":"2c9180867624cbd7017642d8c8c81f67"}},"required":["type","id"]},"ownerId":{"description":"The ID of the scheduled search owner.\n\nPlease use the `id` in the `owner` object instead.\n","type":"string","example":"2c9180867624cbd7017642d8c8c81f67","readOnly":true,"deprecated":true}}},{"type":"object","properties":{"name":{"description":"The name of the scheduled search.\n","type":"string","example":"Daily disabled accounts","nullable":true},"description":{"description":"The description of the scheduled search.\n","type":"string","nullable":true,"example":"Daily disabled accounts"}}},{"type":"object","properties":{"savedSearchId":{"description":"The ID of the saved search that will be executed.","type":"string","example":"554f1511-f0a1-4744-ab14-599514d3e57c"},"created":{"allOf":[{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}],"description":"The date the scheduled search was initially created.","readOnly":true},"modified":{"allOf":[{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"}],"description":"The last date the scheduled search was modified.","readOnly":true},"schedule":{"type":"object","description":"The schedule information.","properties":{"type":{"description":"Enum representing the currently supported schedule types.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["DAILY","WEEKLY","MONTHLY","CALENDAR"],"example":"WEEKLY"},"days":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The days to execute the search.\n\nIf `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`.\n\nIf `type` is `MONTHLY`, the values will be a number in double quotes, like `\"1\"`, `\"10\"`, or `\"28\"`. Optionally, the value `\"L\"` can be used to refer to the last day of the month.\n","example":{"type":"LIST","values":["MON","WED","FRI"]},"nullable":true}]},"hours":{"allOf":[{"type":"object","properties":{"type":{"description":"Enum representing the currently supported selector types.\n\nLIST - the *values* array contains one or more distinct values.\n\nRANGE - the *values* array contains two values: the start and end of the range, inclusive.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["LIST","RANGE"],"example":"LIST"},"values":{"description":"The selected values.\n","type":"array","items":{"type":"string"},"example":["MON","WED"]},"interval":{"nullable":true,"description":"The selected interval for RANGE selectors.\n","type":"integer","format":"int32","example":3}},"required":["type","values"]},{"description":"The hours selected.","example":{"type":"RANGE","values":["9","18"],"interval":3}}]},"expiration":{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format"},"timeZoneId":{"description":"The GMT formatted timezone the schedule will run in (ex. GMT-06:00). If no timezone is specified, the org's default timezone is used.","nullable":true,"type":"string","example":"GMT-06:00"}},"required":["type","hours"]},"recipients":{"description":"A list of identities that should receive the scheduled search report via email.","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of object being referenced","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"The ID of the referenced object","example":"2c9180867624cbd7017642d8c8c81f67"}},"required":["type","id"]}},"enabled":{"description":"Indicates if the scheduled search is enabled.\n","type":"boolean","default":false,"example":false},"emailEmptyResults":{"description":"Indicates if email generation should not be suppressed if search returns no results.\n","type":"boolean","default":false,"example":false},"displayQueryDetails":{"description":"Indicates if the generated email should include the query and search results preview (which could include PII).\n","type":"boolean","default":false,"example":false}},"required":["savedSearchId","schedule","recipients"]}],"required":["id","owner","ownerId"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"put","path":"/scheduled-searches/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"Daily disabled accounts","description":"Daily disabled accounts","savedSearchId":"554f1511-f0a1-4744-ab14-599514d3e57c","schedule":{"type":"WEEKLY","days":{"type":"LIST","values":["MON","WED","FRI"]},"hours":{"type":"RANGE","values":["9","18"],"interval":3},"expiration":"2018-06-25T20:22:28.104Z","timeZoneId":"GMT-06:00"},"recipients":[{"type":"IDENTITY","id":"2c9180867624cbd7017642d8c8c81f67"}],"enabled":false,"emailEmptyResults":false,"displayQueryDetails":false},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Update an existing Scheduled Search","description":{"content":"Updates an existing scheduled search.\n","type":"text/plain"},"url":{"path":["scheduled-searches",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the requested document.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "put api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update an existing Scheduled Search' (update-scheduled-search)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update an existing Scheduled Search + + + +Updates an existing scheduled search. + + +
      Path Parameters
      Request Body required
      + +The scheduled search to persist. + +
        owner object
        + +The owner of the scheduled search + +
        schedule object required
        + +The schedule information. + +
        days object
        + +The days to execute the search. + +If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. + +If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. + + +
        hours object required
        + +The hours selected. + +
        recipients object[] required
        + +A list of identities that should receive the scheduled search report via email. + +
      + +The persisted scheduled search. + +
      Schema
        owner object
        + +The owner of the scheduled search + +
        schedule object
        + +The schedule information. + +
        days object
        + +The days to execute the search. + +If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`. + +If `type` is `MONTHLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month. + + +
        hours object
        + +The hours selected. + +
        recipients object[]
        + +A list of identities that should receive the scheduled search report via email. + +
      + +Client Error - Returned if the request body is invalid. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
      + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
      Schema
      + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 403 response object

      + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 404 response object

      + +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. + +
      Schema
      + +Internal Server Error - Returned if there is an unexpected error. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 500 response object

      \ No newline at end of file diff --git a/products/idn/api/v3/update-source-schema.api.mdx b/products/idn/api/v3/update-source-schema.api.mdx new file mode 100644 index 000000000..0cc6e7429 --- /dev/null +++ b/products/idn/api/v3/update-source-schema.api.mdx @@ -0,0 +1,132 @@ +--- +id: update-source-schema +sidebar_label: Update Source Schema (Partial) +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateSourceSchema","tags":["Sources"],"description":"Use this API to selectively update an existing Schema using a JSONPatch payload. \n\nThe following schema fields are immutable and cannot be updated:\n\n- id\n- name\n- created\n- modified\n\n\nTo switch an account attribute to a group entitlement, you need to have the following in place:\n\n- `isEntitlement: true`\n- Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group:\n```json\n{\n \"name\": \"groups\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"2c9180887671ff8c01767b4671fc7d60\",\n \"name\": \"group\"\n },\n \"description\": \"The groups, roles etc. that reference account group objects\",\n \"isMulti\": true,\n \"isEntitlement\": true,\n \"isGroup\": true\n}\n```\n","parameters":[{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source id.","example":"2c9180835d191a86015d28455b4a2329"},{"in":"path","name":"schemaId","schema":{"type":"string"},"required":true,"description":"The Schema id.","example":"2c9180835d191a86015d28455b4a2329"}],"requestBody":{"required":true,"description":"The JSONPatch payload used to update the schema.","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"examples":{"add-attribute":{"summary":"Add an attribute to the end of the list","value":[{"op":"add","path":"/attributes/-","value":{"name":"location","type":"STRING","schema":null,"description":"Employee location","isMulti":false,"isEntitlement":false,"isGroup":false}}]}}}}},"responses":{"200":{"description":"The Schema was successfully updated.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Schema.","example":"2c9180835d191a86015d28455b4a2329"},"name":{"type":"string","description":"The name of the Schema.","example":"account"},"nativeObjectType":{"type":"string","description":"The name of the object type on the native system that the schema represents.","example":"User"},"identityAttribute":{"type":"string","description":"The name of the attribute used to calculate the unique identifier for an object in the schema.","example":"sAMAccountName"},"displayAttribute":{"type":"string","description":"The name of the attribute used to calculate the display value for an object in the schema.","example":"distinguishedName"},"hierarchyAttribute":{"type":"string","description":"The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.","example":"memberOf"},"includePermissions":{"type":"boolean","description":"Flag indicating whether or not the include permissions with the object data when aggregating the schema.","example":false},"features":{"type":"array","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.","example":"AUTHENTICATE"},"description":"The features that the schema supports.","example":["PROVISIONING","NO_PERMISSIONS_PROVISIONING","GROUPS_HAVE_MEMBERS"]},"configuration":{"type":"object","description":"Holds any extra configuration data that the schema may require.","example":{"groupMemberAttribute":"member"}},"attributes":{"type":"array","description":"The attribute definitions which form the schema.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"sAMAccountName"},"type":{"description":"The type of the attribute.","example":"STRING","type":"string","enum":["STRING","LONG","INT","BOOLEAN"]},"schema":{"description":"A reference to the schema on the source to the attribute values map to.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"The object ID this reference applies to.","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"The human-readable display name of the object.","example":"group"}}},"description":{"type":"string","description":"A human-readable description of the attribute.","example":"SAM Account Name"},"isMultiValued":{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","example":false},"isEntitlement":{"type":"boolean","description":"Flag indicating whether or not the attribute is an entitlement.","example":false},"isGroup":{"type":"boolean","description":"Flag indicating whether or not the attribute represents a group.\nThis can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute..\n","example":false}}},"example":[{"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":{"type":"string","description":"The date the Schema was created.","format":"date-time","example":"2019-12-24T22:32:58.104Z"},"modified":{"type":"string","description":"The date the Schema was last modified.","format":"date-time","example":"2019-12-31T20:22:28.104Z"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/sources/{sourceId}/schemas/{schemaId}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Update Source Schema (Partial)","description":{"content":"Use this API to selectively update an existing Schema using a JSONPatch payload. \n\nThe following schema fields are immutable and cannot be updated:\n\n- id\n- name\n- created\n- modified\n\n\nTo switch an account attribute to a group entitlement, you need to have the following in place:\n\n- `isEntitlement: true`\n- Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group:\n```json\n{\n \"name\": \"groups\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"2c9180887671ff8c01767b4671fc7d60\",\n \"name\": \"group\"\n },\n \"description\": \"The groups, roles etc. that reference account group objects\",\n \"isMulti\": true,\n \"isEntitlement\": true,\n \"isGroup\": true\n}\n```\n","type":"text/plain"},"url":{"path":["sources",":sourceId","schemas",":schemaId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id.","type":"text/plain"},"type":"any","value":"","key":"sourceId"},{"disabled":false,"description":{"content":"(Required) The Schema id.","type":"text/plain"},"type":"any","value":"","key":"schemaId"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Source Schema (Partial)' (update-source-schema)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Source Schema (Partial) + + + +Use this API to selectively update an existing Schema using a JSONPatch payload. + +The following schema fields are immutable and cannot be updated: + +- id +- name +- created +- modified + + +To switch an account attribute to a group entitlement, you need to have the following in place: + +- `isEntitlement: true` +- Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: +```json +{ + "name": "groups", + "type": "STRING", + "schema": { + "type": "CONNECTOR_SCHEMA", + "id": "2c9180887671ff8c01767b4671fc7d60", + "name": "group" + }, + "description": "The groups, roles etc. that reference account group objects", + "isMulti": true, + "isEntitlement": true, + "isGroup": true +} +``` + + +
      Path Parameters
      Request Body array required
      + +The JSONPatch payload used to update the schema. + +
        value object
        + +The value to be used for the operation, required for "add" and "replace" operations + +
        anyOf
      • string
      • integer
        • anyOf
      • string
      • integer
      + +The Schema was successfully updated. + +
      Schema
        attributes object[]
        + +The attribute definitions which form the schema. + +
        schema object
        + +A reference to the schema on the source to the attribute values map to. + +
      + +Client Error - Returned if the request body is invalid. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
      + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
      Schema
      + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 403 response object

      + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 404 response object

      + +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. + +
      Schema
      + +Internal Server Error - Returned if there is an unexpected error. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 500 response object

      \ No newline at end of file diff --git a/products/idn/api/v3/update-source.api.mdx b/products/idn/api/v3/update-source.api.mdx new file mode 100644 index 000000000..75a3c386f --- /dev/null +++ b/products/idn/api/v3/update-source.api.mdx @@ -0,0 +1,152 @@ +--- +id: update-source +sidebar_label: Update Source (Partial) +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateSource","security":[{"oauth2":["idn:sources:manage"]}],"tags":["Sources"],"description":"This API partially updates a source in IdentityNow, using a list of patch operations according to the\n[JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nSome fields are immutable and cannot be changed, such as:\n\n* id\n* type\n* authoritative\n* created\n* modified\n* connector\n* connectorClass\n* passwordPolicies\n\nAttempts to modify these fields will result in a 400 error.\n\nA token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or API authority is required to call this API.\n","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The Source id","example":"2c9180835d191a86015d28455b4a2329"}],"requestBody":{"required":true,"description":"A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in IdentityNow.","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","description":"A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)","required":["op","path"],"properties":{"op":{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"object"}]}}],"description":"The value to be used for the operation, required for \"add\" and \"replace\" operations","example":"New description"}}}},"examples":{"Edit the source description":{"description":"This example shows how to edit a source description.","value":[{"op":"replace","path":"/description","value":"new description"}]},"Edit the source cluster":{"description":"This example shows how to edit a source cluster by id.","value":[{"op":"replace","path":"/cluster/id","value":"2c918087813a902001813f3f85736b45"}]},"Edit source features":{"description":"This example illustrates how you can update source supported features","value":[{"op":"replace","path":"/features","value":["PASSWORD","PROVISIONING","ENABLE","AUTHENTICATE"]}]},"Change a source description and cluster in One Call":{"description":"This example shows how multiple fields may be updated with a single patch call.","value":[{"op":"replace","path":"/description","value":"new description"},{"op":"replace","path":"/cluster/id","value":"2c918087813a902001813f3f85736b45"}]},"Add a filter string to the connector":{"description":"This example shows how you can add a filter to incoming accounts during the account aggregation process. In the example below, any account that does not have an \"m\" or \"d\" in the id will be aggregated.","value":[{"op":"add","path":"/connectorAttributes/filterString","value":"!( id.contains( \"m\" ) ) || !( id.contains( \"d\" ) )"}]},"Update connector attribute for specific operation type":{"description":"This example shows how you can update the 3rd object in the connection parameters operationType. This will change it from a standard group aggregation to a group aggregation on the \"test\" entitlement type","value":[{"op":"replace","path":"/connectorAttributes/connectionParameters/2/operationType","value":"Group Aggregation-test"}]}}}}},"responses":{"200":{"description":"Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"the id of the Source","example":"2c91808568c529c60168cca6f90c1324"},"name":{"type":"string","description":"Human-readable name of the source","example":"My Source"},"description":{"type":"string","description":"Human-readable description of the source","example":"This is the corporate directory."},"owner":{"description":"Reference to an owning Identity Object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["IDENTITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity","example":"MyName"}}},"cluster":{"description":"Reference to the associated Cluster","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CLUSTER"],"example":"CLUSTER"},"id":{"type":"string","description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"},"name":{"type":"string","description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}},"accountCorrelationConfig":{"description":"Reference to an Account Correlation Config object","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG"],"example":"ACCOUNT_CORRELATION_CONFIG"},"id":{"type":"string","description":"ID of the account correlation config","example":"2c9180855d191c59015d28583727245a"},"name":{"type":"string","description":"Human-readable display name of the account correlation config","example":"Directory [source-62867] Account Correlation"}}},"accountCorrelationRule":{"description":"Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"managerCorrelationMapping":{"description":"Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity","type":"object","properties":{"accountAttribute":{"type":"string","description":"Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.","example":"manager"},"identityAttribute":{"type":"string","description":"Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.","example":"manager"}}},"managerCorrelationRule":{"description":"Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"beforeProvisioningRule":{"description":"Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"},"id":{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"},"name":{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}},"schemas":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"},"id":{"type":"string","description":"ID of the schema","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the schema","example":"MySchema"}}},"description":"List of references to Schema objects","example":[{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232a","name":"account"},{"type":"CONNECTOR_SCHEMA","id":"2c9180835d191a86015d28455b4b232b","name":"group"}]},"passwordPolicies":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["PASSWORD_POLICY"],"example":"PASSWORD_POLICY"},"id":{"type":"string","description":"ID of the policy","example":"2c91808568c529c60168cca6f90c1777"},"name":{"type":"string","description":"Human-readable display name of the policy","example":"My Password Policy"}}},"description":"List of references to the associated PasswordPolicy objects.","example":[{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb053980","name":"Corporate Password Policy"},{"type":"PASSWORD_POLICY","id":"2c9180855d191c59015d291ceb057777","name":"Vendor Password Policy"}]},"features":{"type":"array","description":"Optional features that can be supported by a source.","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.","example":"AUTHENTICATE"},"example":["SYNC_PROVISIONING","MANAGER_LOOKUP","SEARCH","PROVISIONING","AUTHENTICATE","GROUP_PROVISIONING","PASSWORD"]},"type":{"type":"string","description":"Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ","example":"OpenLDAP - Direct"},"connector":{"type":"string","description":"Connector script name.","example":"active-directory"},"connectorClass":{"type":"string","description":"The fully qualified name of the Java class that implements the connector interface.","example":"sailpoint.connector.LDAPConnector"},"connectorAttributes":{"type":"object","description":"Connector specific configuration; will differ from type to type.","example":{"healthCheckTimeout":30,"authSearchAttributes":["cn","uid","mail"]}},"deleteThreshold":{"type":"integer","format":"int32","description":"Number from 0 to 100 that specifies when to skip the delete phase.","example":10},"authoritative":{"type":"boolean","description":"When true indicates the source is referenced by an IdentityProfile.","example":false},"managementWorkgroup":{"description":"Reference to Management Workgroup for this Source","type":"object","properties":{"type":{"description":"The type of object being referenced","type":"string","enum":["GOVERNANCE_GROUP"],"example":"GOVERNANCE_GROUP"},"id":{"type":"string","description":"ID of the management workgroup","example":"2c91808568c529c60168cca6f90c2222"},"name":{"type":"string","description":"Human-readable display name of the management workgroup","example":"My Management Workgroup"}}},"healthy":{"type":"boolean","description":"When true indicates a healthy source","example":true},"status":{"type":"string","description":"A status identifier, giving specific information on why a source is healthy or not","example":"SOURCE_STATE_HEALTHY"},"since":{"type":"string","description":"Timestamp showing when a source health check was last performed","example":"2021-09-28T15:48:29.3801666300Z"},"connectorId":{"type":"string","description":"The id of connector","example":"active-directory"},"connectorName":{"type":"string","description":"The name of the connector that was chosen on source creation","example":"Active Directory"},"connectionType":{"type":"string","description":"The type of connection (direct or file)","example":"file"},"connectorImplementstionId":{"type":"string","description":"The connector implementstion id","example":"delimited-file"}},"required":["name","owner","connector"]}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"patch","path":"/sources/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":[{"op":"replace","path":"/description","value":"string"}],"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Update Source (Partial)","description":{"content":"This API partially updates a source in IdentityNow, using a list of patch operations according to the\n[JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\n\nSome fields are immutable and cannot be changed, such as:\n\n* id\n* type\n* authoritative\n* created\n* modified\n* connector\n* connectorClass\n* passwordPolicies\n\nAttempts to modify these fields will result in a 400 error.\n\nA token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or API authority is required to call this API.\n","type":"text/plain"},"url":{"path":["sources",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Source id","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json-patch+json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "patch api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Source (Partial)' (update-source)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update Source (Partial) + + + +This API partially updates a source in IdentityNow, using a list of patch operations according to the +[JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +Some fields are immutable and cannot be changed, such as: + +* id +* type +* authoritative +* created +* modified +* connector +* connectorClass +* passwordPolicies + +Attempts to modify these fields will result in a 400 error. + +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or API authority is required to call this API. + + +
      Path Parameters
      Request Body array required
      + +A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in IdentityNow. + +
        value object
        + +The value to be used for the operation, required for "add" and "replace" operations + +
        anyOf
      • string
      • integer
        • anyOf
      • string
      • integer
      + +Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design. + +
      Schema
        owner object
        + +Reference to an owning Identity Object + +
        cluster object
        + +Reference to the associated Cluster + +
        accountCorrelationConfig object
        + +Reference to an Account Correlation Config object + +
        accountCorrelationRule object
        + +Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used. + +
        managerCorrelationMapping object
        + +Filter Object used during manager correlation to match incoming manager values to an existing manager's Account/Identity + +
        managerCorrelationRule object
        + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
        beforeProvisioningRule object
        + +Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + +
        schemas object[]
        + +List of references to Schema objects + +
        passwordPolicies object[]
        + +List of references to the associated PasswordPolicy objects. + +
        managementWorkgroup object
        + +Reference to Management Workgroup for this Source + +
      + +Client Error - Returned if the request body is invalid. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
      + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
      Schema
      + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 403 response object

      + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 404 response object

      + +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. + +
      Schema
      + +Internal Server Error - Returned if there is an unexpected error. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 500 response object

      \ No newline at end of file diff --git a/products/idn/api/v3/update-status-check-details.api.mdx b/products/idn/api/v3/update-status-check-details.api.mdx new file mode 100644 index 000000000..56e5587b5 --- /dev/null +++ b/products/idn/api/v3/update-status-check-details.api.mdx @@ -0,0 +1,91 @@ +--- +id: update-status-check-details +sidebar_label: Update the time check configuration +hide_title: true +hide_table_of_contents: true +api: {"tags":["Service Desk Integration"],"description":"Update the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","operationId":"updateStatusCheckDetails","requestBody":{"description":"the modified time check configuration","content":{"application/json":{"schema":{"description":"Configuration of maximum number days and interval for checking Service Desk integration queue status","required":["provisioningStatusCheckIntervalMinutes","provisioningMaxStatusCheckDays"],"type":"object","properties":{"provisioningStatusCheckIntervalMinutes":{"description":"interval in minutes between status checks","type":"string","example":"30"},"provisioningMaxStatusCheckDays":{"description":"maximum number of days to check","type":"string","example":"2"}}}}},"required":true},"responses":{"200":{"description":"QueuedCheckConfigDetails as updated","content":{"application/json":{"schema":{"description":"Configuration of maximum number days and interval for checking Service Desk integration queue status","required":["provisioningStatusCheckIntervalMinutes","provisioningMaxStatusCheckDays"],"type":"object","properties":{"provisioningStatusCheckIntervalMinutes":{"description":"interval in minutes between status checks","type":"string","example":"30"},"provisioningMaxStatusCheckDays":{"description":"maximum number of days to check","type":"string","example":"2"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:service-desk-admin:manage","idn:service-desk-integration:manage"]}],"method":"put","path":"/service-desk-integrations/status-check-configuration","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"provisioningStatusCheckIntervalMinutes":"30","provisioningMaxStatusCheckDays":"2"},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Update the time check configuration","description":{"content":"Update the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.","type":"text/plain"},"url":{"path":["service-desk-integrations","status-check-configuration"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update the time check configuration' (update-status-check-details)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update the time check configuration + + + +Update the time check configuration of queued SDIM tickets. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +
      Request Body required
      + +the modified time check configuration + +
      + +QueuedCheckConfigDetails as updated + +
      Schema
      + +Client Error - Returned if the request body is invalid. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
      + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
      Schema
      + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 403 response object

      + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 404 response object

      + +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. + +
      Schema
      + +Internal Server Error - Returned if there is an unexpected error. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 500 response object

      \ No newline at end of file diff --git a/products/idn/api/v3/update-transform.api.mdx b/products/idn/api/v3/update-transform.api.mdx new file mode 100644 index 000000000..b16036678 --- /dev/null +++ b/products/idn/api/v3/update-transform.api.mdx @@ -0,0 +1,904 @@ +--- +id: update-transform +sidebar_label: Update a transform +hide_title: true +hide_table_of_contents: true +api: {"tags":["Transforms"],"description":"Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error.\nA token with transform write authority is required to call this API.","operationId":"updateTransform","parameters":[{"name":"id","in":"path","description":"ID of the transform to update","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"2cd78adghjkja34jh2b1hkjhasuecd"}],"requestBody":{"description":"The updated transform object (must include \"name\", \"type\", and \"attributes\" fields).","content":{"application/json":{"schema":{"type":"object","description":"The representation of an internally- or customer-defined transform.","required":["name","type","attributes"],"properties":{"id":{"type":"string","readOnly":true,"description":"Unique ID of this transform","example":"2cd78adghjkja34jh2b1hkjhasuecd"},"name":{"type":"string","description":"Unique name of this transform","example":"Timestamp To Date","minLength":1,"maxLength":50},"type":{"type":"string","description":"The type of transform operation","enum":["accountAttribute","base64Decode","base64Encode","concat","conditional","dateCompare","dateFormat","dateMath","decomposeDiacriticalMarks","e164phone","firstValid","rule","identityAttribute","indexOf","iso3166","lastIndexOf","leftPad","lookup","lower","normalizeNames","randomAlphaNumeric","randomNumeric","reference","replaceAll","replace","rightPad","split","static","substring","trim","upper","usernameGenerator","uuid"],"example":"dateFormat","externalDocs":{"description":"Transform Operations","url":"https://developer.sailpoint.com/idn/docs/transforms/operations"}},"attributes":{"description":"Meta-data about the transform. Values in this list are specific to the type of transform to be executed.","oneOf":[{"title":"accountAttribute","type":"object","required":["sourceName","attributeName"],"properties":{"sourceName":{"type":"string","description":"A reference to the source to search for the account","example":"Workday"},"attributeName":{"type":"string","description":"The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.","example":"DEPARTMENT"},"accountSortAttribute":{"type":"string","description":"The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries","example":"created"},"accountSortDescending":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)","example":false},"accountReturnFirstLink":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false","example":false},"accountFilter":{"type":"string","description":"This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria.\nOnly certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements","example":"!(nativeIdentity.startsWith(\"*DELETED*\"))"},"accountPropertyFilter":{"type":"string","description":"This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.\n\nAll account attributes are available for filtering as this operation is performed in memory.","example":"(groups.containsAll({'Admin'}) || location == 'Austin')"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"base64Decode","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"base64Encode","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"concat","type":"object","required":["values"],"properties":{"values":{"type":"array","items":{"type":"object"},"description":"An array of items to join together","example":["John"," ","Smith"]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"conditional","type":"object","required":["expression","positiveCondition","negativeCondition"],"properties":{"expression":{"type":"string","description":"A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. \n\nThe `eq` operator is the only valid comparison","example":"ValueA eq ValueB"},"positiveCondition":{"type":"string","description":"The output of the transform if the expression evalutes to true","example":"true"},"negativeCondition":{"type":"string","description":"The output of the transform if the expression evalutes to false","example":"false"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateCompare","type":"object","required":["firstDate","secondDate","operator","positiveCondition","negativeCondition"],"properties":{"firstDate":{"description":"This is the first date to consider (The date that would be on the left hand side of the comparison operation).","oneOf":[{"title":"accountAttribute","type":"object","required":["sourceName","attributeName"],"properties":{"sourceName":{"type":"string","description":"A reference to the source to search for the account","example":"Workday"},"attributeName":{"type":"string","description":"The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.","example":"DEPARTMENT"},"accountSortAttribute":{"type":"string","description":"The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries","example":"created"},"accountSortDescending":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)","example":false},"accountReturnFirstLink":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false","example":false},"accountFilter":{"type":"string","description":"This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria.\nOnly certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements","example":"!(nativeIdentity.startsWith(\"*DELETED*\"))"},"accountPropertyFilter":{"type":"string","description":"This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.\n\nAll account attributes are available for filtering as this operation is performed in memory.","example":"(groups.containsAll({'Admin'}) || location == 'Austin')"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateFormat","type":"object","properties":{"inputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"outputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}}]},"secondDate":{"description":"This is the second date to consider (The date that would be on the right hand side of the comparison operation).","oneOf":[{"title":"accountAttribute","type":"object","required":["sourceName","attributeName"],"properties":{"sourceName":{"type":"string","description":"A reference to the source to search for the account","example":"Workday"},"attributeName":{"type":"string","description":"The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.","example":"DEPARTMENT"},"accountSortAttribute":{"type":"string","description":"The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries","example":"created"},"accountSortDescending":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)","example":false},"accountReturnFirstLink":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false","example":false},"accountFilter":{"type":"string","description":"This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria.\nOnly certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements","example":"!(nativeIdentity.startsWith(\"*DELETED*\"))"},"accountPropertyFilter":{"type":"string","description":"This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.\n\nAll account attributes are available for filtering as this operation is performed in memory.","example":"(groups.containsAll({'Admin'}) || location == 'Austin')"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateFormat","type":"object","properties":{"inputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"outputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}}]},"operator":{"type":"string","description":"This is the comparison to perform.\n| Operation | Description |\n| --------- | ------- |\n| LT | Strictly less than: firstDate < secondDate |\n| LTE | Less than or equal to: firstDate <= secondDate |\n| GT | Strictly greater than: firstDate > secondDate |\n| GTE | Greater than or equal to: firstDate >= secondDate |\n","enum":["LT","LTE","GT","GTE"],"example":"LT"},"positiveCondition":{"type":"string","description":"The output of the transform if the expression evalutes to true","example":"true"},"negativeCondition":{"type":"string","description":"The output of the transform if the expression evalutes to false","example":false},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateFormat","type":"object","properties":{"inputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"outputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateMath","type":"object","required":["expression"],"properties":{"expression":{"type":"string","description":"A string value of the date and time components to operation on, along with the math operations to execute.\n","externalDocs":{"description":"Date Math Expressions","url":"https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure"},"example":"now+1w"},"roundUp":{"type":"boolean","description":"A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. \n\n\nIf not provided, the transform will default to `false`\n\n\n`true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component)\n\n\n`false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated)\n","example":false},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"decomposeDiacriticalMarks","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"e164phone","type":"object","properties":{"defaultRegion":{"type":"string","description":"This is an optional attribute that can be used to define the region of the phone number to format into.\n\n\nIf defaultRegion is not provided, it will take US as the default country.\n\n\nThe format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\n","example":"US"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"firstValid","type":"object","required":["values"],"properties":{"values":{"type":"array","items":{"type":"object"},"description":"An array of attributes to evaluate for existence.","example":[{"attributes":{"sourceName":"Active Directory","attributeName":"sAMAccountName"},"type":"accountAttribute"},{"attributes":{"sourceName":"Okta","attributeName":"login"},"type":"accountAttribute"},{"attributes":{"sourceName":"HR Source","attributeName":"employeeID"},"type":"accountAttribute"}]},"ignoreErrors":{"type":"boolean","description":"a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur.","example":false},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false}}},{"title":"rule","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"This is the name of the Generic rule that needs to be invoked by the transform","example":"Generic Calculation Rule"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false}}},{"type":"object","required":["name","operation","includeNumbers","includeSpecialChars","length"],"properties":{"name":{"type":"string","description":"This must always be set to \"Cloud Services Deployment Utility\"","example":"Cloud Services Deployment Utility"},"operation":{"type":"string","description":"The operation to perform `generateRandomString`","example":"generateRandomString"},"includeNumbers":{"type":"boolean","description":"This must be either \"true\" or \"false\" to indicate whether the generator logic should include numbers","example":true},"includeSpecialChars":{"type":"boolean","description":"This must be either \"true\" or \"false\" to indicate whether the generator logic should include special characters","example":true},"length":{"type":"string","description":"This specifies how long the randomly generated string needs to be\n\n\n>NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters\n","example":"10"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false}}},{"type":"object","required":["name","operation","uid"],"properties":{"name":{"type":"string","description":"This must always be set to \"Cloud Services Deployment Utility\"","example":"Cloud Services Deployment Utility"},"operation":{"type":"string","description":"The operation to perform `getReferenceIdentityAttribute`","example":"getReferenceIdentityAttribute"},"uid":{"type":"string","description":"This is the SailPoint User Name (uid) value of the identity whose attribute is desired\n\nAs a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute.\n","example":"2c91808570313110017040b06f344ec9"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false}}}]},{"title":"identityAttribute","type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The system (camel-cased) name of the identity attribute to bring in","example":"email"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"indexOf","type":"object","required":["substring"],"properties":{"substring":{"type":"string","description":"A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.","example":"admin_"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"iso3166","type":"object","properties":{"format":{"type":"string","description":"An optional value to denote which ISO 3166 format to return. Valid values are:\n\n\n`alpha2` - Two-character country code (e.g., \"US\"); this is the default value if no format is supplied\n\n\n`alpha3` - Three-character country code (e.g., \"USA\")\n\n\n`numeric` - The numeric country code (e.g., \"840\")\n","example":"alpha2"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"leftPad","type":"object","required":["length"],"properties":{"length":{"type":"string","description":"An integer value for the desired length of the final output string","example":"4"},"padding":{"type":"string","description":"A string value representing the character that the incoming data should be padded with to get to the desired length\n\n\nIf not provided, the transform will default to a single space (\" \") character for padding\n","example":"0"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"lookup","type":"object","required":["table"],"properties":{"table":{"type":"object","additionalProperties":true,"description":"This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched\n\n\n>**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return \"Unknown Region\" for the attribute that is mapped to this transform.\n","example":{"USA":"Americas","FRA":"EMEA","AUS":"APAC","default":"Unknown Region"}},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"lower","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"nameNormalizer","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"randomAlphaNumeric","type":"object","properties":{"length":{"type":"string","description":"This is an integer value specifying the size/number of characters the random string must contain\n\n\n* This value must be a positive number and cannot be blank\n\n\n* If no length is provided, the transform will default to a value of `32`\n\n\n* Due to identity attribute data constraints, the maximum allowable value is `450` characters\n","example":"10"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"randomNumeric","type":"object","properties":{"length":{"type":"string","description":"This is an integer value specifying the size/number of characters the random string must contain\n\n\n* This value must be a positive number and cannot be blank\n\n\n* If no length is provided, the transform will default to a value of `32`\n\n\n* Due to identity attribute data constraints, the maximum allowable value is `450` characters\n","example":"10"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"reference","type":"object","required":["id"],"properties":{"id":{"type":"string","description":"This ID specifies the name of the pre-existing transform which you want to use within your current transform","example":"Existing Transform"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"replaceAll","type":"object","required":["table"],"properties":{"table":{"type":"object","additionalProperties":true,"description":"An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.","example":{"-":" ","\"":"'","ñ":"n"}},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"replace","type":"object","required":["regex","replacement"],"properties":{"regex":{"type":"string","description":"This can be a string or a regex pattern in which you want to replace.","example":"[^a-zA-Z]","externalDocs":{"description":"Regex Builder","url":"https://regex101.com/"}},"replacement":{"type":"string","description":"This is the replacement string that should be substituded wherever the string or pattern is found.","example":" "},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"rightPad","type":"object","required":["length"],"properties":{"length":{"type":"string","description":"An integer value for the desired length of the final output string","example":"4"},"padding":{"type":"string","description":"A string value representing the character that the incoming data should be padded with to get to the desired length\n\n\nIf not provided, the transform will default to a single space (\" \") character for padding\n","example":"0"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"split","type":"object","required":["delimiter","index"],"properties":{"delimiter":{"type":"string","description":"This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data","example":","},"index":{"type":"string","description":"An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.","example":"5"},"throws":{"type":"boolean","description":"A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array)\n\n\n`true` - The transform should return \"IndexOutOfBoundsException\"\n\n\n`false` - The transform should return null\n\n\nIf not provided, the transform will default to false and return a null\n","example":true},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"static","type":"object","required":["values"],"properties":{"values":{"type":"string","description":"This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.","example":"string$variable","externalDocs":{"description":"Static Transform Documentation","url":"https://developer.sailpoint.com/idn/docs/transforms/operations/static"}},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false}}},{"title":"substring","type":"object","required":["begin"],"properties":{"begin":{"type":"integer","description":"The index of the first character to include in the returned substring.\n\n\nIf `begin` is set to -1, the transform will begin at character 0 of the input data\n","example":1,"format":"int32"},"beginOffset":{"type":"integer","description":"This integer value is the number of characters to add to the begin attribute when returning a substring. \n\nThis attribute is only used if begin is not -1.\n","example":3,"format":"int32"},"end":{"type":"integer","description":"The index of the first character to exclude from the returned substring.\n\nIf end is -1 or not provided at all, the substring transform will return everything up to the end of the input string.\n","example":6,"format":"int32"},"endOffset":{"type":"integer","description":"This integer value is the number of characters to add to the end attribute when returning a substring. \n\nThis attribute is only used if end is provided and is not -1.\n","example":1,"format":"int32"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"trim","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"upper","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"uuid","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false}}}]},"internal":{"type":"boolean","readOnly":true,"description":"Indicates whether this is an internal SailPoint-created transform or a customer-created transform","example":false}}},"example":{"name":"Timestamp To Date","type":"dateFormat","attributes":{"inputFormat":"MMM-dd-yyyy, HH:mm:ss.SSS","outputFormat":"yyyy/dd/MM"}}}}},"responses":{"200":{"description":"Indicates the transform was successfully updated and returns its new representation.","content":{"application/json":{"schema":{"type":"object","description":"The representation of an internally- or customer-defined transform.","required":["name","type","attributes"],"properties":{"id":{"type":"string","readOnly":true,"description":"Unique ID of this transform","example":"2cd78adghjkja34jh2b1hkjhasuecd"},"name":{"type":"string","description":"Unique name of this transform","example":"Timestamp To Date","minLength":1,"maxLength":50},"type":{"type":"string","description":"The type of transform operation","enum":["accountAttribute","base64Decode","base64Encode","concat","conditional","dateCompare","dateFormat","dateMath","decomposeDiacriticalMarks","e164phone","firstValid","rule","identityAttribute","indexOf","iso3166","lastIndexOf","leftPad","lookup","lower","normalizeNames","randomAlphaNumeric","randomNumeric","reference","replaceAll","replace","rightPad","split","static","substring","trim","upper","usernameGenerator","uuid"],"example":"dateFormat","externalDocs":{"description":"Transform Operations","url":"https://developer.sailpoint.com/idn/docs/transforms/operations"}},"attributes":{"description":"Meta-data about the transform. Values in this list are specific to the type of transform to be executed.","oneOf":[{"title":"accountAttribute","type":"object","required":["sourceName","attributeName"],"properties":{"sourceName":{"type":"string","description":"A reference to the source to search for the account","example":"Workday"},"attributeName":{"type":"string","description":"The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.","example":"DEPARTMENT"},"accountSortAttribute":{"type":"string","description":"The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries","example":"created"},"accountSortDescending":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)","example":false},"accountReturnFirstLink":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false","example":false},"accountFilter":{"type":"string","description":"This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria.\nOnly certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements","example":"!(nativeIdentity.startsWith(\"*DELETED*\"))"},"accountPropertyFilter":{"type":"string","description":"This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.\n\nAll account attributes are available for filtering as this operation is performed in memory.","example":"(groups.containsAll({'Admin'}) || location == 'Austin')"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"base64Decode","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"base64Encode","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"concat","type":"object","required":["values"],"properties":{"values":{"type":"array","items":{"type":"object"},"description":"An array of items to join together","example":["John"," ","Smith"]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"conditional","type":"object","required":["expression","positiveCondition","negativeCondition"],"properties":{"expression":{"type":"string","description":"A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. \n\nThe `eq` operator is the only valid comparison","example":"ValueA eq ValueB"},"positiveCondition":{"type":"string","description":"The output of the transform if the expression evalutes to true","example":"true"},"negativeCondition":{"type":"string","description":"The output of the transform if the expression evalutes to false","example":"false"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateCompare","type":"object","required":["firstDate","secondDate","operator","positiveCondition","negativeCondition"],"properties":{"firstDate":{"description":"This is the first date to consider (The date that would be on the left hand side of the comparison operation).","oneOf":[{"title":"accountAttribute","type":"object","required":["sourceName","attributeName"],"properties":{"sourceName":{"type":"string","description":"A reference to the source to search for the account","example":"Workday"},"attributeName":{"type":"string","description":"The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.","example":"DEPARTMENT"},"accountSortAttribute":{"type":"string","description":"The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries","example":"created"},"accountSortDescending":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)","example":false},"accountReturnFirstLink":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false","example":false},"accountFilter":{"type":"string","description":"This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria.\nOnly certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements","example":"!(nativeIdentity.startsWith(\"*DELETED*\"))"},"accountPropertyFilter":{"type":"string","description":"This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.\n\nAll account attributes are available for filtering as this operation is performed in memory.","example":"(groups.containsAll({'Admin'}) || location == 'Austin')"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateFormat","type":"object","properties":{"inputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"outputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}}]},"secondDate":{"description":"This is the second date to consider (The date that would be on the right hand side of the comparison operation).","oneOf":[{"title":"accountAttribute","type":"object","required":["sourceName","attributeName"],"properties":{"sourceName":{"type":"string","description":"A reference to the source to search for the account","example":"Workday"},"attributeName":{"type":"string","description":"The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.","example":"DEPARTMENT"},"accountSortAttribute":{"type":"string","description":"The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries","example":"created"},"accountSortDescending":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)","example":false},"accountReturnFirstLink":{"type":"boolean","description":"The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false","example":false},"accountFilter":{"type":"string","description":"This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria.\nOnly certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements","example":"!(nativeIdentity.startsWith(\"*DELETED*\"))"},"accountPropertyFilter":{"type":"string","description":"This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.\n\nAll account attributes are available for filtering as this operation is performed in memory.","example":"(groups.containsAll({'Admin'}) || location == 'Austin')"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateFormat","type":"object","properties":{"inputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"outputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}}]},"operator":{"type":"string","description":"This is the comparison to perform.\n| Operation | Description |\n| --------- | ------- |\n| LT | Strictly less than: firstDate < secondDate |\n| LTE | Less than or equal to: firstDate <= secondDate |\n| GT | Strictly greater than: firstDate > secondDate |\n| GTE | Greater than or equal to: firstDate >= secondDate |\n","enum":["LT","LTE","GT","GTE"],"example":"LT"},"positiveCondition":{"type":"string","description":"The output of the transform if the expression evalutes to true","example":"true"},"negativeCondition":{"type":"string","description":"The output of the transform if the expression evalutes to false","example":false},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateFormat","type":"object","properties":{"inputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"outputFormat":{"description":"A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.\n\n*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*","oneOf":[{"title":"Named Construct","type":"string","description":"| Construct | Date Time Pattern | Description |\n| --------- | ----------------- | ----------- |\n| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | \n| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |\n| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |\n| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |\n| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |\n","enum":["ISO8601","LDAP","PEOPLE_SOFT","EPOCH_TIME_JAVA","EPOCH_TIME_WIN32"],"example":"PEOPLE_SOFT"},{"title":"Java Simple Date Format","type":"string","description":"There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.\n\n>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.\n (This table is from the SimpleDateFormat page.)\n\n| Date Time Pattern | Result |\n| ----------------- | ------ |\n| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |\n| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |\n| `h:mm a` | 12:08 PM |\n| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |\n| `K:mm a, z` | 0:08 PM, PDT |\n| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |\n| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |\n| `yyMMddHHmmssZ` | 010704120856-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |\n| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |\n| `YYYY-'W'ww-u` | 2001-W27-3 |\n","example":"mm/dd/yyyy"}]},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"dateMath","type":"object","required":["expression"],"properties":{"expression":{"type":"string","description":"A string value of the date and time components to operation on, along with the math operations to execute.\n","externalDocs":{"description":"Date Math Expressions","url":"https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure"},"example":"now+1w"},"roundUp":{"type":"boolean","description":"A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. \n\n\nIf not provided, the transform will default to `false`\n\n\n`true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component)\n\n\n`false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated)\n","example":false},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"decomposeDiacriticalMarks","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"e164phone","type":"object","properties":{"defaultRegion":{"type":"string","description":"This is an optional attribute that can be used to define the region of the phone number to format into.\n\n\nIf defaultRegion is not provided, it will take US as the default country.\n\n\nThe format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\n","example":"US"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"firstValid","type":"object","required":["values"],"properties":{"values":{"type":"array","items":{"type":"object"},"description":"An array of attributes to evaluate for existence.","example":[{"attributes":{"sourceName":"Active Directory","attributeName":"sAMAccountName"},"type":"accountAttribute"},{"attributes":{"sourceName":"Okta","attributeName":"login"},"type":"accountAttribute"},{"attributes":{"sourceName":"HR Source","attributeName":"employeeID"},"type":"accountAttribute"}]},"ignoreErrors":{"type":"boolean","description":"a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur.","example":false},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false}}},{"title":"rule","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"This is the name of the Generic rule that needs to be invoked by the transform","example":"Generic Calculation Rule"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false}}},{"type":"object","required":["name","operation","includeNumbers","includeSpecialChars","length"],"properties":{"name":{"type":"string","description":"This must always be set to \"Cloud Services Deployment Utility\"","example":"Cloud Services Deployment Utility"},"operation":{"type":"string","description":"The operation to perform `generateRandomString`","example":"generateRandomString"},"includeNumbers":{"type":"boolean","description":"This must be either \"true\" or \"false\" to indicate whether the generator logic should include numbers","example":true},"includeSpecialChars":{"type":"boolean","description":"This must be either \"true\" or \"false\" to indicate whether the generator logic should include special characters","example":true},"length":{"type":"string","description":"This specifies how long the randomly generated string needs to be\n\n\n>NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters\n","example":"10"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false}}},{"type":"object","required":["name","operation","uid"],"properties":{"name":{"type":"string","description":"This must always be set to \"Cloud Services Deployment Utility\"","example":"Cloud Services Deployment Utility"},"operation":{"type":"string","description":"The operation to perform `getReferenceIdentityAttribute`","example":"getReferenceIdentityAttribute"},"uid":{"type":"string","description":"This is the SailPoint User Name (uid) value of the identity whose attribute is desired\n\nAs a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute.\n","example":"2c91808570313110017040b06f344ec9"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false}}}]},{"title":"identityAttribute","type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The system (camel-cased) name of the identity attribute to bring in","example":"email"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"indexOf","type":"object","required":["substring"],"properties":{"substring":{"type":"string","description":"A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.","example":"admin_"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"iso3166","type":"object","properties":{"format":{"type":"string","description":"An optional value to denote which ISO 3166 format to return. Valid values are:\n\n\n`alpha2` - Two-character country code (e.g., \"US\"); this is the default value if no format is supplied\n\n\n`alpha3` - Three-character country code (e.g., \"USA\")\n\n\n`numeric` - The numeric country code (e.g., \"840\")\n","example":"alpha2"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"leftPad","type":"object","required":["length"],"properties":{"length":{"type":"string","description":"An integer value for the desired length of the final output string","example":"4"},"padding":{"type":"string","description":"A string value representing the character that the incoming data should be padded with to get to the desired length\n\n\nIf not provided, the transform will default to a single space (\" \") character for padding\n","example":"0"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"lookup","type":"object","required":["table"],"properties":{"table":{"type":"object","additionalProperties":true,"description":"This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched\n\n\n>**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return \"Unknown Region\" for the attribute that is mapped to this transform.\n","example":{"USA":"Americas","FRA":"EMEA","AUS":"APAC","default":"Unknown Region"}},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"lower","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"nameNormalizer","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"randomAlphaNumeric","type":"object","properties":{"length":{"type":"string","description":"This is an integer value specifying the size/number of characters the random string must contain\n\n\n* This value must be a positive number and cannot be blank\n\n\n* If no length is provided, the transform will default to a value of `32`\n\n\n* Due to identity attribute data constraints, the maximum allowable value is `450` characters\n","example":"10"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"randomNumeric","type":"object","properties":{"length":{"type":"string","description":"This is an integer value specifying the size/number of characters the random string must contain\n\n\n* This value must be a positive number and cannot be blank\n\n\n* If no length is provided, the transform will default to a value of `32`\n\n\n* Due to identity attribute data constraints, the maximum allowable value is `450` characters\n","example":"10"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"reference","type":"object","required":["id"],"properties":{"id":{"type":"string","description":"This ID specifies the name of the pre-existing transform which you want to use within your current transform","example":"Existing Transform"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"replaceAll","type":"object","required":["table"],"properties":{"table":{"type":"object","additionalProperties":true,"description":"An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.","example":{"-":" ","\"":"'","ñ":"n"}},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"replace","type":"object","required":["regex","replacement"],"properties":{"regex":{"type":"string","description":"This can be a string or a regex pattern in which you want to replace.","example":"[^a-zA-Z]","externalDocs":{"description":"Regex Builder","url":"https://regex101.com/"}},"replacement":{"type":"string","description":"This is the replacement string that should be substituded wherever the string or pattern is found.","example":" "},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"rightPad","type":"object","required":["length"],"properties":{"length":{"type":"string","description":"An integer value for the desired length of the final output string","example":"4"},"padding":{"type":"string","description":"A string value representing the character that the incoming data should be padded with to get to the desired length\n\n\nIf not provided, the transform will default to a single space (\" \") character for padding\n","example":"0"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"split","type":"object","required":["delimiter","index"],"properties":{"delimiter":{"type":"string","description":"This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data","example":","},"index":{"type":"string","description":"An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.","example":"5"},"throws":{"type":"boolean","description":"A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array)\n\n\n`true` - The transform should return \"IndexOutOfBoundsException\"\n\n\n`false` - The transform should return null\n\n\nIf not provided, the transform will default to false and return a null\n","example":true},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"static","type":"object","required":["values"],"properties":{"values":{"type":"string","description":"This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.","example":"string$variable","externalDocs":{"description":"Static Transform Documentation","url":"https://developer.sailpoint.com/idn/docs/transforms/operations/static"}},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false}}},{"title":"substring","type":"object","required":["begin"],"properties":{"begin":{"type":"integer","description":"The index of the first character to include in the returned substring.\n\n\nIf `begin` is set to -1, the transform will begin at character 0 of the input data\n","example":1,"format":"int32"},"beginOffset":{"type":"integer","description":"This integer value is the number of characters to add to the begin attribute when returning a substring. \n\nThis attribute is only used if begin is not -1.\n","example":3,"format":"int32"},"end":{"type":"integer","description":"The index of the first character to exclude from the returned substring.\n\nIf end is -1 or not provided at all, the substring transform will return everything up to the end of the input string.\n","example":6,"format":"int32"},"endOffset":{"type":"integer","description":"This integer value is the number of characters to add to the end attribute when returning a substring. \n\nThis attribute is only used if end is provided and is not -1.\n","example":1,"format":"int32"},"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"trim","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"upper","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false},"input":{"type":"object","description":"This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.","additionalProperties":true,"example":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}}},{"title":"uuid","type":"object","properties":{"requiresPeriodicRefresh":{"type":"boolean","description":"A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process","example":false,"default":false}}}]},"internal":{"type":"boolean","readOnly":true,"description":"Indicates whether this is an internal SailPoint-created transform or a customer-created transform","example":false}}},"example":{"id":"2cd78adghjkja34jh2b1hkjhasuecd","name":"Timestamp To Date","type":"dateFormat","attributes":{"inputFormat":"MMM-dd-yyyy, HH:mm:ss.SSS","outputFormat":"yyyy/dd/MM"},"internal":false}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"security":[{"oauth2":["idn:transform:manage"]}],"method":"put","path":"/transforms/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/v3","description":"This is the production API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"jsonRequestBodyExample":{"name":"Timestamp To Date","type":"dateFormat","attributes":{"sourceName":"Workday","attributeName":"DEPARTMENT","accountSortAttribute":"created","accountSortDescending":false,"accountReturnFirstLink":false,"accountFilter":"!(nativeIdentity.startsWith(\"*DELETED*\"))","accountPropertyFilter":"(groups.containsAll({'Admin'}) || location == 'Austin')","requiresPeriodicRefresh":false,"input":{"type":"accountAttribute","attributes":{"attributeName":"first_name","sourceName":"Source"}}}},"info":{"title":"IdentityNow V3 API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.0.0"},"postman":{"name":"Update a transform","description":{"content":"Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error.\nA token with transform write authority is required to call this API.","type":"text/plain"},"url":{"path":["transforms",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the transform to update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} +sidebar_class_name: "put api-method" +info_path: idn/api/v3/identitynow-v-3-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a transform' (update-transform)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Update a transform + + + +Replaces the transform specified by the given ID with the transform provided in the request body. Only the "attributes" field is mutable. Attempting to change other properties (ex. "name" and "type") will result in an error. +A token with transform write authority is required to call this API. + +
      Path Parameters
      Request Body
      + +The updated transform object (must include "name", "type", and "attributes" fields). + +
        attributes object required
        + +Meta-data about the transform. Values in this list are specific to the type of transform to be executed. + +
        oneOf
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        firstDate object required
        + +This is the first date to consider (The date that would be on the left hand side of the comparison operation). + +
        oneOf
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        inputFormat object
        + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
        oneOf
      • string
        + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
        + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
      • string
        + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
        • outputFormat object
        + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
        oneOf
      • string
        + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
        + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
      • string
        + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
        • input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        secondDate object required
        + +This is the second date to consider (The date that would be on the right hand side of the comparison operation). + +
        oneOf
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        inputFormat object
        + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
        oneOf
      • string
        + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
        + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
      • string
        + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
        • outputFormat object
        + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
        oneOf
      • string
        + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
        + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
      • string
        + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
        • input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
         secondDate |\n| GTE | Greater than or equal to: firstDate >= secondDate |\n"} schemaName={"string"} qualifierMessage={"**Possible values:** [`LT`, `LTE`, `GT`, `GTE`]"} defaultValue={undefined}>
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        inputFormat object
        + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
        oneOf
      • string
        + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
        + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
      • string
        + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
        • outputFormat object
        + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
        oneOf
      • string
        + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
        + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
      • string
        + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
        • input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        table object required
        + +This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched + + +>**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. + + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        table object required
        + +An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      + +Indicates the transform was successfully updated and returns its new representation. + +
      Schema
        attributes object
        + +Meta-data about the transform. Values in this list are specific to the type of transform to be executed. + +
        oneOf
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        firstDate object
        + +This is the first date to consider (The date that would be on the left hand side of the comparison operation). + +
        oneOf
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        inputFormat object
        + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
        oneOf
      • string
        + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
        + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
      • string
        + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
        • outputFormat object
        + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
        oneOf
      • string
        + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
        + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
      • string
        + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
        • input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        secondDate object
        + +This is the second date to consider (The date that would be on the right hand side of the comparison operation). + +
        oneOf
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        inputFormat object
        + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
        oneOf
      • string
        + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
        + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
      • string
        + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
        • outputFormat object
        + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
        oneOf
      • string
        + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
        + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
      • string
        + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
        • input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
         secondDate |\n| GTE | Greater than or equal to: firstDate >= secondDate |\n"} schemaName={"string"} qualifierMessage={"**Possible values:** [`LT`, `LTE`, `GT`, `GTE`]"} defaultValue={undefined}>
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        inputFormat object
        + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
        oneOf
      • string
        + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
        + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
      • string
        + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
        • outputFormat object
        + +A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. + +*If no inputFormat is provided, the transform assumes that it is in ISO8601 format* + +
        oneOf
      • string
        + +**Possible values:** [`ISO8601`, `LDAP`, `PEOPLE_SOFT`, `EPOCH_TIME_JAVA`, `EPOCH_TIME_WIN32`] + +
        + +| Construct | Date Time Pattern | Description | +| --------- | ----------------- | ----------- | +| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. | +| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | +| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | +| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | +| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | + + +
      • string
        + +There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information. + +>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. + (This table is from the SimpleDateFormat page.) + +| Date Time Pattern | Result | +| ----------------- | ------ | +| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` | +| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 | +| `h:mm a` | 12:08 PM | +| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time | +| `K:mm a, z` | 0:08 PM, PDT | +| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM | +| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 | +| `yyMMddHHmmssZ` | 010704120856-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 | +| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 | +| `YYYY-'W'ww-u` | 2001-W27-3 | + + +
        • input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        table object
        + +This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched + + +>**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform. + + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        table object
        + +An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
        input object
        + +This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. + +
      + +Client Error - Returned if the request body is invalid. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
      + +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
      Schema
      + +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 403 response object

      + +Not Found - returned if the request URL refers to a resource or object that does not exist + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 404 response object

      + +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. + +
      Schema
      + +Internal Server Error - Returned if there is an unexpected error. + +
      Schema
        messages object[]
        + +Generic localized reason for error + +
        causes object[]
        + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +

      An example of a 500 response object

      \ No newline at end of file diff --git a/products/idn/api/v3/work-items.tag.mdx b/products/idn/api/v3/work-items.tag.mdx new file mode 100644 index 000000000..4ef3ebbcf --- /dev/null +++ b/products/idn/api/v3/work-items.tag.mdx @@ -0,0 +1,34 @@ +--- +id: work-items +title: "Work Items" +description: "Work Items" +custom_edit_url: null +--- + + + +Use this API to implement work item functionality. +With this functionality in place, users can manage their work items (tasks). + +Work items refer to the tasks users see in IdentityNow's Task Manager. +They can see the pending work items they need to complete, as well as the work items they have already completed. +Task Manager lists the work items along with the involved sources, identities, accounts, and the timestamp when the work item was created. +For example, a user may see a pending 'Create an Account' work item for the identity Fred.Astaire in GitHub for Fred's GitHub account, fred-astaire-sp. +Once the user completes the work item, the work item will be listed with his or her other completed work items. + +To complete work items, users can use their dashboards and select the 'My Tasks' widget. +The widget will list any work items they need to complete, and they can select the work item from the list to review its details. +When they complete the work item, they can select 'Mark Complete' to add it to their list of completed work items. + +Refer to [Task Manager](https://documentation.sailpoint.com/saas/user-help/task_manager.html) for more information about work items, including the different types of work items users may need to complete. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/idn/docs/identity-now/event-triggers/filtering-events.md b/products/idn/docs/identity-now/event-triggers/filtering-events.md index a0168fe3e..2ca0feda6 100644 --- a/products/idn/docs/identity-now/event-triggers/filtering-events.md +++ b/products/idn/docs/identity-now/event-triggers/filtering-events.md @@ -130,7 +130,7 @@ To validate a filter using the UI, subscribe to a new event trigger or edit an e ### Validating Filters Using the API -You can validate a trigger filter by using the [validate filter](/idn/api/beta/validate-subscription-filter) API endpoint. You must escape any double quotes, as seen in the example payload in the API description. Also, you must provide a sample input for the validation engine to run against. It is best to use the input example included in the input/output schemas for the event trigger you want to apply your filter to. Refer to [this table](/idn/api/beta/triggers#available-event-triggers) to find the schema of your event trigger. This is an example request: +You can validate a trigger filter by using the validate filter `/idn/api/beta/validate-subscription-filter` API endpoint. You must escape any double quotes, as seen in the example payload in the API description. Also, you must provide a sample input for the validation engine to run against. It is best to use the input example included in the input/output schemas for the event trigger you want to apply your filter to. Refer to [this table](/idn/api/beta/triggers#available-event-triggers) to find the schema of your event trigger. This is an example request: ```text POST https://{tenant}.api.identitynow.com/beta/trigger-subscriptions/validate-filter diff --git a/products/iiq/api/accounts.tag.mdx b/products/iiq/api/accounts.tag.mdx new file mode 100644 index 000000000..e46dbcae5 --- /dev/null +++ b/products/iiq/api/accounts.tag.mdx @@ -0,0 +1,16 @@ +--- +id: accounts +title: "Accounts" +description: "Accounts" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/iiq/api/alerts.tag.mdx b/products/iiq/api/alerts.tag.mdx new file mode 100644 index 000000000..10bd4ac12 --- /dev/null +++ b/products/iiq/api/alerts.tag.mdx @@ -0,0 +1,16 @@ +--- +id: alerts +title: "Alerts" +description: "Alerts" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/iiq/api/applications.tag.mdx b/products/iiq/api/applications.tag.mdx new file mode 100644 index 000000000..7d52457a6 --- /dev/null +++ b/products/iiq/api/applications.tag.mdx @@ -0,0 +1,20 @@ +--- +id: applications +title: "Applications" +description: "Applications" +custom_edit_url: null +--- + + + +Alert object, a generic real time event processing object. + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/iiq/api/check-policy-violations.api.mdx b/products/iiq/api/check-policy-violations.api.mdx new file mode 100644 index 000000000..0e3549aa4 --- /dev/null +++ b/products/iiq/api/check-policy-violations.api.mdx @@ -0,0 +1,56 @@ +--- +id: check-policy-violations +sidebar_label: This endpoint simulates provisioning a set of access items, and then checks against a set of policies to determine if granting the access items would cause creation of new policy violations. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"checkPolicyViolations","tags":["Checked Policy Violations"],"description":">This submits a set of access items to request and a set of policies to check after the access provisioning is simulated in order to determine if policy violations would be created by provisioning the access items. It receives a payload that includes: \n\n>**An identity:** Used as the recipient for the access items on the simulation. \n\n>**A provisioning plan:** To specify the changes to be simulatedly provisioned in the provided identity \n\n>**A list of policies:** to check after the simulation of provisioning plan was applied to the identity in order to determine if the access granted in the simulation causes new policy violations. \n\n>Optionally you can pass a list of attributes, as query params, to be included or excluded from the response, this setting is applicable only to top level attributes as defined in the schema ***urn:ietf:params:scim:schemas:sailpoint:1.0:CheckedPolicyViolation.*** \n\n>**Valid values**: \n**- policies**\n **- identity**\n **- plan**\n **- violations**\n **- leftBundles**\n **- rightBundles** \n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identity":{"description":"An identity for whom access is requested on the provisioning simulation","type":"string","example":{"identity":"Ryan.Russell"}},"plan":{"description":"A provisioning plan detailing the access to request on the simulation","type":"object","properties":{"value":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"op":{"description":"The operation to perform on the provisioning.","type":"string","example":"Modify"},"instance":{"type":"string","example":"null","description":"A particular instance to provision this access to"},"application":{"type":"string","example":"Active_Directory","description":"The application that owns the access items in the request"},"attributes":{"type":"array","items":{"type":"object","properties":{"op":{"description":"The operation to perform on the access item.","type":"string","example":"Add"},"name":{"description":"The type of access item to provision.","type":"string","example":"groupmbr"},"value":{"description":"The name of the access item to provision.","type":"string","example":"UnixAdministration"}}}}}}}}}}},"type":{"type":"string","example":"application/sailpoint.object.ProvisioningPlan+json"},"policies":{"description":"A list of policies to check for new policy violations on the access provisioned by the simulation.","type":"array","items":{"type":"string"},"example":["SOD Policy","Entitlement Policy","RandomPolicyNotExisting"]}}}}}},"responses":{"201":{"description":"Returns a list of violations based on simulated requested access","content":{"application/json":{"schema":{"type":"object","properties":{"identity":{"description":"An identity for whom access was requested on the provisioning simulation","type":"string","example":{"identity":"Ryan.Russell"}},"meta":{"type":"object","properties":{"resourceType":{"description":"","type":"string","example":"CheckedPolicyViolation"}}},"violations":{"type":"array","items":{"properties":{"entitlements":{"description":"An array of the entitlements used in the provisioning simulation.","type":"array","items":{"type":"string"},"example":["a2a","a2b","benefits"]},"policyName":{"description":"The name of the policy that conflicted with the access items provisioned in the simulation causing policy violation.","type":"string","example":"SOD Policy"},"policyType":{"description":"The type of the policy that conflicted with the access items provisioned in the simulation causing policy violation(s).","type":"string","example":"SOD"},"description":{"description":"The description of the policy violation(s) caused by the access provisioned in the simulation.","type":"string","example":"Security design should not be combined with administrative permissions."},"constraintName":{"description":"The specific constraint in the policy that conflicted with the access items provisioned in the simulation.","type":"string","example":" IT SOD-117"},"leftBundles":{"description":"The left set of entitlements defined in the policy constraint in order to check against another set of entitlements for compliance.","type":"array","items":{"type":"string"},"example":["Security Architect - IT"]},"rightBundles":{"description":"The right set of entitlements defined in the policy constraint in order to check against another set of entitlements for compliance.","type":"array","items":{"type":"string"},"example":["Unix Administrator - IT"]}}}},"schemas":{"description":"The SCIM schema for Checked Policy Violations.","type":"array","items":{"type":"string","example":"urn:ietf:params:scim:schemas:sailpoint:1.0:CheckedPolicyViolation"}},"policies":{"description":"The set of policies used to check for conflicting access in the provisioning simulation","type":"array","items":{"type":"string"},"example":["SOD Policy","Entitlement Policy","RandomPolicyNotExisting"]},"plan":{"description":"A provisioning plan detailing the access to request on the simulation","type":"object","properties":{"value":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"op":{"description":"The operation performed on the access in the provisioning simulation.","type":"string","example":"Modify"},"instance":{"type":"string","example":"null","description":"A particular instance to provision this access to"},"application":{"type":"string","example":"Active_Directory","description":"The application that owns the access provisioned in the simulation."},"attributes":{"type":"array","items":{"type":"object","properties":{"op":{"description":"The operation performed on the access in the provisioning simulation.","type":"string","example":"Add"},"name":{"description":"The type of provisioned access.","type":"string","example":"groupmbr"},"value":{"description":"The name of the provisioned access items.","type":"string","example":"UnixAdministration"}}}}}}}}},"type":{"type":"string","example":"application/sailpoint.object.ProvisioningPlan+json"}}}}}}}}},"parameters":[{"in":"query","name":"attributes","schema":{"type":"string"},"description":"A list of attributes to indicate what top level attributes to include in the response"},{"in":"query","name":"authnPassword","schema":{"type":"string"},"description":"Password for authentication"},{"in":"query","name":"authnUsername","schema":{"type":"string"},"description":"Username for authentication"},{"in":"query","name":"excludedAttributes","schema":{"type":"string"},"description":"A list of attributes to indicate what top level attributes to exclude from the response"},{"in":"query","name":"lookupByName","schema":{"type":"boolean"},"description":"This is not required in this endpoint, the returned object is a new PolicyViolation and not one returned from the persistence layer. This is inherited from the BaseSCIMResource and is used to override the default id based lookup, and use a name based lookup instead, if for any reason the artifact id is not present.","example":false}],"method":"post","path":"/CheckedPolicyViolations","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"jsonRequestBodyExample":{"identity":{"identity":"Ryan.Russell"},"plan":{"value":{"accounts":[{"op":"Modify","instance":"null","application":"Active_Directory","attributes":[{"op":"Add","name":"groupmbr","value":"UnixAdministration"}]}]}},"type":"application/sailpoint.object.ProvisioningPlan+json","policies":["SOD Policy","Entitlement Policy","RandomPolicyNotExisting"]},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"This endpoint simulates provisioning a set of access items, and then checks against a set of policies to determine if granting the access items would cause creation of new policy violations.","description":{"content":">This submits a set of access items to request and a set of policies to check after the access provisioning is simulated in order to determine if policy violations would be created by provisioning the access items. It receives a payload that includes: \n\n>**An identity:** Used as the recipient for the access items on the simulation. \n\n>**A provisioning plan:** To specify the changes to be simulatedly provisioned in the provided identity \n\n>**A list of policies:** to check after the simulation of provisioning plan was applied to the identity in order to determine if the access granted in the simulation causes new policy violations. \n\n>Optionally you can pass a list of attributes, as query params, to be included or excluded from the response, this setting is applicable only to top level attributes as defined in the schema ***urn:ietf:params:scim:schemas:sailpoint:1.0:CheckedPolicyViolation.*** \n\n>**Valid values**: \n**- policies**\n **- identity**\n **- plan**\n **- violations**\n **- leftBundles**\n **- rightBundles** \n","type":"text/plain"},"url":{"path":["CheckedPolicyViolations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A list of attributes to indicate what top level attributes to include in the response","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"Password for authentication","type":"text/plain"},"key":"authnPassword","value":""},{"disabled":false,"description":{"content":"Username for authentication","type":"text/plain"},"key":"authnUsername","value":""},{"disabled":false,"description":{"content":"A list of attributes to indicate what top level attributes to exclude from the response","type":"text/plain"},"key":"excludedAttributes","value":""},{"disabled":false,"description":{"content":"This is not required in this endpoint, the returned object is a new PolicyViolation and not one returned from the persistence layer. This is inherited from the BaseSCIMResource and is used to override the default id based lookup, and use a name based lookup instead, if for any reason the artifact id is not present.","type":"text/plain"},"key":"lookupByName","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'This endpoint simulates provisioning a set of access items, and then checks against a set of policies to determine if granting the access items would cause creation of new policy violations.' (check-policy-violations)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## This endpoint simulates provisioning a set of access items, and then checks against a set of policies to determine if granting the access items would cause creation of new policy violations. + + + +\>This submits a set of access items to request and a set of policies to check after the access provisioning is simulated in order to determine if policy violations would be created by provisioning the access items. It receives a payload that includes: + +>**An identity:** Used as the recipient for the access items on the simulation. + +>**A provisioning plan:** To specify the changes to be simulatedly provisioned in the provided identity + +>**A list of policies:** to check after the simulation of provisioning plan was applied to the identity in order to determine if the access granted in the simulation causes new policy violations. + +>Optionally you can pass a list of attributes, as query params, to be included or excluded from the response, this setting is applicable only to top level attributes as defined in the schema ***urn:ietf:params:scim:schemas:sailpoint:1.0:CheckedPolicyViolation.*** + +>**Valid values**: +**- policies** + **- identity** + **- plan** + **- violations** + **- leftBundles** + **- rightBundles** + + +
      Query Parameters
      Request Body required
        plan object
        + +A provisioning plan detailing the access to request on the simulation + +
        value object
        accounts object[]
        attributes object[]
      + +Returns a list of violations based on simulated requested access + +
      Schema
        meta object
        violations undefined[]
        plan object
        + +A provisioning plan detailing the access to request on the simulation + +
        value object
        accounts object[]
        attributes object[]
      \ No newline at end of file diff --git a/products/iiq/api/checked-policy-violations.tag.mdx b/products/iiq/api/checked-policy-violations.tag.mdx new file mode 100644 index 000000000..e5baa9967 --- /dev/null +++ b/products/iiq/api/checked-policy-violations.tag.mdx @@ -0,0 +1,16 @@ +--- +id: checked-policy-violations +title: "Checked Policy Violations" +description: "Checked Policy Violations" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/iiq/api/create-account.api.mdx b/products/iiq/api/create-account.api.mdx new file mode 100644 index 000000000..653db2150 --- /dev/null +++ b/products/iiq/api/create-account.api.mdx @@ -0,0 +1,71 @@ +--- +id: create-account +sidebar_label: Creates an Account. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createAccount","tags":["Accounts"],"description":"The endpoint used to create an Account resource. The required payload fields can differ drastically depending on the Application.","parameters":[{"in":"query","name":"attributes","schema":{"type":"string","example":"displayName,active"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"displayName,active"},"description":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*"}],"requestBody":{"required":true,"content":{"application/scim+json":{"schema":{"properties":{"identity":{"required":["value"],"description":"The corresponding User object of the Account.","properties":{"userName":{"description":"The identity name of the Account User.","type":"string","example":"Barbara.Jensen"},"displayName":{"description":"The displayable name of the Account User.","type":"string","example":"Barbara Jensen"},"value":{"description":"IdentityIQ identifier for the Account User.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"ref":{"description":"The URI of the SCIM resource representing the Account User.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"application":{"required":["value"],"description":"The corresponding Application object of the Account.","properties":{"displayName":{"description":"The displayable name of the Account Application.","type":"string","example":"Mock Application1"},"value":{"description":"IdentityIQ identifier for the Account Application.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"ref":{"description":"The URI of the SCIM resource representing the Account Application.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Applications/c0a7778b7ef71e79817ee74e6a1f0444"}}},"nativeIdentity":{"description":"The Account unique identifier associated with the native application. This field is immutable.","type":"string","example":"a1b2c3"},"displayName":{"description":"The name of the Account, suitable for display to end-users.","type":"string","example":"Barbara Jensen"},"instance":{"description":"The instance identifier of the Account. This field is immutable.","type":"string","example":"mockInstance"},"password":{"description":"The password of the Account, used in created or changing the Account password. This attribute is write-only and will never be returned in a response.","type":"string","example":"useStrongPwd123!"},"currentPassword":{"description":"The current password of the Account, used in created or changing the Account password. This attribute is write-only and will never be returned in a response.","type":"string","example":"useStrongPwd123!"},"urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account":{"description":"Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.

      Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true},"active":{"description":"Flag to indicate this account is enabled or disabled.","type":"boolean","example":true},"locked":{"description":"Flag to indicate this account is locked. An account may be unlocked by setting this attribute to false, but can not be locked by setting a false value to true.","type":"boolean","example":true}},"required":["identity","application","nativeIdentity","urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account"]}},"*/*":{"schema":{"properties":{"identity":{"required":["value"],"description":"The corresponding User object of the Account.","properties":{"userName":{"description":"The identity name of the Account User.","type":"string","example":"Barbara.Jensen"},"displayName":{"description":"The displayable name of the Account User.","type":"string","example":"Barbara Jensen"},"value":{"description":"IdentityIQ identifier for the Account User.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"ref":{"description":"The URI of the SCIM resource representing the Account User.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"application":{"required":["value"],"description":"The corresponding Application object of the Account.","properties":{"displayName":{"description":"The displayable name of the Account Application.","type":"string","example":"Mock Application1"},"value":{"description":"IdentityIQ identifier for the Account Application.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"ref":{"description":"The URI of the SCIM resource representing the Account Application.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Applications/c0a7778b7ef71e79817ee74e6a1f0444"}}},"nativeIdentity":{"description":"The Account unique identifier associated with the native application. This field is immutable.","type":"string","example":"a1b2c3"},"displayName":{"description":"The name of the Account, suitable for display to end-users.","type":"string","example":"Barbara Jensen"},"instance":{"description":"The instance identifier of the Account. This field is immutable.","type":"string","example":"mockInstance"},"password":{"description":"The password of the Account, used in created or changing the Account password. This attribute is write-only and will never be returned in a response.","type":"string","example":"useStrongPwd123!"},"currentPassword":{"description":"The current password of the Account, used in created or changing the Account password. This attribute is write-only and will never be returned in a response.","type":"string","example":"useStrongPwd123!"},"urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account":{"description":"Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.

      Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true},"active":{"description":"Flag to indicate this account is enabled or disabled.","type":"boolean","example":true},"locked":{"description":"Flag to indicate this account is locked. An account may be unlocked by setting this attribute to false, but can not be locked by setting a false value to true.","type":"boolean","example":true}},"required":["identity","application","nativeIdentity","urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account"]}}}},"responses":{"201":{"description":"Creates an Account and returns the resultant Account.","content":{"application/json":{"schema":{"properties":{"id":{"description":"IdentityIQ id of the Account.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"identity":{"description":"The corresponding User object of the Account.","properties":{"userName":{"description":"The identity name of the Account User.","type":"string","example":"Barbara.Jensen"},"displayName":{"description":"The displayable name of the Account User.","type":"string","example":"Barbara Jensen"},"value":{"description":"IdentityIQ identifier for the Account User.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"ref":{"description":"The URI of the SCIM resource representing the Account User.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"application":{"description":"The corresponding Application object of the Account.","properties":{"displayName":{"description":"The displayable name of the Account Application.","type":"string","example":"Mock Application1"},"value":{"description":"IdentityIQ identifier for the Account Application.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"ref":{"description":"The URI of the SCIM resource representing the Account Application.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Applications/c0a7778b7ef71e79817ee74e6a1f0444"}}},"nativeIdentity":{"description":"The Account unique identifier associated with the native application. This field is immutable.","type":"string","example":"a1b2c3"},"displayName":{"description":"The name of the Account, suitable for display to end-users.","type":"string","example":"Barbara Jensen"},"instance":{"description":"The instance identifier of the Account. This field is immutable.","type":"string","example":null},"uuid":{"description":"The UUID of the Account.","type":"string","example":"{f99999ff-f000-444b-b6ae-4443dd6cd6ed}"},"urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account":{"description":"Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.

      Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true},"active":{"description":"Flag to indicate this account is enabled or disabled.","type":"boolean","example":true},"locked":{"description":"Flag to indicate this account is locked. An account may be unlocked by setting this attribute to false, but can not be locked by setting a false value to true.","type":"boolean","example":true},"manuallyCorrelated":{"description":"Flag to indicate this account has been manually correlated in the UI.","type":"boolean","example":true},"hasEntitlements":{"description":"Flag to indicate this account has one or more entitlement attributes.","type":"boolean","example":true},"lastRefresh":{"description":"Datetime representation of the last refresh for this Account.","type":"string","format":"date-time"},"lastTargetAggregation":{"description":"Datetime representation of last targeted aggregation for the Account.","type":"string","format":"date-time"},"meta":{"description":"Metadata of the SCIM resource.","properties":{"created":{"description":"Datetime this resource was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Accounts/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the resource was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the SCIM resource.","type":"string","example":"W\"1644561244074\""},"resourceType":{"description":"The resource type.","type":"string","example":"Account"}}},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:Account","urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Mock Application:account"]}}}}}}},"method":"post","path":"/Accounts","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"jsonRequestBodyExample":{"identity":{"userName":"Barbara.Jensen","displayName":"Barbara Jensen","value":"c0a7778b7ef71e79817ee74e6a1f0444","ref":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"},"application":{"displayName":"Mock Application1","value":"c0a7778b7ef71e79817ee74e6a1f0444","ref":"http://localhost:8080/iiq/scim/v2/Applications/c0a7778b7ef71e79817ee74e6a1f0444"},"nativeIdentity":"a1b2c3","displayName":"Barbara Jensen","instance":"mockInstance","password":"useStrongPwd123!","currentPassword":"useStrongPwd123!","urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account":{},"active":true,"locked":true},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Creates an Account.","description":{"content":"The endpoint used to create an Account resource. The required payload fields can differ drastically depending on the Application.","type":"text/plain"},"url":{"path":["Accounts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/scim+json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Creates an Account.' (create-account)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Creates an Account. + + + +The endpoint used to create an Account resource. The required payload fields can differ drastically depending on the Application. + +
      Query Parameters
      Request Body required
        identity required
        + +The corresponding User object of the Account. + +
        application required
        + +The corresponding Application object of the Account. + +
        urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account object required
        + +Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.

        Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { "department": "IT"} + +
      Request Body required
        identity required
        + +The corresponding User object of the Account. + +
        application required
        + +The corresponding Application object of the Account. + +
        urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account object required
        + +Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.

        Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { "department": "IT"} + +
      + +Creates an Account and returns the resultant Account. + +
      Schema
        identity
        + +The corresponding User object of the Account. + +
        application
        + +The corresponding Application object of the Account. + +
        urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account object
        + +Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.

        Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { "department": "IT"} + +
        meta
        + +Metadata of the SCIM resource. + +
      \ No newline at end of file diff --git a/products/iiq/api/create-alert.api.mdx b/products/iiq/api/create-alert.api.mdx new file mode 100644 index 000000000..024005ab6 --- /dev/null +++ b/products/iiq/api/create-alert.api.mdx @@ -0,0 +1,63 @@ +--- +id: create-alert +sidebar_label: Creates a new Alert. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createAlert","tags":["Alerts"],"description":"The endpoint used to create an Alert resource.","parameters":[{"in":"query","name":"attributes","schema":{"type":"string","example":"name"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"name, application"},"description":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**"}],"requestBody":{"required":true,"content":{"application/scim+json":{"schema":{"properties":{"displayName":{"description":"Display name of the Alert.","type":"string","example":"Confidential File Opened"},"type":{"description":"Type of the Alert.","type":"string","example":"alert"},"attributes":{"description":"A list of attributes of the Alert.","type":"array","items":{"properties":{"key":{"description":"The attribute key.","type":"string","example":"userFullName"},"value":{"description":"The attribute value.","type":"string","example":"TEST/Anne.Arnold"}}}},"alertDate":{"description":"The Alert DateTime, this could have different meanings based on the type of alert.","type":"string","format":"date-time","example":"2022-05-04T13:24:09.661-05:00"},"nativeId":{"description":"Unique Identifier of the Alert in the native system.","type":"string","example":"2351234513245349"},"targetId":{"description":"Unique Identifier of the target object which caused the Alert.","type":"string","example":"2c9091d24f65486f014f6568be4400f7"},"targetType":{"description":"The type of SailPointObject the target is.","type":"string","example":"Identity"},"targetDisplayName":{"description":"User friendly display name of the target object.","type":"string","example":"Anne.Arnold"},"application":{"description":"The corresponding Application object of the Alert.","type":"object","properties":{"displayName":{"description":"The name of the Alert Application. OPTIONAL and READ-ONLY.","type":"string","example":"JDBCDirectAlerts"},"value":{"description":"The Application associated with the Alert.","type":"string","example":"7f00000180281df7818028bfed100826"},"$ref":{"description":"The URI of the SCIM resource representating the Alert application.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826"}}}}}}}},"responses":{"201":{"description":"Creates an Alert and returns the resultant Alert.","content":{"application/json":{"schema":{"properties":{"id":{"description":"Unique identifier of the Alert.","type":"string","example":"c0a8019c7fe11678817fe18984351477"},"name":{"description":"Name of the Alert, auto-generated by the SCIM Server.","type":"string","example":"0000000001"},"displayName":{"description":"Display name of the Alert.","type":"string","example":"Hello World!"},"type":{"description":"Type of the Alert.","type":"string","example":"Permission"},"attributes":{"description":"A list of attributes of the Alert.","type":"array","items":{"properties":{"value":{"description":"The attribute value.","type":"string","example":"Grackle5.Test.Sailpoint.com"},"key":{"description":"The attribute key.","type":"string","example":"bamName"}}}},"application":{"description":"The corresponding Application object of the Alert.","type":"object","properties":{"value":{"description":"The Application associated with the Alert.","type":"string","example":"Active_Directory"},"$ref":{"description":"The URI of the SCIM resource representating the Alert application.","type":"object","example":"http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826"},"displayName":{"description":"The name of the Alert Application.","type":"string","example":"Active_Directory"}}},"actions":{"description":"Not empty if action was taken on the Alert.","type":"array","items":{"properties":{"type":{"description":"The type of action performed as a result of the Alert.","type":"string","enum":["WORKFLOW","CERTIFICATION","NOTIFICATION"],"example":"WORKFLOW"},"alertDefinitionName":{"description":"The name of the Alert Definition that triggered the action.","type":"string","example":"lowSeverityAlertDefinition"},"resultId":{"description":"Typically actions create other objects, a certificationId or workflowId as a result of the action taken.","type":"string","example":"7f00000180281df7818028c109ea1742"},"result":{"description":"The Task Result of the Alert.","type":"array","items":{"properties":{"name":{"description":"The name of the Task Result for the Alert action.","type":"string"},"workflowName":{"description":"The name of the Workflow used in the Alert action task result.","type":"string","example":"LCM Provisioning"},"notifications":{"description":"Notifications to send when a Alert action is generated.","type":"array","items":{"properties":{"name":{"description":"The name of configured notifications for Alert action results.","type":"string","example":"lowLevelAlertNotification"},"displayName":{"description":"Display name for the Alert action notification.","type":"string","example":"lowLevelAlert result notification"},"emailAddresses":{"description":"A list of email addresses to send an Alert action notification.","type":"string","example":"amanda.ross@demoexample.com, alice.ford@demoexample.com"}}}}}}}}}},"alertDate":{"description":"The Alert DateTime, this could have different meanings based on the type of alert.","type":"string","format":"date-time","example":"2022-03-31T14:52:40.265-05:00"},"lastProcessed":{"description":"The DateTime of the last time the alert was processed, this does not indicate the system took action on the Alert.","type":"string","format":"date-time","example":"2022-03-31T14:52:40.260-05:00"},"nativeId":{"description":"Unique Identifier of the Alert in the native system.","type":"string","example":"420bebfb-c87a-406f-930c-29e06feb47bc"},"targetId":{"description":"Unique Identifier of the target object which caused the Alert.","type":"string","example":"c0a8019c7fe51750817fe634a6b10171"},"targetType":{"description":"The type of SailPointObject the target is.","type":"string","example":"Certification"},"targetDisplayName":{"description":"User friendly display name of the target object.","type":"string","example":"Manager Certification"},"meta":{"description":"Metadata for the Alert.","type":"array","items":{"properties":{"created":{"description":"DateTime when the Alert was created.","type":"string","format":"date-time","example":"2022-03-31T14:52:40.245-05:00"},"location":{"description":"URL to the Alert.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Alerts/c0a8019c7fe11678817fe18984351477"},"lastModified":{"description":"DateTime of Alert last modification.","type":"string","format":"date-time","example":"2022-03-31T14:52:40.265-05:00"},"version":{"description":"Alert version.","type":"string","example":"W\"1650050901217\""},"resourceType":{"description":"Resource type of the metadata subject.","type":"string","example":"Alert"}}}},"schemas":{"description":"A list of the schemas used for Alerts.","type":"array","items":{"type":"string","example":["urn:ietf:params:scim:schemas:sailpoint:1.0:AlertInput","urn:ietf:params:scim:schemas:sailpoint:1.0:Alert"]}}}}}}}},"method":"post","path":"/Alerts","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"jsonRequestBodyExample":{"displayName":"Confidential File Opened","type":"alert","attributes":[{"key":"userFullName","value":"TEST/Anne.Arnold"}],"alertDate":"2022-05-04T13:24:09.661-05:00","nativeId":"2351234513245349","targetId":"2c9091d24f65486f014f6568be4400f7","targetType":"Identity","targetDisplayName":"Anne.Arnold","application":{"displayName":"JDBCDirectAlerts","value":"7f00000180281df7818028bfed100826","$ref":"http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Creates a new Alert.","description":{"content":"The endpoint used to create an Alert resource.","type":"text/plain"},"url":{"path":["Alerts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/scim+json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Creates a new Alert.' (create-alert)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Creates a new Alert. + + + +The endpoint used to create an Alert resource. + +
      Query Parameters
      Request Body required
        attributes undefined[]
        + +A list of attributes of the Alert. + +
        application object
        + +The corresponding Application object of the Alert. + +
      + +Creates an Alert and returns the resultant Alert. + +
      Schema
        attributes undefined[]
        + +A list of attributes of the Alert. + +
        application object
        + +The corresponding Application object of the Alert. + +
        actions undefined[]
        + +Not empty if action was taken on the Alert. + +
        result undefined[]
        + +The Task Result of the Alert. + +
        notifications undefined[]
        + +Notifications to send when a Alert action is generated. + +
        meta undefined[]
        + +Metadata for the Alert. + +
      \ No newline at end of file diff --git a/products/iiq/api/create-user.api.mdx b/products/iiq/api/create-user.api.mdx new file mode 100644 index 000000000..4fa1539ca --- /dev/null +++ b/products/iiq/api/create-user.api.mdx @@ -0,0 +1,139 @@ +--- +id: create-user +sidebar_label: Creates a User. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createUser","tags":["Users"],"description":"The endpoint used to create a User resource. There are attributes marked as 'returned only by request', such as **roles**, which must be provided as part of the **attributes** query parameter in order to be included in the response.","parameters":[{"in":"query","name":"attributes","schema":{"type":"string","example":"userName,nativeIdentity"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"userName,manuallyCorrelated"},"description":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*"}],"requestBody":{"required":true,"content":{"application/scim+json":{"schema":{"properties":{"userName":{"description":"Unique identifier for the User. Typically used to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the entire set of Users. This attribute cannot be changed.","type":"string","example":"Mock.User"},"name":{"description":"The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.","properties":{"formatted":{"description":"The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.","type":"string","example":"Ms. Barbara J Jensen, III"},"familyName":{"description":"The family name of the User, or Last Name in most Western languages","type":"string","example":"Jensen"},"givenName":{"description":"The given name of the User, or First Name in most Western languages","type":"string","example":"Barbara"}}},"displayName":{"description":"The name of the User, suitable for display to end-users. The name should be the full name of the User being described.","type":"string","example":"Barbara Jensen"},"userType":{"description":"The type of the User, identifying the relationship between the organization and the User.","type":"string","example":"employee"},"active":{"description":"A Boolean value indicating the User’s administrative status.","type":"boolean","example":true},"password":{"description":"The User's case-sensitive cleartext password. This attribute is intended to be used as a means to specify an initial password when creating a new User or to reset an existing User's password. This attribute will never be returned in a response.","type":"string"},"emails":{"description":"Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.","type":"array","items":{"properties":{"type":{"description":"Type of email address (work, home, other).","type":"string","example":"work"},"value":{"description":"Canonicalized email address.","type":"string","format":"email","example":"Barbara.Jensen@example.com"},"primary":{"description":"A Boolean value indicating the primary e-mail address. The primary attribute value 'true' MUST appear no more than once.","type":"boolean","example":"true"}}}},"urn:ietf:params:scim:schemas:sailpoint:1.0:User":{"properties":{"capabilities":{"description":"Capabilities assigned to this User.","type":"array","items":{"type":"string"},"example":"[\"SystemAdministrator\"]"},"administrator":{"description":"The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service.","properties":{"displayName":{"description":"The display name of the Administrator of RPA user or Service account.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the SCIM resource representing the Administrator of RPA user or Service account.","type":"string","example":"c0a7777a7f74744d817e74fc12362c67O"},"$ref":{"description":"The URI of the SCIM resource representing the Administrator of RPA user or Service Account.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67"}}},"softwareVersion":{"description":"The software version of the RPA/Bots.","type":"string","example":"7.3"},"empId":{"description":"Employee id associated with this User.","type":"string","example":"1b2a3c"},"dn":{"description":"Distinguished name for this User.","type":"string","example":"cn=Bob Smith,ou=services"},"region":{"description":"The region this User is assigned to.","type":"string","example":"Americas"},"regionOwner":{"description":"The User who owns the region that this resource (User) belongs to.","properties":{"displayName":{"description":"Display name of the region owner.","type":"string","example":"Joe Smith"},"value":{"description":"The id of the region owner.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"$ref":{"description":"URI reference of the region owner resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"}}},"location":{"description":"The location this User is assigned to.","type":"string","example":"Singapore"},"locationOwner":{"description":"The User who owns the location that this resource (User) belongs to.","type":"object","properties":{"displayName":{"description":"Display name of the location owner.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the location owner.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"URI reference to the location owner resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"Department":{"description":"Department this User is assigned to.","type":"string","example":"Regional Operations"},"costcenter":{"description":"Cost centers this User is associated with.","type":"array","items":{"type":"string"},"example":["CC01","DD02"]},"jobtitle":{"description":"Job title given to this User.","type":"string","example":"Internal Audit Manager"}}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"description":"Enterprise User Schema. Contains the manager of the User.","properties":{"manager":{"description":"Manager of the user.","properties":{"displayName":{"description":"Display name of the manager.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the manager.","type":"string","example":"c7a7347a7fe71e69077ee75f5d1f1237"},"$ref":{"description":"Reference to the manager resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237"}}}}}},"required":["userName"]}},"*/*":{"schema":{"properties":{"userName":{"description":"Unique identifier for the User. Typically used to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the entire set of Users. This attribute cannot be changed.","type":"string","example":"Mock.User"},"name":{"description":"The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.","properties":{"formatted":{"description":"The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.","type":"string","example":"Ms. Barbara J Jensen, III"},"familyName":{"description":"The family name of the User, or Last Name in most Western languages","type":"string","example":"Jensen"},"givenName":{"description":"The given name of the User, or First Name in most Western languages","type":"string","example":"Barbara"}}},"displayName":{"description":"The name of the User, suitable for display to end-users. The name should be the full name of the User being described.","type":"string","example":"Barbara Jensen"},"userType":{"description":"The type of the User, identifying the relationship between the organization and the User.","type":"string","example":"employee"},"active":{"description":"A Boolean value indicating the User’s administrative status.","type":"boolean","example":true},"password":{"description":"The User's case-sensitive cleartext password. This attribute is intended to be used as a means to specify an initial password when creating a new User or to reset an existing User's password. This attribute will never be returned in a response.","type":"string"},"emails":{"description":"Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.","type":"array","items":{"properties":{"type":{"description":"Type of email address (work, home, other).","type":"string","example":"work"},"value":{"description":"Canonicalized email address.","type":"string","format":"email","example":"Barbara.Jensen@example.com"},"primary":{"description":"A Boolean value indicating the primary e-mail address. The primary attribute value 'true' MUST appear no more than once.","type":"boolean","example":"true"}}}},"urn:ietf:params:scim:schemas:sailpoint:1.0:User":{"properties":{"capabilities":{"description":"Capabilities assigned to this User.","type":"array","items":{"type":"string"},"example":"[\"SystemAdministrator\"]"},"administrator":{"description":"The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service.","properties":{"displayName":{"description":"The display name of the Administrator of RPA user or Service account.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the SCIM resource representing the Administrator of RPA user or Service account.","type":"string","example":"c0a7777a7f74744d817e74fc12362c67O"},"$ref":{"description":"The URI of the SCIM resource representing the Administrator of RPA user or Service Account.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67"}}},"softwareVersion":{"description":"The software version of the RPA/Bots.","type":"string","example":"7.3"},"empId":{"description":"Employee id associated with this User.","type":"string","example":"1b2a3c"},"dn":{"description":"Distinguished name for this User.","type":"string","example":"cn=Bob Smith,ou=services"},"region":{"description":"The region this User is assigned to.","type":"string","example":"Americas"},"regionOwner":{"description":"The User who owns the region that this resource (User) belongs to.","properties":{"displayName":{"description":"Display name of the region owner.","type":"string","example":"Joe Smith"},"value":{"description":"The id of the region owner.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"$ref":{"description":"URI reference of the region owner resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"}}},"location":{"description":"The location this User is assigned to.","type":"string","example":"Singapore"},"locationOwner":{"description":"The User who owns the location that this resource (User) belongs to.","type":"object","properties":{"displayName":{"description":"Display name of the location owner.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the location owner.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"URI reference to the location owner resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"Department":{"description":"Department this User is assigned to.","type":"string","example":"Regional Operations"},"costcenter":{"description":"Cost centers this User is associated with.","type":"array","items":{"type":"string"},"example":["CC01","DD02"]},"jobtitle":{"description":"Job title given to this User.","type":"string","example":"Internal Audit Manager"}}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"description":"Enterprise User Schema. Contains the manager of the User.","properties":{"manager":{"description":"Manager of the user.","properties":{"displayName":{"description":"Display name of the manager.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the manager.","type":"string","example":"c7a7347a7fe71e69077ee75f5d1f1237"},"$ref":{"description":"Reference to the manager resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237"}}}}}},"required":["userName"]}}}},"responses":{"201":{"description":"Creates a User and returns the resultant User.","content":{"application/json":{"schema":{"properties":{"id":{"description":"IdentityIQ id of the User.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"userName":{"description":"Unique identifier for the User. Typically used to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the entire set of Users. Cannot be changed.","type":"string","example":"Mock.User"},"name":{"description":"The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.","properties":{"formatted":{"description":"The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.","type":"string","example":"Ms. Barbara J Jensen, III"},"familyName":{"description":"The family name of the User, or Last Name in most Western languages","type":"string","example":"Jensen"},"givenName":{"description":"The given name of the User, or First Name in most Western languages","type":"string","example":"Barbara"}}},"displayName":{"description":"The name of the User, suitable for display to end-users. The name should be the full name of the User being described.","type":"string","example":"Barbara Jensen"},"userType":{"description":"The type of the User, identifying the relationship between the organization and the User.","type":"string","example":"employee"},"active":{"description":"A Boolean value indicating the User’s administrative status.","type":"boolean","example":true},"emails":{"description":"Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.","type":"array","items":{"properties":{"type":{"description":"Type of email address (work, home, other).","type":"string","example":"work"},"value":{"description":"Canonicalized email address.","type":"string","format":"email","example":"Barbara.Jensen@example.com"},"primary":{"description":"A Boolean value indicating the primary e-mail address. The primary attribute value 'true' MUST appear no more than once.","type":"boolean","example":"true"}}}},"urn:ietf:params:scim:schemas:sailpoint:1.0:User":{"description":"Additional attributes of the User.","type":"object","properties":{"accounts":{"description":"Simple representation of the Account (or Link) ResourceType.","type":"array","items":{"properties":{"displayName":{"description":"The display name of the Account.","type":"string","example":"Bob.Smith"},"value":{"description":"The id of the SCIM resource representing the Account.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"The URI of the SCIM resource representing the Account.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Accounts/c0a7778b7ef71e79817ee74e6a1f0444"}}}},"entitlements":{"description":"Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter.","type":"array","items":{"properties":{"value":{"description":"The value of the Entitlement.","type":"string","example":"groupmbr"},"display":{"description":"The display name of the Entitlement.","type":"string","example":"HelpDesk"},"type":{"description":"The type of Entitlement (Entitlement, Permission, etc.).","type":"string","example":"Permission"},"application":{"description":"The name of the Application this Entitlement applies to.","type":"string","example":"ADMockApp"},"accountName":{"description":"The account this Entitlement was sourced from.","type":"string","example":"CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com"},"$ref":{"description":"The URI of the SCIM resource representing the Entitlement.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Entitlements/c0a7777a7f74744d817e74fc12362c67"}}}},"roles":{"description":"Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter.","type":"array","items":{"properties":{"value":{"description":"The value of the Role.","type":"string","example":"detectedRoles"},"display":{"description":"The display name of the Role.","type":"string","example":"User - IT"},"type":{"description":"The type of Role (IT, Business, etc.).","type":"string","example":"it"},"acquired":{"description":"Indicates how this Role was acquired. Assigned or Detected.","type":"string","example":"Assigned"},"application":{"description":"The name of the Application where this Role came from.","type":"string","example":"Active_Directory"},"accountName":{"description":"The name of the Account this Role was sourced from.","type":"string","example":"CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com"},"$ref":{"description":"The URI of the SCIM resource representing the Role.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Roles/c0a7777a7f74744d817e74fc12362c67"}}}},"capabilities":{"description":"Capabilities assigned to this User.","type":"array","items":{"type":"string"},"example":"[\"SystemAdministrator\"]"},"riskScore":{"description":"Composite Risk Score of this User.","type":"integer","example":125},"isManager":{"description":"A Boolean value that determines if this User is a manager.","type":"boolean","example":false},"administrator":{"description":"The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service.","properties":{"displayName":{"description":"The display name of the Administrator of RPA user or Service account.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the SCIM resource representing the Administrator of RPA user or Service account.","type":"string","example":"c0a7777a7f74744d817e74fc12362c67O"},"$ref":{"description":"The URI of the SCIM resource representing the Administrator of RPA user or Service Account.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67"}}},"softwareVersion":{"description":"The software version of the RPA/Bots.","type":"string","example":"7.3"},"empId":{"description":"Employee id associated with this User.","type":"string","example":"1b2a3c"},"dn":{"description":"Distinguished name for this User.","type":"string","example":"cn=Bob Smith,ou=services"},"region":{"description":"The region this User is assigned to.","type":"string","example":"Americas"},"regionOwner":{"description":"The User who owns the region that this resource (User) belongs to.","properties":{"displayName":{"description":"Display name of the region owner.","type":"string","example":"Joe Smith"},"value":{"description":"The id of the region owner.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"$ref":{"description":"URI reference of the region owner resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"}}},"location":{"description":"The location this User is assigned to.","type":"string","example":"Singapore"},"locationOwner":{"description":"The User who owns the location that this resource (User) belongs to.","type":"object","properties":{"displayName":{"description":"Display name of the location owner.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the location owner.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"URI reference to the location owner resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"Department":{"description":"Department this User is assigned to.","type":"string","example":"Regional Operations"},"costcenter":{"description":"Cost centers this User is associated with.","type":"array","items":{"type":"string"},"example":["CC01","DD02"]},"jobtitle":{"description":"Job title given to this User.","type":"string","example":"Internal Audit Manager"},"lastRefresh":{"description":"Datetime representation of the last refresh for this User.","type":"string","format":"date-time"}}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"description":"Enterprise User Schema. Contains the manager of the User.","properties":{"manager":{"description":"Manager of the User.","properties":{"displayName":{"description":"Display name of the User's manager.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the SCIM resource representing the User’s manager.","type":"string","example":"c7a7347a7fe71e69077ee75f5d1f1237"},"$ref":{"description":"The URI of the SCIM resource representing the User’s manager.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237"}}}}},"meta":{"description":"Metadata of the resource.","properties":{"created":{"description":"Datetime this resource was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the resource was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the resource.","type":"string","example":"W\"1644561244074\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"User"}}},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:User","urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"]}}}}}},"409":{"description":"Returned if userName is not unique.","content":{"application/json":{"schema":{"properties":{"schemas":{"description":"SCIM Schemas used in response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:Error"]},"scimType":{"description":"Type of problem that exists for request.","type":"string","example":"uniqueness"},"detail":{"description":"Explanation for the the problem with the request.","type":"string","example":"Resource already exists:Mock.User"},"status":{"description":"HTTP status code of the response.","type":"string","example":"409"}}}}}}},"method":"post","path":"/Users","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"jsonRequestBodyExample":{"userName":"Mock.User","name":{"formatted":"Ms. Barbara J Jensen, III","familyName":"Jensen","givenName":"Barbara"},"displayName":"Barbara Jensen","userType":"employee","active":true,"password":"string","emails":[{"type":"work","value":"Barbara.Jensen@example.com","primary":"true"}],"urn:ietf:params:scim:schemas:sailpoint:1.0:User":{"capabilities":"[\"SystemAdministrator\"]","administrator":{"displayName":"Bob Smith","value":"c0a7777a7f74744d817e74fc12362c67O","$ref":"http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67"},"softwareVersion":"7.3","empId":"1b2a3c","dn":"cn=Bob Smith,ou=services","region":"Americas","regionOwner":{"displayName":"Joe Smith","value":"c0b4568a4fe7458c434ee77d1fbt156b","$ref":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"},"location":"Singapore","locationOwner":{"displayName":"Bob Smith","value":"c0a7778b7ef71e79817ee74e6a1f0444","$ref":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"},"Department":"Regional Operations","costcenter":["CC01","DD02"],"jobtitle":"Internal Audit Manager"},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"manager":{"displayName":"Bob Smith","value":"c7a7347a7fe71e69077ee75f5d1f1237","$ref":"http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237"}}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Creates a User.","description":{"content":"The endpoint used to create a User resource. There are attributes marked as 'returned only by request', such as **roles**, which must be provided as part of the **attributes** query parameter in order to be included in the response.","type":"text/plain"},"url":{"path":["Users"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/scim+json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Creates a User.' (create-user)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Creates a User. + + + +The endpoint used to create a User resource. There are attributes marked as 'returned only by request', such as **roles**, which must be provided as part of the **attributes** query parameter in order to be included in the response. + +
      Query Parameters
      Request Body required
        name
        + +The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined. + +
        emails undefined[]
        + +Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other. + +
        urn:ietf:params:scim:schemas:sailpoint:1.0:User
        administrator
        + +The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service. + +
        regionOwner
        + +The User who owns the region that this resource (User) belongs to. + +
        locationOwner object
        + +The User who owns the location that this resource (User) belongs to. + +
        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
        + +Enterprise User Schema. Contains the manager of the User. + +
        manager
        + +Manager of the user. + +
      Request Body required
        name
        + +The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined. + +
        emails undefined[]
        + +Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other. + +
        urn:ietf:params:scim:schemas:sailpoint:1.0:User
        administrator
        + +The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service. + +
        regionOwner
        + +The User who owns the region that this resource (User) belongs to. + +
        locationOwner object
        + +The User who owns the location that this resource (User) belongs to. + +
        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
        + +Enterprise User Schema. Contains the manager of the User. + +
        manager
        + +Manager of the user. + +
      + +Creates a User and returns the resultant User. + +
      Schema
        name
        + +The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined. + +
        emails undefined[]
        + +Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other. + +
        urn:ietf:params:scim:schemas:sailpoint:1.0:User object
        + +Additional attributes of the User. + +
        accounts undefined[]
        + +Simple representation of the Account (or Link) ResourceType. + +
        entitlements undefined[]
        + +Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter. + +
        roles undefined[]
        + +Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter. + +
        administrator
        + +The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service. + +
        regionOwner
        + +The User who owns the region that this resource (User) belongs to. + +
        locationOwner object
        + +The User who owns the location that this resource (User) belongs to. + +
        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
        + +Enterprise User Schema. Contains the manager of the User. + +
        manager
        + +Manager of the User. + +
        meta
        + +Metadata of the resource. + +
      + +Returned if userName is not unique. + +
      Schema
      \ No newline at end of file diff --git a/products/iiq/api/delete-account.api.mdx b/products/iiq/api/delete-account.api.mdx new file mode 100644 index 000000000..ae044d81a --- /dev/null +++ b/products/iiq/api/delete-account.api.mdx @@ -0,0 +1,31 @@ +--- +id: delete-account +sidebar_label: Deletes an existing Account. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteAccount","tags":["Accounts"],"description":"The endpoint used to delete an Account resource. **This is not reversible.**","parameters":[{"name":"accountId","in":"path","schema":{"type":"string","example":"c7c7777c7ef77e77777ee77e7a1f0444"},"description":"The id of the Account.","required":true}],"responses":{"204":{"description":"Returns a 204 with no response body if delete was successful."}},"method":"delete","path":"/Accounts/{accountId}","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Deletes an existing Account.","description":{"content":"The endpoint used to delete an Account resource. **This is not reversible.**","type":"text/plain"},"url":{"path":["Accounts",":accountId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The id of the Account.","type":"text/plain"},"type":"any","value":"","key":"accountId"}]},"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Deletes an existing Account.' (delete-account)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Deletes an existing Account. + + + +The endpoint used to delete an Account resource. **This is not reversible.** + +
      Path Parameters
      + +Returns a 204 with no response body if delete was successful. + +
      \ No newline at end of file diff --git a/products/iiq/api/delete-user.api.mdx b/products/iiq/api/delete-user.api.mdx new file mode 100644 index 000000000..db8c2849d --- /dev/null +++ b/products/iiq/api/delete-user.api.mdx @@ -0,0 +1,31 @@ +--- +id: delete-user +sidebar_label: Deletes an existing User. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"deleteUser","tags":["Users"],"description":"The endpoint used to delete a User resource. **This is not reversible.**","parameters":[{"name":"userId","in":"path","schema":{"type":"string","example":"c7c7777c7ef77e77777ee77e7a1f0444"},"description":"The id of User resource. If **lookupByName** is set to **true**, this path parameter should be set to the **userName** of the User.","required":true},{"in":"query","name":"lookupByName","schema":{"type":"boolean","example":false,"default":false},"description":"A boolean value that determines if the User resource will be looked up by userName instead of userId (value in path parameter 'userId'). Setting this query parameter to true will cause the value pulled from the 'userId' path parameter to be treated as a userName when searching for the resource.

      **Example**: scim/v2/Users/**Mock.User**?**lookupByName=true**"}],"responses":{"204":{"description":"Returns a 204 with no response body if delete was successful."}},"method":"delete","path":"/Users/{userId}","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Deletes an existing User.","description":{"content":"The endpoint used to delete a User resource. **This is not reversible.**","type":"text/plain"},"url":{"path":["Users",":userId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A boolean value that determines if the User resource will be looked up by userName instead of userId (value in path parameter 'userId'). Setting this query parameter to true will cause the value pulled from the 'userId' path parameter to be treated as a userName when searching for the resource.

      **Example**: scim/v2/Users/**Mock.User**?**lookupByName=true**","type":"text/plain"},"key":"lookupByName","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The id of User resource. If **lookupByName** is set to **true**, this path parameter should be set to the **userName** of the User.","type":"text/plain"},"type":"any","value":"","key":"userId"}]},"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Deletes an existing User.' (delete-user)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Deletes an existing User. + + + +The endpoint used to delete a User resource. **This is not reversible.** + +
      Path Parameters
      Query Parameters

        **Example**: scim/v2/Users/**Mock.User**?**lookupByName=true**"}}>
      + +Returns a 204 with no response body if delete was successful. + +
      \ No newline at end of file diff --git a/products/iiq/api/entitlements.tag.mdx b/products/iiq/api/entitlements.tag.mdx new file mode 100644 index 000000000..3d8b95697 --- /dev/null +++ b/products/iiq/api/entitlements.tag.mdx @@ -0,0 +1,16 @@ +--- +id: entitlements +title: "Entitlements" +description: "Entitlements" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/iiq/api/get-account-by-id.api.mdx b/products/iiq/api/get-account-by-id.api.mdx new file mode 100644 index 000000000..2be9712dc --- /dev/null +++ b/products/iiq/api/get-account-by-id.api.mdx @@ -0,0 +1,63 @@ +--- +id: get-account-by-id +sidebar_label: Returns an Account resource based on id. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAccountById","tags":["Accounts"],"description":"The Account resource with matching id is returned.","parameters":[{"name":"accountId","in":"path","schema":{"type":"string","example":"c7c7777c7ef77e77777ee77e7a1f0444"},"description":"The id of the Account.","required":true},{"in":"query","name":"attributes","schema":{"type":"string","example":"displayName,active"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"displayName,active"},"description":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*"}],"responses":{"200":{"description":"Returns a single Account resource based on the id.","content":{"application/json":{"schema":{"properties":{"id":{"description":"IdentityIQ id of the Account.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"identity":{"description":"The corresponding User object of the Account.","properties":{"userName":{"description":"The identity name of the Account User.","type":"string","example":"Barbara.Jensen"},"displayName":{"description":"The displayable name of the Account User.","type":"string","example":"Barbara Jensen"},"value":{"description":"IdentityIQ identifier for the Account User.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"ref":{"description":"The URI of the SCIM resource representing the Account User.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"application":{"description":"The corresponding Application object of the Account.","properties":{"displayName":{"description":"The displayable name of the Account Application.","type":"string","example":"Mock Application1"},"value":{"description":"IdentityIQ identifier for the Account Application.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"ref":{"description":"The URI of the SCIM resource representing the Account Application.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Applications/c0a7778b7ef71e79817ee74e6a1f0444"}}},"nativeIdentity":{"description":"The Account unique identifier associated with the native application. This field is immutable.","type":"string","example":"a1b2c3"},"displayName":{"description":"The name of the Account, suitable for display to end-users.","type":"string","example":"Barbara Jensen"},"instance":{"description":"The instance identifier of the Account. This field is immutable.","type":"string","example":null},"uuid":{"description":"The UUID of the Account.","type":"string","example":"{f99999ff-f000-444b-b6ae-4443dd6cd6ed}"},"urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account":{"description":"Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.

      Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true},"active":{"description":"Flag to indicate this account is enabled or disabled.","type":"boolean","example":true},"locked":{"description":"Flag to indicate this account is locked. An account may be unlocked by setting this attribute to false, but can not be locked by setting a false value to true.","type":"boolean","example":true},"manuallyCorrelated":{"description":"Flag to indicate this account has been manually correlated in the UI.","type":"boolean","example":true},"hasEntitlements":{"description":"Flag to indicate this account has one or more entitlement attributes.","type":"boolean","example":true},"lastRefresh":{"description":"Datetime representation of the last refresh for this Account.","type":"string","format":"date-time"},"lastTargetAggregation":{"description":"Datetime representation of last targeted aggregation for the Account.","type":"string","format":"date-time"},"meta":{"description":"Metadata of the SCIM resource.","properties":{"created":{"description":"Datetime this resource was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Accounts/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the resource was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the SCIM resource.","type":"string","example":"W\"1644561244074\""},"resourceType":{"description":"The resource type.","type":"string","example":"Account"}}},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:Account","urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Mock Application:account"]}}}},"application/scim+json":{"schema":{"properties":{"id":{"description":"IdentityIQ id of the Account.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"identity":{"description":"The corresponding User object of the Account.","properties":{"userName":{"description":"The identity name of the Account User.","type":"string","example":"Barbara.Jensen"},"displayName":{"description":"The displayable name of the Account User.","type":"string","example":"Barbara Jensen"},"value":{"description":"IdentityIQ identifier for the Account User.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"ref":{"description":"The URI of the SCIM resource representing the Account User.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"application":{"description":"The corresponding Application object of the Account.","properties":{"displayName":{"description":"The displayable name of the Account Application.","type":"string","example":"Mock Application1"},"value":{"description":"IdentityIQ identifier for the Account Application.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"ref":{"description":"The URI of the SCIM resource representing the Account Application.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Applications/c0a7778b7ef71e79817ee74e6a1f0444"}}},"nativeIdentity":{"description":"The Account unique identifier associated with the native application. This field is immutable.","type":"string","example":"a1b2c3"},"displayName":{"description":"The name of the Account, suitable for display to end-users.","type":"string","example":"Barbara Jensen"},"instance":{"description":"The instance identifier of the Account. This field is immutable.","type":"string","example":null},"uuid":{"description":"The UUID of the Account.","type":"string","example":"{f99999ff-f000-444b-b6ae-4443dd6cd6ed}"},"urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account":{"description":"Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.

      Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true},"active":{"description":"Flag to indicate this account is enabled or disabled.","type":"boolean","example":true},"locked":{"description":"Flag to indicate this account is locked. An account may be unlocked by setting this attribute to false, but can not be locked by setting a false value to true.","type":"boolean","example":true},"manuallyCorrelated":{"description":"Flag to indicate this account has been manually correlated in the UI.","type":"boolean","example":true},"hasEntitlements":{"description":"Flag to indicate this account has one or more entitlement attributes.","type":"boolean","example":true},"lastRefresh":{"description":"Datetime representation of the last refresh for this Account.","type":"string","format":"date-time"},"lastTargetAggregation":{"description":"Datetime representation of last targeted aggregation for the Account.","type":"string","format":"date-time"},"meta":{"description":"Metadata of the SCIM resource.","properties":{"created":{"description":"Datetime this resource was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Accounts/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the resource was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the SCIM resource.","type":"string","example":"W\"1644561244074\""},"resourceType":{"description":"The resource type.","type":"string","example":"Account"}}},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:Account","urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Mock Application:account"]}}}}}}},"method":"get","path":"/Accounts/{accountId}","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns an Account resource based on id.","description":{"content":"The Account resource with matching id is returned.","type":"text/plain"},"url":{"path":["Accounts",":accountId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The id of the Account.","type":"text/plain"},"type":"any","value":"","key":"accountId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns an Account resource based on id.' (get-account-by-id)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns an Account resource based on id. + + + +The Account resource with matching id is returned. + +
      Path Parameters
      Query Parameters
      + +Returns a single Account resource based on the id. + +
      Schema
        identity
        + +The corresponding User object of the Account. + +
        application
        + +The corresponding Application object of the Account. + +
        urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account object
        + +Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.

        Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { "department": "IT"} + +
        meta
        + +Metadata of the SCIM resource. + +
      Schema
        identity
        + +The corresponding User object of the Account. + +
        application
        + +The corresponding Application object of the Account. + +
        urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account object
        + +Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.

        Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { "department": "IT"} + +
        meta
        + +Metadata of the SCIM resource. + +
      \ No newline at end of file diff --git a/products/iiq/api/get-accounts.api.mdx b/products/iiq/api/get-accounts.api.mdx new file mode 100644 index 000000000..b2f87e5be --- /dev/null +++ b/products/iiq/api/get-accounts.api.mdx @@ -0,0 +1,67 @@ +--- +id: get-accounts +sidebar_label: Returns all Account resources. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAccounts","tags":["Accounts"],"description":"This endpoint returns all Account resources.","parameters":[{"in":"query","name":"filter","schema":{"type":"string","example":"application.value eq \"7f000001804444fe818051b44414444c\" and displayName sw \"G\""},"description":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported."},{"in":"query","name":"sortBy","schema":{"type":"string","example":"displayName"},"description":"Allows sorting the results by a resource's attributes."},{"in":"query","name":"sortOrder","schema":{"type":"string","example":"descending","default":"ascending"},"description":"Determines what order to sort results in."},{"in":"query","name":"startIndex","schema":{"type":"integer","example":2313,"default":1},"description":"Determines the starting index of the result set."},{"in":"query","name":"count","schema":{"type":"integer","example":10,"default":1000},"description":"Specifies the number of results per page."},{"in":"query","name":"attributes","schema":{"type":"string","example":"displayName,active"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"displayName,active"},"description":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*"}],"responses":{"200":{"description":"Returns all Account resources.","content":{"application/json":{"schema":{"properties":{"totalResults":{"description":"Number of Account resources returned","type":"integer","example":"18,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"type":"array","items":{"properties":{"id":{"description":"IdentityIQ id of the Account.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"identity":{"description":"The corresponding User object of the Account.","properties":{"userName":{"description":"The identity name of the Account User.","type":"string","example":"Barbara.Jensen"},"displayName":{"description":"The displayable name of the Account User.","type":"string","example":"Barbara Jensen"},"value":{"description":"IdentityIQ identifier for the Account User.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"ref":{"description":"The URI of the SCIM resource representing the Account User.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"application":{"description":"The corresponding Application object of the Account.","properties":{"displayName":{"description":"The displayable name of the Account Application.","type":"string","example":"Mock Application1"},"value":{"description":"IdentityIQ identifier for the Account Application.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"ref":{"description":"The URI of the SCIM resource representing the Account Application.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Applications/c0a7778b7ef71e79817ee74e6a1f0444"}}},"nativeIdentity":{"description":"The Account unique identifier associated with the native application. This field is immutable.","type":"string","example":"a1b2c3"},"displayName":{"description":"The name of the Account, suitable for display to end-users.","type":"string","example":"Barbara Jensen"},"instance":{"description":"The instance identifier of the Account. This field is immutable.","type":"string","example":null},"uuid":{"description":"The UUID of the Account.","type":"string","example":"{f99999ff-f000-444b-b6ae-4443dd6cd6ed}"},"urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account":{"description":"Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.

      Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true},"active":{"description":"Flag to indicate this account is enabled or disabled.","type":"boolean","example":true},"locked":{"description":"Flag to indicate this account is locked. An account may be unlocked by setting this attribute to false, but can not be locked by setting a false value to true.","type":"boolean","example":true},"manuallyCorrelated":{"description":"Flag to indicate this account has been manually correlated in the UI.","type":"boolean","example":true},"hasEntitlements":{"description":"Flag to indicate this account has one or more entitlement attributes.","type":"boolean","example":true},"lastRefresh":{"description":"Datetime representation of the last refresh for this Account.","type":"string","format":"date-time"},"lastTargetAggregation":{"description":"Datetime representation of last targeted aggregation for the Account.","type":"string","format":"date-time"},"meta":{"description":"Metadata of the SCIM resource.","properties":{"created":{"description":"Datetime this resource was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Accounts/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the resource was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the SCIM resource.","type":"string","example":"W\"1644561244074\""},"resourceType":{"description":"The resource type.","type":"string","example":"Account"}}},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:Account","urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Mock Application:account"]}}}}}}},"application/scim+json":{"schema":{"properties":{"totalResults":{"description":"Number of Account resources returned.","type":"integer","example":"1500,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"description":"The SCIM resources returned for this endpoint.","type":"array","items":{"properties":{"id":{"description":"IdentityIQ id of the Account.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"identity":{"description":"The corresponding User object of the Account.","properties":{"userName":{"description":"The identity name of the Account User.","type":"string","example":"Barbara.Jensen"},"displayName":{"description":"The displayable name of the Account User.","type":"string","example":"Barbara Jensen"},"value":{"description":"IdentityIQ identifier for the Account User.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"ref":{"description":"The URI of the SCIM resource representing the Account User.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"application":{"description":"The corresponding Application object of the Account.","properties":{"displayName":{"description":"The displayable name of the Account Application.","type":"string","example":"Mock Application1"},"value":{"description":"IdentityIQ identifier for the Account Application.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"ref":{"description":"The URI of the SCIM resource representing the Account Application.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Applications/c0a7778b7ef71e79817ee74e6a1f0444"}}},"nativeIdentity":{"description":"The Account unique identifier associated with the native application. This field is immutable.","type":"string","example":"a1b2c3"},"displayName":{"description":"The name of the Account, suitable for display to end-users.","type":"string","example":"Barbara Jensen"},"instance":{"description":"The instance identifier of the Account. This field is immutable.","type":"string","example":null},"uuid":{"description":"The UUID of the Account.","type":"string","example":"{f99999ff-f000-444b-b6ae-4443dd6cd6ed}"},"urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account":{"description":"Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.

      Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true},"active":{"description":"Flag to indicate this account is enabled or disabled.","type":"boolean","example":true},"locked":{"description":"Flag to indicate this account is locked. An account may be unlocked by setting this attribute to false, but can not be locked by setting a false value to true.","type":"boolean","example":true},"manuallyCorrelated":{"description":"Flag to indicate this account has been manually correlated in the UI.","type":"boolean","example":true},"hasEntitlements":{"description":"Flag to indicate this account has one or more entitlement attributes.","type":"boolean","example":true},"lastRefresh":{"description":"Datetime representation of the last refresh for this Account.","type":"string","format":"date-time"},"lastTargetAggregation":{"description":"Datetime representation of last targeted aggregation for the Account.","type":"string","format":"date-time"},"meta":{"description":"Metadata of the SCIM resource.","properties":{"created":{"description":"Datetime this resource was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Accounts/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the resource was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the SCIM resource.","type":"string","example":"W\"1644561244074\""},"resourceType":{"description":"The resource type.","type":"string","example":"Account"}}},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:Account","urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Mock Application:account"]}}}}}}}}}},"method":"get","path":"/Accounts","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns all Account resources.","description":{"content":"This endpoint returns all Account resources.","type":"text/plain"},"url":{"path":["Accounts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.","type":"text/plain"},"key":"filter","value":""},{"disabled":false,"description":{"content":"Allows sorting the results by a resource's attributes.","type":"text/plain"},"key":"sortBy","value":""},{"disabled":false,"description":{"content":"Determines what order to sort results in.","type":"text/plain"},"key":"sortOrder","value":""},{"disabled":false,"description":{"content":"Determines the starting index of the result set.","type":"text/plain"},"key":"startIndex","value":""},{"disabled":false,"description":{"content":"Specifies the number of results per page.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns all Account resources.' (get-accounts)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns all Account resources. + + + +This endpoint returns all Account resources. + +
      Query Parameters
      + +Returns all Account resources. + +
      Schema
        Resources undefined[]
        identity
        + +The corresponding User object of the Account. + +
        application
        + +The corresponding Application object of the Account. + +
        urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account object
        + +Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.

        Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { "department": "IT"} + +
        meta
        + +Metadata of the SCIM resource. + +
      Schema
        Resources undefined[]
        + +The SCIM resources returned for this endpoint. + +
        identity
        + +The corresponding User object of the Account. + +
        application
        + +The corresponding Application object of the Account. + +
        urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account object
        + +Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.

        Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { "department": "IT"} + +
        meta
        + +Metadata of the SCIM resource. + +
      \ No newline at end of file diff --git a/products/iiq/api/get-alert-by-id.api.mdx b/products/iiq/api/get-alert-by-id.api.mdx new file mode 100644 index 000000000..42d571164 --- /dev/null +++ b/products/iiq/api/get-alert-by-id.api.mdx @@ -0,0 +1,54 @@ +--- +id: get-alert-by-id +sidebar_label: Returns an Alert resource based on id. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAlertById","tags":["Alerts"],"description":">The Alert resource with matching id is returned.

      \n>Attributes to include in the response can be specified with the attributes query parameter.

      \n>Attributes to exclude from the response can be specified with the excludedAttributes query parameter.

      \n","parameters":[{"name":"alertId","in":"path","schema":{"type":"string","example":"c0a8019c802d1e5a81802eb2b57e020f"},"description":"id of Alert resource.","required":true},{"in":"query","name":"attributes","schema":{"type":"string","example":"name"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"name, application"},"description":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**"}],"responses":{"200":{"description":"Returns a single Alert resource based on the id.","content":{"application/json":{"schema":{"properties":{"id":{"description":"Unique identifier of the Alert.","type":"string","example":"c0a8019c7ffa186e817ffb80170a0195"},"name":{"description":"Name of the Alert, auto-generated by the SCIM Server.","type":"string","example":"0000000002"},"displayName":{"description":"Display name of the Alert.","type":"string","example":"Workflow Alert"},"type":{"description":"Type of the Alert.","type":"string","example":"Business Process Alert"},"attributes":{"description":"A list of attributes of the Alert.","type":"array","items":{"properties":{"value":{"description":"The attribute value.","type":"string","example":"Windows File Server (Agent)"},"key":{"description":"The attribute key.","type":"string","example":"applicationType"}}}},"application":{"description":"The corresponding Application object of the Alert.","type":"array","items":{"properties":{"value":{"description":"The Application associated with the Alert.","type":"string","example":"SAP"},"$ref":{"description":"The URI of the SCIM resource representating the Alert application.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826"},"displayName":{"description":"The name of the Alert Application. OPTIONAL and READ-ONLY.","type":"string","example":"SAP Financial App"}}}},"actions":{"description":"Alert actions.","type":"array","items":{"properties":{"type":{"description":"The type of action performed as a result of the Alert.","type":"string","enum":["WORKFLOW","CERTIFICATION","NOTIFICATION"],"example":"Certification"},"alertDefinitionName":{"description":"The name of the Alert Definition that triggered the action.","type":"string","example":"certLauncher"},"resultId":{"description":"Typically actions create other objects, a certificationId or workflowId as a result of the action taken.","type":"string","example":"7f00000180281df7818028c109ea1742"},"result":{"description":"The Task Result of the Alert.","type":"array","items":{"properties":{"name":{"description":"The name of the Task Result for the Alert action.","type":"string","example":"Alert 0000000001 Certification Result"},"workflowName":{"description":"The name of the Workflow used in the Alert action task result.","type":"string","example":"refreshCerficationSchedule"},"notifications":{"type":"array","description":"Notifications to send when a Alert action is generated.","items":{"properties":{"name":{"description":"The name of configured notifications for Alert action results.","type":"string","example":9},"displayName":{"description":"Display name for the Alert action notification.","type":"string","example":"Certification Refresh Notification for James.Smith"},"emailAddresses":{"description":"A list of email addresses to send an Alert action notification.","type":"string","example":"james.smith@demoexample.com"}}}}}}}}}},"alertDate":{"description":"The Alert DateTime, this could have different meanings based on the type of alert.","type":"string","format":"date-time","example":"2022-03-31T14:52:40.265-05:00"},"lastProcessed":{"description":"The DateTime of the last time the Alert was processed, this does not indicate the system took action on the Alert.","type":"string","format":"date-time","example":"2022-03-31T14:52:40.260-05:00"},"nativeId":{"description":"Unique Identifier of the Alert in the native system.","type":"string","example":"420bebfb-c87a-406f-930c-29e06feb47bc"},"targetId":{"description":"Unique Identifier of the target object which caused the Alert.","type":"string","example":"c0a8019c7fe51750817fe634a6b10171"},"targetType":{"description":"The type of SailPointObject the target is.","type":"string","example":"Certification"},"targetDisplayName":{"description":"User friendly display name of the target object.","type":"string","example":"Manager Certification"},"meta":{"type":"object","properties":{"created":{"description":"DateTime when the Alert was created.","type":"string","format":"date-time","example":"2022-04-05T15:52:30.090-05:00"},"location":{"description":"URL to the Alert.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Alerts/c0a8019c7ffa186e817ffb80170a0195"},"lastModified":{"description":"DateTime of Alert last modification.","type":"string","format":"date-time","example":"2022-04-05T15:52:30.119-05:00"},"version":{"description":"Alert version.","type":"string","example":"W\"1649191950119\""},"resourceType":{"description":"Resource type of the metadata subject.","type":"string","example":"Alert"}}}}}}}}},"method":"get","path":"/Alerts/{alertId}","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns an Alert resource based on id.","description":{"content":">The Alert resource with matching id is returned.

      \n>Attributes to include in the response can be specified with the attributes query parameter.

      \n>Attributes to exclude from the response can be specified with the excludedAttributes query parameter.

      \n","type":"text/plain"},"url":{"path":["Alerts",":alertId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) id of Alert resource.","type":"text/plain"},"type":"any","value":"","key":"alertId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns an Alert resource based on id.' (get-alert-by-id)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns an Alert resource based on id. + + + +\>The Alert resource with matching id is returned.

      +>Attributes to include in the response can be specified with the attributes query parameter.

      +>Attributes to exclude from the response can be specified with the excludedAttributes query parameter.

      + + +
      Path Parameters
      Query Parameters
      + +Returns a single Alert resource based on the id. + +
      Schema
        attributes undefined[]
        + +A list of attributes of the Alert. + +
        application undefined[]
        + +The corresponding Application object of the Alert. + +
        actions undefined[]
        + +Alert actions. + +
        result undefined[]
        + +The Task Result of the Alert. + +
        notifications undefined[]
        + +Notifications to send when a Alert action is generated. + +
        meta object
      \ No newline at end of file diff --git a/products/iiq/api/get-alerts.api.mdx b/products/iiq/api/get-alerts.api.mdx new file mode 100644 index 000000000..3e4d21d49 --- /dev/null +++ b/products/iiq/api/get-alerts.api.mdx @@ -0,0 +1,89 @@ +--- +id: get-alerts +sidebar_label: Returns all Alert resources. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getAlerts","tags":["Alerts"],"description":"This endpoint returns all Alert resources.

      \nAttributes to include in the response can be specified with the 'attributes' query parameter.

      \nAttributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

      \nThe schemas related to Alerts are:\n- **urn:ietf:params:scim:schemas:core:1.0:Alert**\n- **urn:ietf:params:scim:schemas:core:1.0:AlertInput**\n","parameters":[{"in":"query","name":"filter","schema":{"type":"string","example":"name eq \"0000000001\""},"description":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported."},{"in":"query","name":"lookupByName","schema":{"type":"boolean","default":false,"example":true},"description":"Set to true if the Alert name is passed instead of the Alert id."},{"in":"query","name":"sortBy","schema":{"type":"string","example":"name"},"description":"Allows sorting the results by a resource's attributes."},{"in":"query","name":"sortOrder","schema":{"type":"string","default":"ascending"},"example":"descending","description":"Determines what order to sort results in."},{"in":"query","name":"startIndex","schema":{"type":"integer","example":"10","default":1},"description":"Determines the starting index of the result set."},{"in":"query","name":"count","schema":{"type":"integer","example":"10","default":1000},"description":"Specifies the number of results per page."},{"in":"query","name":"attributes","schema":{"type":"string","example":"name"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"name, application"},"description":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**"}],"responses":{"200":{"description":"Returned all SCIM resources for this endpoint.","content":{"application/json":{"schema":{"properties":{"totalResults":{"description":"Number of resources returned for this endpoint.","type":"integer","example":"1,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"type":"array","items":{"properties":{"id":{"description":"Unique identifier of the Alert.","type":"string","example":"c0a8019c7fe11678817fe18984351477"},"name":{"description":"Name of the Alert, auto-generated by the SCIM Server.","type":"string","example":"0000000001"},"displayName":{"description":"Display name of the Alert.","type":"string","example":"Hello World!"},"type":{"description":"Type of the Alert.","type":"string","example":"Permission"},"attributes":{"description":"A list of attributes of the Alert.","type":"array","items":{"properties":{"value":{"description":"The attribute value.","type":"string","example":"Grackle5.Test.Sailpoint.com"},"key":{"description":"The attribute key.","type":"string","example":"bamName"}}}},"application":{"description":"The corresponding Application object of the Alert.","type":"object","properties":{"value":{"description":"The Application associated with the Alert.","type":"string","example":"Active_Directory"},"$ref":{"description":"The URI of the SCIM resource representating the Alert application.","type":"object","example":"http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826"},"displayName":{"description":"The name of the Alert Application.","type":"string","example":"Active_Directory"}}},"actions":{"description":"Not empty if action was taken on the Alert.","type":"array","items":{"properties":{"type":{"description":"The type of action performed as a result of the Alert.","type":"string","enum":["WORKFLOW","CERTIFICATION","NOTIFICATION"],"example":"WORKFLOW"},"alertDefinitionName":{"description":"The name of the Alert Definition that triggered the action.","type":"string","example":"lowSeverityAlertDefinition"},"resultId":{"description":"Typically actions create other objects, a certificationId or workflowId as a result of the action taken.","type":"string","example":"7f00000180281df7818028c109ea1742"},"result":{"description":"The Task Result of the Alert.","type":"array","items":{"properties":{"name":{"description":"The name of the Task Result for the Alert action.","type":"string"},"workflowName":{"description":"The name of the Workflow used in the Alert action task result.","type":"string","example":"LCM Provisioning"},"notifications":{"description":"Notifications to send when a Alert action is generated.","type":"array","items":{"properties":{"name":{"description":"The name of configured notifications for Alert action results.","type":"string","example":"lowLevelAlertNotification"},"displayName":{"description":"Display name for the Alert action notification.","type":"string","example":"lowLevelAlert result notification"},"emailAddresses":{"description":"A list of email addresses to send an Alert action notification.","type":"string","example":"amanda.ross@demoexample.com, alice.ford@demoexample.com"}}}}}}}}}},"alertDate":{"description":"The Alert DateTime, this could have different meanings based on the type of alert.","type":"string","format":"date-time","example":"2022-03-31T14:52:40.265-05:00"},"lastProcessed":{"description":"The DateTime of the last time the alert was processed, this does not indicate the system took action on the Alert.","type":"string","format":"date-time","example":"2022-03-31T14:52:40.260-05:00"},"nativeId":{"description":"Unique Identifier of the Alert in the native system.","type":"string","example":"420bebfb-c87a-406f-930c-29e06feb47bc"},"targetId":{"description":"Unique Identifier of the target object which caused the Alert.","type":"string","example":"c0a8019c7fe51750817fe634a6b10171"},"targetType":{"description":"The type of SailPointObject the target is.","type":"string","example":"Certification"},"targetDisplayName":{"description":"User friendly display name of the target object.","type":"string","example":"Manager Certification"},"meta":{"description":"Metadata for the Alert.","type":"array","items":{"properties":{"created":{"description":"DateTime when the Alert was created.","type":"string","format":"date-time","example":"2022-03-31T14:52:40.245-05:00"},"location":{"description":"URL to the Alert.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Alerts/c0a8019c7fe11678817fe18984351477"},"lastModified":{"description":"DateTime of Alert last modification.","type":"string","format":"date-time","example":"2022-03-31T14:52:40.265-05:00"},"version":{"description":"Alert version.","type":"string","example":"W\"1650050901217\""},"resourceType":{"description":"Resource type of the metadata subject.","type":"string","example":"Alert"}}}},"schemas":{"description":"A list of the schemas used for Alerts.","type":"array","items":{"type":"string","example":["urn:ietf:params:scim:schemas:sailpoint:1.0:AlertInput","urn:ietf:params:scim:schemas:sailpoint:1.0:Alert"]}}}}}}}},"application/scim+json":{"schema":{"properties":{"totalResults":{"description":"Number of Alert resources returned.","type":"integer","example":"1500,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"description":"The SCIM resources returned for this endpoint.","type":"array","items":{"properties":{"id":{"description":"Unique identifier of the Alert.","type":"string","example":"c0a8019c7fe11678817fe18984351477"},"name":{"description":"Name of the Alert, auto-generated by the SCIM Server.","type":"string","example":"0000000001"},"displayName":{"description":"Display name of the Alert.","type":"string","example":"Hello World!"},"type":{"description":"Type of the Alert.","type":"string","example":"Permission"},"attributes":{"description":"A list of attributes of the Alert.","type":"array","items":{"properties":{"value":{"description":"The attribute value.","type":"string","example":"Grackle5.Test.Sailpoint.com"},"key":{"description":"The attribute key.","type":"string","example":"bamName"}}}},"application":{"description":"The corresponding Application object of the Alert.","type":"object","properties":{"value":{"description":"The Application associated with the Alert.","type":"string","example":"Active_Directory"},"$ref":{"description":"The URI of the SCIM resource representating the Alert application.","type":"object","example":"http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826"},"displayName":{"description":"The name of the Alert Application.","type":"string","example":"Active_Directory"}}},"actions":{"description":"Not empty if action was taken on the Alert.","type":"array","items":{"properties":{"type":{"description":"The type of action performed as a result of the Alert.","type":"string","enum":["WORKFLOW","CERTIFICATION","NOTIFICATION"],"example":"WORKFLOW"},"alertDefinitionName":{"description":"The name of the Alert Definition that triggered the action.","type":"string","example":"lowSeverityAlertDefinition"},"resultId":{"description":"Typically actions create other objects, a certificationId or workflowId as a result of the action taken.","type":"string","example":"7f00000180281df7818028c109ea1742"},"result":{"description":"The Task Result of the Alert.","type":"array","items":{"properties":{"name":{"description":"The name of the Task Result for the Alert action.","type":"string"},"workflowName":{"description":"The name of the Workflow used in the Alert action task result.","type":"string","example":"LCM Provisioning"},"notifications":{"description":"Notifications to send when a Alert action is generated.","type":"array","items":{"properties":{"name":{"description":"The name of configured notifications for Alert action results.","type":"string","example":"lowLevelAlertNotification"},"displayName":{"description":"Display name for the Alert action notification.","type":"string","example":"lowLevelAlert result notification"},"emailAddresses":{"description":"A list of email addresses to send an Alert action notification.","type":"string","example":"amanda.ross@demoexample.com, alice.ford@demoexample.com"}}}}}}}}}},"alertDate":{"description":"The Alert DateTime, this could have different meanings based on the type of alert.","type":"string","format":"date-time","example":"2022-03-31T14:52:40.265-05:00"},"lastProcessed":{"description":"The DateTime of the last time the alert was processed, this does not indicate the system took action on the Alert.","type":"string","format":"date-time","example":"2022-03-31T14:52:40.260-05:00"},"nativeId":{"description":"Unique Identifier of the Alert in the native system.","type":"string","example":"420bebfb-c87a-406f-930c-29e06feb47bc"},"targetId":{"description":"Unique Identifier of the target object which caused the Alert.","type":"string","example":"c0a8019c7fe51750817fe634a6b10171"},"targetType":{"description":"The type of SailPointObject the target is.","type":"string","example":"Certification"},"targetDisplayName":{"description":"User friendly display name of the target object.","type":"string","example":"Manager Certification"},"meta":{"description":"Metadata for the Alert.","type":"array","items":{"properties":{"created":{"description":"DateTime when the Alert was created.","type":"string","format":"date-time","example":"2022-03-31T14:52:40.245-05:00"},"location":{"description":"URL to the Alert.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Alerts/c0a8019c7fe11678817fe18984351477"},"lastModified":{"description":"DateTime of Alert last modification.","type":"string","format":"date-time","example":"2022-03-31T14:52:40.265-05:00"},"version":{"description":"Alert version.","type":"string","example":"W\"1650050901217\""},"resourceType":{"description":"Resource type of the metadata subject.","type":"string","example":"Alert"}}}},"schemas":{"description":"A list of the schemas used for Alerts.","type":"array","items":{"type":"string","example":["urn:ietf:params:scim:schemas:sailpoint:1.0:AlertInput","urn:ietf:params:scim:schemas:sailpoint:1.0:Alert"]}}}}}}}}}}},"method":"get","path":"/Alerts","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns all Alert resources.","description":{"content":"This endpoint returns all Alert resources.

      \nAttributes to include in the response can be specified with the 'attributes' query parameter.

      \nAttributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

      \nThe schemas related to Alerts are:\n- **urn:ietf:params:scim:schemas:core:1.0:Alert**\n- **urn:ietf:params:scim:schemas:core:1.0:AlertInput**\n","type":"text/plain"},"url":{"path":["Alerts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.","type":"text/plain"},"key":"filter","value":""},{"disabled":false,"description":{"content":"Set to true if the Alert name is passed instead of the Alert id.","type":"text/plain"},"key":"lookupByName","value":""},{"disabled":false,"description":{"content":"Allows sorting the results by a resource's attributes.","type":"text/plain"},"key":"sortBy","value":""},{"disabled":false,"description":{"content":"Determines what order to sort results in.","type":"text/plain"},"key":"sortOrder","value":""},{"disabled":false,"description":{"content":"Determines the starting index of the result set.","type":"text/plain"},"key":"startIndex","value":""},{"disabled":false,"description":{"content":"Specifies the number of results per page.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns all Alert resources.' (get-alerts)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns all Alert resources. + + + +This endpoint returns all Alert resources.

      +Attributes to include in the response can be specified with the 'attributes' query parameter.

      +Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

      +The schemas related to Alerts are: +- **urn:ietf:params:scim:schemas:core:1.0:Alert** +- **urn:ietf:params:scim:schemas:core:1.0:AlertInput** + + +
      Query Parameters
      + +Returned all SCIM resources for this endpoint. + +
      Schema
        Resources undefined[]
        attributes undefined[]
        + +A list of attributes of the Alert. + +
        application object
        + +The corresponding Application object of the Alert. + +
        actions undefined[]
        + +Not empty if action was taken on the Alert. + +
        result undefined[]
        + +The Task Result of the Alert. + +
        notifications undefined[]
        + +Notifications to send when a Alert action is generated. + +
        meta undefined[]
        + +Metadata for the Alert. + +
      Schema
        Resources undefined[]
        + +The SCIM resources returned for this endpoint. + +
        attributes undefined[]
        + +A list of attributes of the Alert. + +
        application object
        + +The corresponding Application object of the Alert. + +
        actions undefined[]
        + +Not empty if action was taken on the Alert. + +
        result undefined[]
        + +The Task Result of the Alert. + +
        notifications undefined[]
        + +Notifications to send when a Alert action is generated. + +
        meta undefined[]
        + +Metadata for the Alert. + +
      \ No newline at end of file diff --git a/products/iiq/api/get-application.api.mdx b/products/iiq/api/get-application.api.mdx new file mode 100644 index 000000000..95b0d3b8b --- /dev/null +++ b/products/iiq/api/get-application.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-application +sidebar_label: Returns an Application resource based on id or name. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getApplication","tags":["Applications"],"description":"The Application resource with matching id or name is returned. Attributes to include in the response can be specified with the 'attributes' query parameter. \nAttributes to exclude from the response can be specified with the 'excludedAttributes' query parameter. \nThe schema related to Application is: \n- **urn:ietf:params:scim:schemas:sailpoint:1.0:Application.**\n","parameters":[{"name":"applicationId","in":"path","schema":{"type":"string","example":"7f00000180281df7818028bfaae8035b"},"description":"id or name of Application resource.","required":true},{"in":"query","name":"attributes","schema":{"type":"string","example":"name,type,features"},"description":"The Application attributes to include in the response. The query parameter value is a comma-separated list of fields to be returned in the response for each Application. The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for an Application."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"features"},"description":"The Application attributes to exclude frome the response. The query parameter value is a comma-separated list of fields to be excluded from the response for each Application. The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for an Application."}],"responses":{"200":{"description":"Returns a single Application resource based on the id.","content":{"application/json":{"schema":{"properties":{"id":{"description":"IdentityIQ id of the Application.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"name":{"description":"Unique name for the Application. This name MUST be unique across the entire set of Applications.","type":"string","example":"Active Directory"},"descriptions":{"description":"A list of localized descriptions of the Application.","type":"array","example":[{"locale":"en_US","value":"The main Active_Directory domain data for the corporate network."}]},"type":{"description":"The type of the Application.","type":"string","example":"Active Directory - Direct"},"features":{"description":"A list of features of the Application.","type":"array","example":[["DIRECT_PERMISSIONS","NO_RANDOM_ACCESS","DISCOVER_SCHEMA"]]},"owner":{"description":"The owner of the Application.","type":"object","properties":{"displayName":{"description":"Display name of the application owner.","type":"string","example":"Joe Smith"},"value":{"description":"id of the application owner.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"$ref":{"description":"URI reference of the application owner resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"}}},"applicationSchemas":{"description":"List of the Application Schemas.","type":"object","properties":{"value":{"description":"The urn of the Application Schema.","type":"string","example":"urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Active Directory:account"},"type":{"description":"The type of Application Schema (account, group, etc.).","type":"string","example":"account"},"$ref":{"description":"The URI of the SCIM resource representing the Entitlement.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Schemas/urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Active%20Directory:account"}}},"meta":{"description":"Metadata of the SCIM resource.","properties":{"created":{"description":"Datetime this Application was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the SCIM resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Applications/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the Application was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the SCIM resource.","type":"string","example":"W\"1644561244074\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"Application"},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:Application"]}}}}}}}}},"method":"get","path":"/Applications/{applicationId}","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns an Application resource based on id or name.","description":{"content":"The Application resource with matching id or name is returned. Attributes to include in the response can be specified with the 'attributes' query parameter. \nAttributes to exclude from the response can be specified with the 'excludedAttributes' query parameter. \nThe schema related to Application is: \n- **urn:ietf:params:scim:schemas:sailpoint:1.0:Application.**\n","type":"text/plain"},"url":{"path":["Applications",":applicationId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The Application attributes to include in the response. The query parameter value is a comma-separated list of fields to be returned in the response for each Application. The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for an Application.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"The Application attributes to exclude frome the response. The query parameter value is a comma-separated list of fields to be excluded from the response for each Application. The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for an Application.","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) id or name of Application resource.","type":"text/plain"},"type":"any","value":"","key":"applicationId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns an Application resource based on id or name.' (get-application)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns an Application resource based on id or name. + + + +The Application resource with matching id or name is returned. Attributes to include in the response can be specified with the 'attributes' query parameter. +Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter. +The schema related to Application is: +- **urn:ietf:params:scim:schemas:sailpoint:1.0:Application.** + + +
      Path Parameters
      Query Parameters
      + +Returns a single Application resource based on the id. + +
      Schema
        owner object
        + +The owner of the Application. + +
        applicationSchemas object
        + +List of the Application Schemas. + +
        meta
        + +Metadata of the SCIM resource. + +
      \ No newline at end of file diff --git a/products/iiq/api/get-applications.api.mdx b/products/iiq/api/get-applications.api.mdx new file mode 100644 index 000000000..99fca264d --- /dev/null +++ b/products/iiq/api/get-applications.api.mdx @@ -0,0 +1,64 @@ +--- +id: get-applications +sidebar_label: Returns all Application resources. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getApplications","tags":["Applications"],"description":"This endpoint returns all Application resources.

      \nAttributes to include in the response can be specified with the 'attributes' query parameter.

      \nAttributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

      \nThe schema related to Applications is: \n- **urn:ietf:params:scim:schemas:core:1.0:Application**\n","parameters":[{"in":"query","name":"filter","schema":{"type":"string","example":"type eq \"Active Directory - Direct\""},"description":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported."},{"in":"query","name":"lookupByName","schema":{"type":"boolean","default":false,"example":true}},{"in":"query","name":"sortBy","schema":{"type":"string","example":"name"},"description":"Allows sorting the results by a resource's attributes."},{"in":"query","name":"sortOrder","schema":{"type":"string","default":"ascending","example":"descending"},"description":"Determines what order to sort results in."},{"in":"query","name":"startIndex","schema":{"type":"integer","example":10,"default":1},"description":"Determines the starting index of the result set."},{"in":"query","name":"count","schema":{"type":"integer","example":10,"default":1},"description":"Specifies the number of results per page."},{"in":"query","name":"attributes","schema":{"type":"string","example":"name,type,features"},"description":"The Application attributes to include in the response. The query parameter value is a comma-separated list of fields to be returned in the response for each Application. The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for an Application."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"features"},"description":"The Application attributes to exclude frome the response. The query parameter value is a comma-separated list of fields to be excluded from the response for each Application. The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for an Application."}],"responses":{"200":{"description":"Returns all SCIM Application resources.","content":{"application/json":{"schema":{"properties":{"totalResults":{"description":"Number of Application resources returned.","type":"integer","example":"18,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"type":"array","items":{"properties":{"id":{"description":"IdentityIQ id of the Application.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"name":{"description":"Unique name for the Application. This name MUST be unique across the entire set of Applications.","type":"string","example":"Active Directory"},"descriptions":{"description":"A list of localized descriptions of the Application.","type":"array","example":[{"locale":"en_US","value":"The main Active_Directory domain data for the corporate network."}]},"type":{"description":"The type of the Application.","type":"string","example":"Active Directory - Direct"},"features":{"description":"A list of features of the Application.","type":"array","example":[["DIRECT_PERMISSIONS","NO_RANDOM_ACCESS","DISCOVER_SCHEMA"]]},"owner":{"description":"The owner of the Application.","type":"object","properties":{"displayName":{"description":"Display name of the application owner.","type":"string","example":"Joe Smith"},"value":{"description":"id of the application owner.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"$ref":{"description":"URI reference of the application owner resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"}}},"applicationSchemas":{"description":"List of the Application Schemas.","type":"object","properties":{"value":{"description":"The urn of the Application Schema.","type":"string","example":"urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Active Directory:account"},"type":{"description":"The type of Application Schema (account, group, etc.).","type":"string","example":"account"},"$ref":{"description":"The URI of the SCIM resource representing the Entitlement.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Schemas/urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Active%20Directory:account"}}},"meta":{"description":"Metadata of the SCIM resource.","properties":{"created":{"description":"Datetime this Application was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the SCIM resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Applications/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the Application was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the SCIM resource.","type":"string","example":"W\"1644561244074\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"Application"},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:Application"]}}}}}}}}},"application/scim+json":{"schema":{"properties":{"totalResults":{"description":"Number of Application resources returned.","type":"integer","example":"1500,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"description":"The SCIM resources returned for this endpoint.","type":"array","items":{"properties":{"id":{"description":"IdentityIQ id of the Application.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"name":{"description":"Unique name for the Application. This name MUST be unique across the entire set of Applications.","type":"string","example":"Active Directory"},"descriptions":{"description":"A list of localized descriptions of the Application.","type":"array","example":[{"locale":"en_US","value":"The main Active_Directory domain data for the corporate network."}]},"type":{"description":"The type of the Application.","type":"string","example":"Active Directory - Direct"},"features":{"description":"A list of features of the Application.","type":"array","example":[["DIRECT_PERMISSIONS","NO_RANDOM_ACCESS","DISCOVER_SCHEMA"]]},"owner":{"description":"The owner of the Application.","type":"object","properties":{"displayName":{"description":"Display name of the application owner.","type":"string","example":"Joe Smith"},"value":{"description":"id of the application owner.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"$ref":{"description":"URI reference of the application owner resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"}}},"applicationSchemas":{"description":"List of the Application Schemas.","type":"object","properties":{"value":{"description":"The urn of the Application Schema.","type":"string","example":"urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Active Directory:account"},"type":{"description":"The type of Application Schema (account, group, etc.).","type":"string","example":"account"},"$ref":{"description":"The URI of the SCIM resource representing the Entitlement.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Schemas/urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Active%20Directory:account"}}},"meta":{"description":"Metadata of the SCIM resource.","properties":{"created":{"description":"Datetime this Application was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the SCIM resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Applications/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the Application was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the SCIM resource.","type":"string","example":"W\"1644561244074\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"Application"},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:Application"]}}}}}}}}}}}},"method":"get","path":"/Applications","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns all Application resources.","description":{"content":"This endpoint returns all Application resources.

      \nAttributes to include in the response can be specified with the 'attributes' query parameter.

      \nAttributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

      \nThe schema related to Applications is: \n- **urn:ietf:params:scim:schemas:core:1.0:Application**\n","type":"text/plain"},"url":{"path":["Applications"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.","type":"text/plain"},"key":"filter","value":""},{"disabled":false,"key":"lookupByName","value":""},{"disabled":false,"description":{"content":"Allows sorting the results by a resource's attributes.","type":"text/plain"},"key":"sortBy","value":""},{"disabled":false,"description":{"content":"Determines what order to sort results in.","type":"text/plain"},"key":"sortOrder","value":""},{"disabled":false,"description":{"content":"Determines the starting index of the result set.","type":"text/plain"},"key":"startIndex","value":""},{"disabled":false,"description":{"content":"Specifies the number of results per page.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"The Application attributes to include in the response. The query parameter value is a comma-separated list of fields to be returned in the response for each Application. The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for an Application.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"The Application attributes to exclude frome the response. The query parameter value is a comma-separated list of fields to be excluded from the response for each Application. The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for an Application.","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns all Application resources.' (get-applications)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns all Application resources. + + + +This endpoint returns all Application resources.

      +Attributes to include in the response can be specified with the 'attributes' query parameter.

      +Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

      +The schema related to Applications is: +- **urn:ietf:params:scim:schemas:core:1.0:Application** + + +
      Query Parameters
      + +Returns all SCIM Application resources. + +
      Schema
        Resources undefined[]
        owner object
        + +The owner of the Application. + +
        applicationSchemas object
        + +List of the Application Schemas. + +
        meta
        + +Metadata of the SCIM resource. + +
      Schema
        Resources undefined[]
        + +The SCIM resources returned for this endpoint. + +
        owner object
        + +The owner of the Application. + +
        applicationSchemas object
        + +List of the Application Schemas. + +
        meta
        + +Metadata of the SCIM resource. + +
      \ No newline at end of file diff --git a/products/iiq/api/get-entitlement-by-id.api.mdx b/products/iiq/api/get-entitlement-by-id.api.mdx new file mode 100644 index 000000000..1c76c60ae --- /dev/null +++ b/products/iiq/api/get-entitlement-by-id.api.mdx @@ -0,0 +1,58 @@ +--- +id: get-entitlement-by-id +sidebar_label: Returns an Entitlement resource based on id. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getEntitlementById","tags":["Entitlements"],"description":"The Entitlement resource with matching id is returned.

      \nAttributes to include in the response can be specified with the attributes query parameter.

      \nAttributes to exclude from the response can be specified with the excludedAttributes query parameter.

      \n","parameters":[{"name":"entitlementId","in":"path","schema":{"type":"string","example":"c0a8019c802d1e5a81802eb2b57e020f"},"description":"id of Entitlement resource.","required":true},{"in":"query","name":"attributes","schema":{"type":"string","example":"application"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"name, application"},"description":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**"}],"responses":{"200":{"description":"Returns a single Entitlement resource based on the id.","content":{"application/json":{"schema":{"properties":{"id":{"description":"Unique identifier of the Entitlement.","type":"string","example":"7f00000180281df7818028bfb7d204c1"},"descriptions":{"description":"A list of localized descriptions of the Entitlement.","type":"object","properties":{"locale":{"description":"The locale associated with this Entitlement description.","type":"string","example":"en_US"},"value":{"description":"The description in localized form.","type":"string","example":"**Employee Database** target friendly description"}}},"displayableName":{"description":"Displayable name of the Entitlement.","type":"string","example":"a2a"},"type":{"description":"Type of the Entitlement.","type":"string","example":"group"},"application":{"description":"The corresponding Application object of the Entitlement.","type":"array","items":{"properties":{"value":{"description":"The Application associated with the Entitlement.","type":"string","example":"7f00000180281df7818028bfed100826"},"$ref":{"description":"The URI of the SCIM resource representating the Entitlement application.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826"},"displayName":{"description":"The name of the Entitlement Application. OPTIONAL and READ-ONLY.","type":"string","example":"SAP"}}}},"owner":{"description":"The owner of the Entitlement.","type":"array","items":{"properties":{"value":{"description":"The id of the SCIM resource representing the Entitlement Owner.","type":"string","example":"7f00000180281df7818028bfab930361"},"$ref":{"description":"The URI of the SCIM resource representing the Entitlement Owner.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Users/7f00000180281df7818028bfab930361"},"displayName":{"description":"The displayName of the Entitlement Owner. OPTIONAL and READ-ONLY.","type":"string","example":"Mary Johnson"}}}},"requestable":{"description":"Flag to indicate this entitlement is requestable.","type":"boolean","example":true},"aggregated":{"description":"Flag to indicate this entitlement has been aggregated.","type":"boolean","example":true},"attribute":{"description":"Attribute of the Entitlement.","type":"string","example":"memberOf"},"value":{"description":"Attribute value of the Entitlement.","type":"string","example":"CN=a2a,OU=HierarchicalGroups,OU=DemoData,DC=test,DC=sailpoint,DC=com"},"lastRefresh":{"description":"The DateTime when the Entitlement was refreshed.","format":"date-time","type":"string","example":"2022-04-14T10:48:01.907-05:00"},"lastTargetAggregation":{"description":"The date aggregation was last targeted of the Entitlement.","type":"string","format":"date-time","example":"2022-04-14T10:48:01.907-05:00"},"classifications":{"description":"Classifications of this Entitlement.","type":"object","required":["classification"],"properties":{"source":{"description":"The source of the ObjectClassification.","type":"string","example":"UI"},"effective":{"description":"Flag indicating this is an effective Classification.","type":"boolean","example":false},"classification":{"description":"Classification of this object.","type":"object","properties":{"name":{"description":"The name of the Classification.","type":"string","example":"ClassificationA"},"displayName":{"description":"The displayName of the Classification.","type":"string","example":"ClassA"},"origin":{"description":"The origin of the Classification.","type":"string","example":"FAM Aggregation"},"type":{"description":"The type of the Classification.","type":"string","example":"Aggregation"}}}}},"meta":{"type":"object","properties":{"created":{"description":"DateTime when the Entitlement was created.","type":"string","format":"date-time","example":"2022-04-05T15:52:30.090-05:00"},"location":{"description":"URL to the Entitlement.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Entitlements/c0a8019c7ffa186e817ffb80170a0195"},"lastModified":{"description":"DateTime of Entitlement last modification.","type":"string","format":"date-time","example":"2022-04-05T15:52:30.119-05:00"},"version":{"description":"Entitlement version.","type":"string","example":"\"W\"1649191950119\""},"resourceType":{"description":"Resource type of the metadata subject.","type":"string","example":"Entitlement"}}},"schemas":{"type":"array","example":["urn:ietf:params:scim:schemas:sailpoint:1.0:Entitlement"]},"entitleAuth":{"description":"This is an Extended Attribute from Managed Attribute used to describe the authorization level of an Entitlement.","type":"string","example":"None"},"entDate":{"description":"This is an Extended Attribute from Managed Attribute. The Entitlement DateTime.","type":"string","format":"date-time","example":"2022-04-14T10:44:54.738-05:00"},"active":{"description":"This is an Extended Attribute from Managed Attribute. Describes if an Entitlement is active.","type":"boolean","example":false},"rank":{"description":"This is an Extended Attribute from Managed Attribute.","type":"integer","example":3},"rule":{"description":"This is an Extended Attribute from Managed Attribute. Used to specify a Rule object for the Entitlement.","type":"string","example":"APLogin-Contractors-Rule"},"reviewer":{"description":"This is an Extended Attribute from Managed Attribute. The Identity that reviewed the Entitlement.","type":"object","properties":{"displayName":{"description":"Display name of the Entitlement reviewer.","type":"string","example":"Caroline Lee"},"value":{"description":"id of the Entitlement reviewer.","type":"string","example":"c0b4568a4fe7458c434ee77f2fad267c"},"$ref":{"description":"URI reference of the Entitlement reviewer resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Users/c0b4568a4fe7458c434ee77f2fad267c"}}},"emails":{"description":"This is an Extended Attribute from Managed Attribute. Used to specify the Entitlement owner email.","type":"string","example":"clee@demoexample.com"}}}}}}},"method":"get","path":"/Entitlements/{entitlementId}","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns an Entitlement resource based on id.","description":{"content":"The Entitlement resource with matching id is returned.

      \nAttributes to include in the response can be specified with the attributes query parameter.

      \nAttributes to exclude from the response can be specified with the excludedAttributes query parameter.

      \n","type":"text/plain"},"url":{"path":["Entitlements",":entitlementId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) id of Entitlement resource.","type":"text/plain"},"type":"any","value":"","key":"entitlementId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns an Entitlement resource based on id.' (get-entitlement-by-id)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns an Entitlement resource based on id. + + + +The Entitlement resource with matching id is returned.

      +Attributes to include in the response can be specified with the attributes query parameter.

      +Attributes to exclude from the response can be specified with the excludedAttributes query parameter.

      + + +
      Path Parameters
      Query Parameters
      + +Returns a single Entitlement resource based on the id. + +
      Schema
        descriptions object
        + +A list of localized descriptions of the Entitlement. + +
        application undefined[]
        + +The corresponding Application object of the Entitlement. + +
        owner undefined[]
        + +The owner of the Entitlement. + +
        classifications object
        + +Classifications of this Entitlement. + +
        classification object
        + +Classification of this object. + +
        meta object
        reviewer object
        + +This is an Extended Attribute from Managed Attribute. The Identity that reviewed the Entitlement. + +
      **Employee Database** target friendly description\"\n },\n \"displayableName\": \"a2a\",\n \"type\": \"group\",\n \"application\": [\n {\n \"value\": \"7f00000180281df7818028bfed100826\",\n \"$ref\": \"http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826\",\n \"displayName\": \"SAP\"\n }\n ],\n \"owner\": [\n {\n \"value\": \"7f00000180281df7818028bfab930361\",\n \"$ref\": \"http://localhost:8080/identityiq/scim/v2/Users/7f00000180281df7818028bfab930361\",\n \"displayName\": \"Mary Johnson\"\n }\n ],\n \"requestable\": true,\n \"aggregated\": true,\n \"attribute\": \"memberOf\",\n \"value\": \"CN=a2a,OU=HierarchicalGroups,OU=DemoData,DC=test,DC=sailpoint,DC=com\",\n \"lastRefresh\": \"2022-04-14T10:48:01.907-05:00\",\n \"lastTargetAggregation\": \"2022-04-14T10:48:01.907-05:00\",\n \"classifications\": {\n \"source\": \"UI\",\n \"effective\": false,\n \"classification\": {\n \"name\": \"ClassificationA\",\n \"displayName\": \"ClassA\",\n \"origin\": \"FAM Aggregation\",\n \"type\": \"Aggregation\"\n }\n },\n \"meta\": {\n \"created\": \"2022-04-05T15:52:30.090-05:00\",\n \"location\": \"http://localhost:8080/identityiq/scim/v2/Entitlements/c0a8019c7ffa186e817ffb80170a0195\",\n \"lastModified\": \"2022-04-05T15:52:30.119-05:00\",\n \"version\": \"\\\"W\\\"1649191950119\\\"\",\n \"resourceType\": \"Entitlement\"\n },\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:sailpoint:1.0:Entitlement\"\n ],\n \"entitleAuth\": \"None\",\n \"entDate\": \"2022-04-14T10:44:54.738-05:00\",\n \"active\": false,\n \"rank\": 3,\n \"rule\": \"APLogin-Contractors-Rule\",\n \"reviewer\": {\n \"displayName\": \"Caroline Lee\",\n \"value\": \"c0b4568a4fe7458c434ee77f2fad267c\",\n \"$ref\": \"http://localhost:8080/identityiq/scim/v2/Users/c0b4568a4fe7458c434ee77f2fad267c\"\n },\n \"emails\": \"clee@demoexample.com\"\n}"} language={"json"}>
      \ No newline at end of file diff --git a/products/iiq/api/get-entitlements.api.mdx b/products/iiq/api/get-entitlements.api.mdx new file mode 100644 index 000000000..0f625fc39 --- /dev/null +++ b/products/iiq/api/get-entitlements.api.mdx @@ -0,0 +1,88 @@ +--- +id: get-entitlements +sidebar_label: Returns all Entitlement resources. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getEntitlements","tags":["Entitlements"],"description":"This endpoint returns all Entitlement resources.

      \nAttributes to include in the response can be specified with the 'attributes' query parameter.

      \nAttributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

      \nThe schemas related to Entitlements are:\n- **urn:ietf:params:scim:schemas:sailpoint:1.0:Entitlement**\n","parameters":[{"in":"query","name":"filter","schema":{"type":"string","example":"displayableName eq \"accessLog\""},"description":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported."},{"in":"query","name":"sortBy","schema":{"type":"string","example":"application"},"description":"Allows sorting the results by a resource's attributes."},{"in":"query","name":"sortOrder","schema":{"type":"string","default":"ascending","example":"descending"},"description":"Determines what order to sort results in."},{"in":"query","name":"startIndex","schema":{"type":"integer","example":10,"default":1},"description":"Determines the starting index of the result set."},{"in":"query","name":"count","schema":{"type":"integer","example":10,"default":1000},"description":"Specifies the number of results per page."},{"in":"query","name":"attributes","schema":{"type":"string","example":"application"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"application"},"description":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**"}],"responses":{"200":{"description":"Returned all SCIM resources for this endpoint.","content":{"application/json":{"schema":{"properties":{"totalResults":{"description":"Number of resources returned for this endpoint.","type":"integer","example":"1,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"type":"array","items":{"properties":{"id":{"description":"Unique identifier of the Entitlement.","type":"string","example":"7f00000180281df7818028bfb83204dc"},"descriptions":{"description":"A list of localized descriptions of the Entitlement.","type":"object","properties":{"locale":{"description":"The locale associated with this Entitlement description.","type":"string","example":"en_GB"},"value":{"description":"The description in localized form.","type":"string","example":"**AP_Logins** Target Friendly Description"}}},"displayName":{"description":"Displayable name of the Entitlement.","type":"string","example":"AP_Logins"},"type":{"description":"Type of the Entitlement.","type":"string","example":"Permission"},"application":{"description":"The corresponding Application object of the Entitlement.","type":"array","items":{"properties":{"value":{"description":"The Application associated with the Entitlement.","type":"string","example":"7f00000180281df7818028bfac5a0367"},"$ref":{"description":"The URI of the SCIM resource representating the Entitlement application.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826"},"displayName":{"description":"The name of the Entitlement Application. OPTIONAL and READ-ONLY.","type":"string","example":"Oracle_DB_oasis"}}}},"owner":{"description":"The owner of the Entitlement.","type":"array","items":{"properties":{"value":{"description":"The id of the SCIM resource representing the Entitlement Owner.","type":"string","example":"7f00000180281df7818028bfb0d103c7"},"$ref":{"description":"The URI of the SCIM resource representing the Entitlement Owner.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Users/7f00000180281df7818028bfb0d103c7"},"displayName":{"description":"The displayName of the Entitlement Owner. OPTIONAL and READ-ONLY.","type":"string","example":"Debra Wood"}}}},"requestable":{"description":"Flag to indicate this entitlement is requestable.","type":"boolean","example":true},"aggregated":{"description":"Flag to indicate this entitlement has been aggregated.","type":"boolean","example":true},"attribute":{"description":"Attribute of the Entitlement.","type":"string","example":"AP_Logins"},"value":{"description":"Attribute value of the Entitlement.","type":"string","example":"CN=AP_Logins,OU=Security,OU=Permissions,DC=test,DC=sailpoint,DC=com"},"lastRefresh":{"description":"The DateTime when the Entitlement was refreshed.","type":"string","format":"date-time","example":"2022-04-14T10:48:01.907-05:00"},"lastTargetAggregation":{"description":"The date aggregation was last targeted of the Entitlement.","type":"string","format":"date-time","example":"2022-04-14T10:48:01.907-05:00"},"classifications":{"description":"Classifications of this Entitlement.","type":"object","required":["classification"],"properties":{"source":{"description":"The source of the ObjectClassification.","type":"string","example":"UI"},"effective":{"description":"Flag indicating this is an effective Classification.","type":"boolean","example":false},"classification":{"description":"Classification of this object.","type":"object","properties":{"name":{"description":"The name of the classification.","type":"string","example":"ClassificationB"},"displayName":{"description":"The display name of the classification.","type":"string","example":"ClassB"},"origin":{"description":"The origin of the Classification.","type":"string","example":"PAMSource"},"type":{"description":"The type of the Classification.","type":"string","example":"Aggregation"}}}}},"meta":{"type":"object","properties":{"created":{"description":"DateTime when the Entitlement was created.","type":"string","format":"date-time","example":"2022-04-14T10:44:54.834-05:00"},"location":{"description":"URL to the Entitlement.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Entitlements/7f00000180281df7818028bfb83204dc"},"lastModified":{"description":"DateTime of Entitlement last modification.","type":"string","format":"date-time","example":"2022-04-05T15:52:30.119-05:00"},"version":{"description":"Entitlement version.","type":"string","example":"\"W\"1649951094834\""},"resourceType":{"description":"Resource type of the metadata subject.","type":"string","example":"Entitlement"}}},"schemas":{"type":"array","example":["urn:ietf:params:scim:schemas:sailpoint:1.0:Entitlement"]},"entitleAuth":{"description":"This is an Extended Attribute from Managed Attribute used to describe the authorization level of an Entitlement.","type":"string","example":"Low"},"entDate":{"description":"This is an Extended Attribute from Managed Attribute. The Entitlement DateTime.","type":"string","format":"date-time","example":"2022-04-14T10:44:54.738-05:00"},"active":{"description":"This is an Extended Attribute from Managed Attribute. Describes if an Entitlement is active.","type":"boolean","example":false},"rank":{"description":"This is an Extended Attribute from Managed Attribute.","type":"integer","example":3},"rule":{"description":"This is an Extended Attribute from Managed Attribute. Used to specify a Rule object for the Entitlement.","type":"string","example":"APLogin-Contractors-Rule"},"reviewer":{"description":"This is an Extended Attribute from Managed Attribute. The Identity that reviewed the Entitlement.","type":"object","properties":{"displayName":{"description":"Display name of the Entitlement reviewer.","type":"string","example":"Dan Patrick"},"value":{"description":"id of the Entitlement reviewer.","type":"string","example":"c0b4568a4fe7458c434ee77f2fad267c"},"$ref":{"description":"URI reference of the Entitlement reviewer resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Users/c0b4568a4fe7458c434ee77f2fad267c"}}},"email":{"description":"This is an Extended Attribute from Managed Attribute. Used to specify the Entitlement owner email.","type":"string","example":"dpatrick@demoexample.com"}}}}}}},"application/scim+json":{"schema":{"properties":{"totalResults":{"description":"Number of Entitlement resources returned.","type":"integer","example":"1500,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"description":"The SCIM resources returned for this endpoint.","type":"array","items":{"properties":{"id":{"description":"Unique identifier of the Entitlement.","type":"string","example":"7f00000180281df7818028bfb83204dc"},"descriptions":{"description":"A list of localized descriptions of the Entitlement.","type":"object","properties":{"locale":{"description":"The locale associated with this Entitlement description.","type":"string","example":"en_GB"},"value":{"description":"The description in localized form.","type":"string","example":"**AP_Logins** Target Friendly Description"}}},"displayName":{"description":"Displayable name of the Entitlement.","type":"string","example":"AP_Logins"},"type":{"description":"Type of the Entitlement.","type":"string","example":"Permission"},"application":{"description":"The corresponding Application object of the Entitlement.","type":"array","items":{"properties":{"value":{"description":"The Application associated with the Entitlement.","type":"string","example":"7f00000180281df7818028bfac5a0367"},"$ref":{"description":"The URI of the SCIM resource representating the Entitlement application.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826"},"displayName":{"description":"The name of the Entitlement Application. OPTIONAL and READ-ONLY.","type":"string","example":"Oracle_DB_oasis"}}}},"owner":{"description":"The owner of the Entitlement.","type":"array","items":{"properties":{"value":{"description":"The id of the SCIM resource representing the Entitlement Owner.","type":"string","example":"7f00000180281df7818028bfb0d103c7"},"$ref":{"description":"The URI of the SCIM resource representing the Entitlement Owner.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Users/7f00000180281df7818028bfb0d103c7"},"displayName":{"description":"The displayName of the Entitlement Owner. OPTIONAL and READ-ONLY.","type":"string","example":"Debra Wood"}}}},"requestable":{"description":"Flag to indicate this entitlement is requestable.","type":"boolean","example":true},"aggregated":{"description":"Flag to indicate this entitlement has been aggregated.","type":"boolean","example":true},"attribute":{"description":"Attribute of the Entitlement.","type":"string","example":"AP_Logins"},"value":{"description":"Attribute value of the Entitlement.","type":"string","example":"CN=AP_Logins,OU=Security,OU=Permissions,DC=test,DC=sailpoint,DC=com"},"lastRefresh":{"description":"The DateTime when the Entitlement was refreshed.","type":"string","format":"date-time","example":"2022-04-14T10:48:01.907-05:00"},"lastTargetAggregation":{"description":"The date aggregation was last targeted of the Entitlement.","type":"string","format":"date-time","example":"2022-04-14T10:48:01.907-05:00"},"classifications":{"description":"Classifications of this Entitlement.","type":"object","required":["classification"],"properties":{"source":{"description":"The source of the ObjectClassification.","type":"string","example":"UI"},"effective":{"description":"Flag indicating this is an effective Classification.","type":"boolean","example":false},"classification":{"description":"Classification of this object.","type":"object","properties":{"name":{"description":"The name of the classification.","type":"string","example":"ClassificationB"},"displayName":{"description":"The display name of the classification.","type":"string","example":"ClassB"},"origin":{"description":"The origin of the Classification.","type":"string","example":"PAMSource"},"type":{"description":"The type of the Classification.","type":"string","example":"Aggregation"}}}}},"meta":{"type":"object","properties":{"created":{"description":"DateTime when the Entitlement was created.","type":"string","format":"date-time","example":"2022-04-14T10:44:54.834-05:00"},"location":{"description":"URL to the Entitlement.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Entitlements/7f00000180281df7818028bfb83204dc"},"lastModified":{"description":"DateTime of Entitlement last modification.","type":"string","format":"date-time","example":"2022-04-05T15:52:30.119-05:00"},"version":{"description":"Entitlement version.","type":"string","example":"\"W\"1649951094834\""},"resourceType":{"description":"Resource type of the metadata subject.","type":"string","example":"Entitlement"}}},"schemas":{"type":"array","example":["urn:ietf:params:scim:schemas:sailpoint:1.0:Entitlement"]},"entitleAuth":{"description":"This is an Extended Attribute from Managed Attribute used to describe the authorization level of an Entitlement.","type":"string","example":"Low"},"entDate":{"description":"This is an Extended Attribute from Managed Attribute. The Entitlement DateTime.","type":"string","format":"date-time","example":"2022-04-14T10:44:54.738-05:00"},"active":{"description":"This is an Extended Attribute from Managed Attribute. Describes if an Entitlement is active.","type":"boolean","example":false},"rank":{"description":"This is an Extended Attribute from Managed Attribute.","type":"integer","example":3},"rule":{"description":"This is an Extended Attribute from Managed Attribute. Used to specify a Rule object for the Entitlement.","type":"string","example":"APLogin-Contractors-Rule"},"reviewer":{"description":"This is an Extended Attribute from Managed Attribute. The Identity that reviewed the Entitlement.","type":"object","properties":{"displayName":{"description":"Display name of the Entitlement reviewer.","type":"string","example":"Dan Patrick"},"value":{"description":"id of the Entitlement reviewer.","type":"string","example":"c0b4568a4fe7458c434ee77f2fad267c"},"$ref":{"description":"URI reference of the Entitlement reviewer resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Users/c0b4568a4fe7458c434ee77f2fad267c"}}},"email":{"description":"This is an Extended Attribute from Managed Attribute. Used to specify the Entitlement owner email.","type":"string","example":"dpatrick@demoexample.com"}}}}}}}}}},"method":"get","path":"/Entitlements","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns all Entitlement resources.","description":{"content":"This endpoint returns all Entitlement resources.

      \nAttributes to include in the response can be specified with the 'attributes' query parameter.

      \nAttributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

      \nThe schemas related to Entitlements are:\n- **urn:ietf:params:scim:schemas:sailpoint:1.0:Entitlement**\n","type":"text/plain"},"url":{"path":["Entitlements"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.","type":"text/plain"},"key":"filter","value":""},{"disabled":false,"description":{"content":"Allows sorting the results by a resource's attributes.","type":"text/plain"},"key":"sortBy","value":""},{"disabled":false,"description":{"content":"Determines what order to sort results in.","type":"text/plain"},"key":"sortOrder","value":""},{"disabled":false,"description":{"content":"Determines the starting index of the result set.","type":"text/plain"},"key":"startIndex","value":""},{"disabled":false,"description":{"content":"Specifies the number of results per page.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns all Entitlement resources.' (get-entitlements)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns all Entitlement resources. + + + +This endpoint returns all Entitlement resources.

      +Attributes to include in the response can be specified with the 'attributes' query parameter.

      +Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

      +The schemas related to Entitlements are: +- **urn:ietf:params:scim:schemas:sailpoint:1.0:Entitlement** + + +
      Query Parameters
      + +Returned all SCIM resources for this endpoint. + +
      Schema
        Resources undefined[]
        descriptions object
        + +A list of localized descriptions of the Entitlement. + +
        application undefined[]
        + +The corresponding Application object of the Entitlement. + +
        owner undefined[]
        + +The owner of the Entitlement. + +
        classifications object
        + +Classifications of this Entitlement. + +
        classification object
        + +Classification of this object. + +
        meta object
        reviewer object
        + +This is an Extended Attribute from Managed Attribute. The Identity that reviewed the Entitlement. + +
      **AP_Logins** Target Friendly Description\"\n },\n \"displayName\": \"AP_Logins\",\n \"type\": \"Permission\",\n \"application\": [\n {\n \"value\": \"7f00000180281df7818028bfac5a0367\",\n \"$ref\": \"http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826\",\n \"displayName\": \"Oracle_DB_oasis\"\n }\n ],\n \"owner\": [\n {\n \"value\": \"7f00000180281df7818028bfb0d103c7\",\n \"$ref\": \"http://localhost:8080/identityiq/scim/v2/Users/7f00000180281df7818028bfb0d103c7\",\n \"displayName\": \"Debra Wood\"\n }\n ],\n \"requestable\": true,\n \"aggregated\": true,\n \"attribute\": \"AP_Logins\",\n \"value\": \"CN=AP_Logins,OU=Security,OU=Permissions,DC=test,DC=sailpoint,DC=com\",\n \"lastRefresh\": \"2022-04-14T10:48:01.907-05:00\",\n \"lastTargetAggregation\": \"2022-04-14T10:48:01.907-05:00\",\n \"classifications\": {\n \"source\": \"UI\",\n \"effective\": false,\n \"classification\": {\n \"name\": \"ClassificationB\",\n \"displayName\": \"ClassB\",\n \"origin\": \"PAMSource\",\n \"type\": \"Aggregation\"\n }\n },\n \"meta\": {\n \"created\": \"2022-04-14T10:44:54.834-05:00\",\n \"location\": \"http://localhost:8080/identityiq/scim/v2/Entitlements/7f00000180281df7818028bfb83204dc\",\n \"lastModified\": \"2022-04-05T15:52:30.119-05:00\",\n \"version\": \"\\\"W\\\"1649951094834\\\"\",\n \"resourceType\": \"Entitlement\"\n },\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:sailpoint:1.0:Entitlement\"\n ],\n \"entitleAuth\": \"Low\",\n \"entDate\": \"2022-04-14T10:44:54.738-05:00\",\n \"active\": false,\n \"rank\": 3,\n \"rule\": \"APLogin-Contractors-Rule\",\n \"reviewer\": {\n \"displayName\": \"Dan Patrick\",\n \"value\": \"c0b4568a4fe7458c434ee77f2fad267c\",\n \"$ref\": \"http://localhost:8080/identityiq/scim/v2/Users/c0b4568a4fe7458c434ee77f2fad267c\"\n },\n \"email\": \"dpatrick@demoexample.com\"\n }\n ]\n}"} language={"json"}>
      Schema
        Resources undefined[]
        + +The SCIM resources returned for this endpoint. + +
        descriptions object
        + +A list of localized descriptions of the Entitlement. + +
        application undefined[]
        + +The corresponding Application object of the Entitlement. + +
        owner undefined[]
        + +The owner of the Entitlement. + +
        classifications object
        + +Classifications of this Entitlement. + +
        classification object
        + +Classification of this object. + +
        meta object
        reviewer object
        + +This is an Extended Attribute from Managed Attribute. The Identity that reviewed the Entitlement. + +
      **AP_Logins** Target Friendly Description\"\n },\n \"displayName\": \"AP_Logins\",\n \"type\": \"Permission\",\n \"application\": [\n {\n \"value\": \"7f00000180281df7818028bfac5a0367\",\n \"$ref\": \"http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826\",\n \"displayName\": \"Oracle_DB_oasis\"\n }\n ],\n \"owner\": [\n {\n \"value\": \"7f00000180281df7818028bfb0d103c7\",\n \"$ref\": \"http://localhost:8080/identityiq/scim/v2/Users/7f00000180281df7818028bfb0d103c7\",\n \"displayName\": \"Debra Wood\"\n }\n ],\n \"requestable\": true,\n \"aggregated\": true,\n \"attribute\": \"AP_Logins\",\n \"value\": \"CN=AP_Logins,OU=Security,OU=Permissions,DC=test,DC=sailpoint,DC=com\",\n \"lastRefresh\": \"2022-04-14T10:48:01.907-05:00\",\n \"lastTargetAggregation\": \"2022-04-14T10:48:01.907-05:00\",\n \"classifications\": {\n \"source\": \"UI\",\n \"effective\": false,\n \"classification\": {\n \"name\": \"ClassificationB\",\n \"displayName\": \"ClassB\",\n \"origin\": \"PAMSource\",\n \"type\": \"Aggregation\"\n }\n },\n \"meta\": {\n \"created\": \"2022-04-14T10:44:54.834-05:00\",\n \"location\": \"http://localhost:8080/identityiq/scim/v2/Entitlements/7f00000180281df7818028bfb83204dc\",\n \"lastModified\": \"2022-04-05T15:52:30.119-05:00\",\n \"version\": \"\\\"W\\\"1649951094834\\\"\",\n \"resourceType\": \"Entitlement\"\n },\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:sailpoint:1.0:Entitlement\"\n ],\n \"entitleAuth\": \"Low\",\n \"entDate\": \"2022-04-14T10:44:54.738-05:00\",\n \"active\": false,\n \"rank\": 3,\n \"rule\": \"APLogin-Contractors-Rule\",\n \"reviewer\": {\n \"displayName\": \"Dan Patrick\",\n \"value\": \"c0b4568a4fe7458c434ee77f2fad267c\",\n \"$ref\": \"http://localhost:8080/identityiq/scim/v2/Users/c0b4568a4fe7458c434ee77f2fad267c\"\n },\n \"email\": \"dpatrick@demoexample.com\"\n }\n ]\n}"} language={"json"}>
      \ No newline at end of file diff --git a/products/iiq/api/get-launched-workflow-by-id.api.mdx b/products/iiq/api/get-launched-workflow-by-id.api.mdx new file mode 100644 index 000000000..7c3725c1b --- /dev/null +++ b/products/iiq/api/get-launched-workflow-by-id.api.mdx @@ -0,0 +1,49 @@ +--- +id: get-launched-workflow-by-id +sidebar_label: Returns a LaunchedWorkflow resource based on id. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getLaunchedWorkflowById","tags":["LaunchedWorkflows"],"description":"The LaunchedWorkflow resource with matching id is returned.

      \nAttributes to include in the response can be specified with the attributes query parameter.

      \nAttributes to exclude from the response can be specified with the excludedAttributes query parameter.

      \n\nThe schema related to LaunchedWorkflow is: \n- **urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow**\n","parameters":[{"name":"launchedWorkflowId","in":"path","schema":{"type":"string","example":"c0a8019c802d1e5a81802eb2b57e020f"},"description":"id of LaunchedWorkflow resource.","required":true},{"in":"query","name":"attributes","schema":{"type":"string","example":"expiration"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"names"},"description":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**"}],"responses":{"200":{"description":"Returns a single LaunchedWorkflow resource based on the id.
      **LaunchedWorkflow responses include attributes from the TaskResult related to the Workflow execution.**","content":{"application/json":{"schema":{"properties":{"partitioned":{"description":"Flag to indicate this TaskResult is partitioned. (From the TaskResult used to launch the Workflow).","type":"boolean","example":true},"completed":{"type":"string","format":"date-time","description":"The completed DateTime of the TaskResult. (From the TaskResult used to launch the Workflow).","example":"2022-04-14T10:45:26.098-05:00"},"type":{"description":"Type of the TaskResult. (From the TaskResult used to launch the Workflow).","type":"string","example":"Workflow"},"launched":{"type":"string","format":"date-time","description":"The launched DateTime of the TaskResult. (From the TaskResult used to launch the Workflow).","example":"2022-04-14T10:45:26.114-05:00"},"pendingSignOffs":{"description":"The number of pending signoffs of this TaskResult. (From the TaskResult used to launch the Workflow).","type":"integer","example":2},"workflowName":{"description":"Name of the Workflow to launch.","type":"string","example":"Update Account Group a2a"},"identityRequestId":{"description":"Id representing the identity request.","type":"string","example":"0000000002"},"workflowCaseId":{"description":"Id representing the workflow case (a running instance of a workflow).","type":"string","example":"7f000001806719888180675c8f8a016a"},"workflowProcessId":{"type":"string","description":"Id representing the workflow monitoring process log.","example":"7f000001806719888180675c8f8a0017b"},"retries":{"description":"The number of retries performed during the execution of provisioning activities.","type":"integer","example":1},"approvalSet":{"description":"XML representation of approvals.","type":"string","example":"example: "},"workflowSummary":{"description":"XML representation of the workflow summary.","type":"string","example":"example: \"\""},"input":{"description":"A list of input attributes of the Launched Workflow.","type":"object","properties":{"key":{"description":"The attribute key.","type":"string","example":"_caseName"},"value":{"description":"The attribute value.","type":"string","example":"WorkflowCaseRegistry"},"type":{"description":"The attribute type.","type":"string","example":"string"}}},"output":{"description":"A list of output attributes of the Launched Workflow.","type":"object","properties":{"key":{"description":"The attribute key.","type":"string","example":"workflowSummary"},"value":{"description":"The attribute value.","type":"string","example":"\\n \\n \\n \\n\\n"},"type":{"description":"The attribute type.","type":"string","example":"application/xml"}}},"targetClass":{"description":"Target Class of the TaskResult. (From the TaskResult used to launch the Workflow).","type":"string","example":"Permission"},"name":{"description":"Name of the TaskResult. (From the TaskResult used to launch the Workflow).","type":"string","example":"Update Account Group a2a"},"messages":{"description":"List of messages of the TaskResult. (From the TaskResult used to launch the Workflow).","type":"array","items":{"example":["Task executed successfully."]}},"attributes":{"description":"A list of attributes of the TaskResult. (From the TaskResult used to launch the Workflow).","type":"array","items":{"properties":{"key":{"description":"The attribute key.","type":"string","example":"Workflow Summary"},"value":{"description":"The attribute value.","type":"string","example":"\\n \\n \\n \\n\\n"}}}},"id":{"description":"Unique identifier of the TaskResult. (From the TaskResult used to launch the Workflow).","type":"string","example":"7f00000180281df7818028c03252085c"},"completionStatus":{"type":"string","description":"Completion Status of the TaskResult. (From the TaskResult used to launch the Workflow).","enum":["Success","Warning","Error","Terminated","TempError"],"example":"Success"},"taskDefinition":{"type":"string","description":"Name of the TaskDefinition of the TaskResult. (From the TaskResult used to launch the Workflow).","example":"Workflow Launcher"},"terminated":{"description":"Flag to indicate this TaskResult is terminated. (From the TaskResult used to launch the Workflow).","type":"boolean","example":true},"launcher":{"description":"Launcher of the TaskResult. (From the TaskResult used to launch the Workflow).","type":"string","example":"spadmin"},"meta":{"type":"object","properties":{"created":{"description":"DateTime when the TaskResult was created. (From the TaskResult used to launch the Workflow).","type":"string","format":"date-time","example":"2022-04-14T10:44:54.834-05:00"},"location":{"description":"URL to the TaskResult. (From the TaskResult used to launch the Workflow).","type":"string","example":"http://localhost:8080/identityiq/scim/v2/TaskResults/7f00000180281df7818028c03252085c"},"lastModified":{"description":"DateTime of TaskResult last modification. (From the TaskResult used to launch the Workflow).","type":"string","format":"date-time","example":"2022-04-05T15:52:30.119-05:00"},"version":{"description":"TaskResult version. (From the TaskResult used to launch the Workflow).","type":"string","example":"\"W\"1649951094834\""},"resourceType":{"description":"Resource type of the metadata subject. (From the TaskResult used to launch the Workflow).","type":"string","example":"TaskResult"}}}}}}}}},"method":"get","path":"/LaunchedWorkflow/{launchedWorkflowId}","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns a LaunchedWorkflow resource based on id.","description":{"content":"The LaunchedWorkflow resource with matching id is returned.

      \nAttributes to include in the response can be specified with the attributes query parameter.

      \nAttributes to exclude from the response can be specified with the excludedAttributes query parameter.

      \n\nThe schema related to LaunchedWorkflow is: \n- **urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow**\n","type":"text/plain"},"url":{"path":["LaunchedWorkflow",":launchedWorkflowId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) id of LaunchedWorkflow resource.","type":"text/plain"},"type":"any","value":"","key":"launchedWorkflowId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns a LaunchedWorkflow resource based on id.' (get-launched-workflow-by-id)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns a LaunchedWorkflow resource based on id. + + + +The LaunchedWorkflow resource with matching id is returned.

      +Attributes to include in the response can be specified with the attributes query parameter.

      +Attributes to exclude from the response can be specified with the excludedAttributes query parameter.

      + +The schema related to LaunchedWorkflow is: +- **urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow** + + +
      Path Parameters
      Query Parameters
      + +Returns a single LaunchedWorkflow resource based on the id.
      **LaunchedWorkflow responses include attributes from the TaskResult related to the Workflow execution.** + +
      Schema
        input object
        + +A list of input attributes of the Launched Workflow. + +
        output object
        + +A list of output attributes of the Launched Workflow. + +
        attributes undefined[]
        + +A list of attributes of the TaskResult. (From the TaskResult used to launch the Workflow). + +
        meta object
       \",\n \"workflowSummary\": \"example: \\\"\\\"\",\n \"input\": {\n \"key\": \"_caseName\",\n \"value\": \"WorkflowCaseRegistry\",\n \"type\": \"string\"\n },\n \"output\": {\n \"key\": \"workflowSummary\",\n \"value\": \"\\\\n \\\\n \\\\n \\\\n\\\\n\",\n \"type\": \"application/xml\"\n },\n \"targetClass\": \"Permission\",\n \"name\": \"Update Account Group a2a\",\n \"messages\": [\n [\n \"Task executed successfully.\"\n ]\n ],\n \"attributes\": [\n {\n \"key\": \"Workflow Summary\",\n \"value\": \"\\\\n \\\\n \\\\n \\\\n\\\\n\"\n }\n ],\n \"id\": \"7f00000180281df7818028c03252085c\",\n \"completionStatus\": \"Success\",\n \"taskDefinition\": \"Workflow Launcher\",\n \"terminated\": true,\n \"launcher\": \"spadmin\",\n \"meta\": {\n \"created\": \"2022-04-14T10:44:54.834-05:00\",\n \"location\": \"http://localhost:8080/identityiq/scim/v2/TaskResults/7f00000180281df7818028c03252085c\",\n \"lastModified\": \"2022-04-05T15:52:30.119-05:00\",\n \"version\": \"\\\"W\\\"1649951094834\\\"\",\n \"resourceType\": \"TaskResult\"\n }\n}"} language={"json"}>
      \ No newline at end of file diff --git a/products/iiq/api/get-object-config-by-id.api.mdx b/products/iiq/api/get-object-config-by-id.api.mdx new file mode 100644 index 000000000..fac06c803 --- /dev/null +++ b/products/iiq/api/get-object-config-by-id.api.mdx @@ -0,0 +1,55 @@ +--- +id: get-object-config-by-id +sidebar_label: Returns an ObjectConfig resource based on its name or id. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getObjectConfigById","tags":["ObjectConfig"],"description":"The ObjectConfig resource with matching name or id is returned.
      \n\nAttributes to include in the response can be specified with the 'attributes' query parameter.
      \n\nAttributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.\n\nThe schema related to ObjectConfig is:\n- **urn:ietf:params:scim:schemas:sailpoint:1.0:ObjectConfig**\n","parameters":[{"name":"objectConfigId","in":"path","schema":{"type":"string","example":"7f00000180281df7818028be62e500e8"},"description":"id of ObjectConfig resource.","required":true},{"in":"query","name":"attributes","schema":{"type":"string","example":"objectAttributes"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"name"},"description":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**"}],"responses":{"200":{"description":"Returns a single ObjectConfig resource based on its name or id.","content":{"application/json":{"schema":{"properties":{"id":{"description":"Unique identifier of the ObjectConfig.","type":"string","example":"7f00000180281df7818028be63aa00ef"},"name":{"description":"Name of the ObjectConfig.","type":"string","example":"Bundle"},"objectAttributes":{"description":"A list of attributes of the ObjectConfig.","type":"array","items":{"properties":{"name":{"description":"The object attribute name.","type":"string","example":"StringAttr"},"displayName":{"description":"The display name of the object attribute.","type":"string","example":"attr_demoString"},"type":{"description":"The type of the object attribute.","type":"string","example":"string"},"multi":{"description":"A Boolean value indicating this is a multi-valued attribute.","type":"boolean","example":false},"defaultValue":{"description":"The default value of the object attribute.","type":"string","example":"None"},"system":{"description":"A Boolean value indicating this is a system attribute that does not have a source and is not configurable.","type":"boolean","example":false},"standard":{"description":"A Boolean value indicating this is a standard attribute (i.e. manager, email, firstname, lastname).","type":"boolean","example":false},"extendedNumber":{"description":"Integer value of the extended attribute column number in the database schema.","type":"integer","example":2},"namedColumn":{"description":"A Boolean value indicating this attribute has a named column in the database schema.","type":"boolean","example":false},"ruleName":{"description":"Rule used to derive the value. Usually specified when there are no attributeSources defined.","type":"string","example":"lastLoginToDate"},"groupFactory":{"description":"A Boolean value indicating this attribute can be used in a group factory. Identity attributes only.","type":"boolean","example":true},"editMode":{"description":"Enumeration indicating whether this attribute allows modification.","type":"string","enum":["READONLY","PERMANENT","UNTILFEEDVALUECHANGES"],"example":"READONLY"},"attributeSources":{"description":"Sources of values for this atribute. Identity attributes only.","type":"array","items":{"properties":{"name":{"description":"The name of the attribute on the application.","type":"string","example":"lastName"},"key":{"description":"Derived identifier for this source.","type":"string","example":"testInstancesApplication/inst2:lastName"},"instance":{"description":"Optional instance name for template applications.","type":"string","example":"inst2"},"ruleName":{"description":"Rule used to derive the value.","type":"string","example":"Identity Attribute Rule - Type"}}}},"attributeTargets":{"description":"Targets of this attribute that should receive the value upon attribute synchronization. Identity attributes only.","type":"array","items":{"properties":{"name":{"description":"The name of the attribute on the application.","type":"string","example":"app2_active"},"key":{"description":"Derived identifier for this target.","type":"string","example":"Composite_ERP_Global_Platform:app2_inactive"},"instance":{"description":"Optional instance name for template applications.","type":"string","example":"continuous-integration-environment1"},"ruleName":{"description":"Rule used to derive the value.","type":"string","example":"attributeTarget-aws-S3-rule"},"provisionAllAccount":{"description":"Return whether to provision all accounts if an identity has multiple accounts on the target application. Identity attributes only.","type":"boolean","example":false}}}}}}},"meta":{"description":"Metadata for the ObjectConfig","type":"array","items":{"properties":{"created":{"description":"Datetime when the ObjectConfig was created","type":"string","example":"2022-03-31T14:52:40.245-05:00"},"location":{"description":"URL to the ObjectConfig","type":"string","example":"http://localhost:8080/identityiq/scim/v2/ObjectConfig/7f00000180281df7818028be62ef00e9"},"lastModified":{"description":"Datetime of ObjectConfig last modification","type":"string","example":"2022-03-31T14:52:40.265-05:00"},"version":{"description":"ObjectConfig version","type":"string","example":"\"W\"1649951092552\""},"resourceType":{"description":"Resource type of the metadata subject","type":"string","example":"ObjectConfig"}}}}}}}}}},"method":"get","path":"/ObjectConfig/{objectConfigId}","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns an ObjectConfig resource based on its name or id.","description":{"content":"The ObjectConfig resource with matching name or id is returned.
      \n\nAttributes to include in the response can be specified with the 'attributes' query parameter.
      \n\nAttributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.\n\nThe schema related to ObjectConfig is:\n- **urn:ietf:params:scim:schemas:sailpoint:1.0:ObjectConfig**\n","type":"text/plain"},"url":{"path":["ObjectConfig",":objectConfigId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) id of ObjectConfig resource.","type":"text/plain"},"type":"any","value":"","key":"objectConfigId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns an ObjectConfig resource based on its name or id.' (get-object-config-by-id)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns an ObjectConfig resource based on its name or id. + + + +The ObjectConfig resource with matching name or id is returned.
      + +Attributes to include in the response can be specified with the 'attributes' query parameter.
      + +Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter. + +The schema related to ObjectConfig is: +- **urn:ietf:params:scim:schemas:sailpoint:1.0:ObjectConfig** + + +
      Path Parameters
      Query Parameters
      + +Returns a single ObjectConfig resource based on its name or id. + +
      Schema
        objectAttributes undefined[]
        + +A list of attributes of the ObjectConfig. + +
        attributeSources undefined[]
        + +Sources of values for this atribute. Identity attributes only. + +
        attributeTargets undefined[]
        + +Targets of this attribute that should receive the value upon attribute synchronization. Identity attributes only. + +
        meta undefined[]
        + +Metadata for the ObjectConfig + +
      \ No newline at end of file diff --git a/products/iiq/api/get-object-configs.api.mdx b/products/iiq/api/get-object-configs.api.mdx new file mode 100644 index 000000000..3ca68e527 --- /dev/null +++ b/products/iiq/api/get-object-configs.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-object-configs +sidebar_label: Returns all object of type ObjectConfig. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getObjectConfigs","tags":["ObjectConfig"],"description":"This endpoint returns all ObjectConfig resources.
      \n\nAttributes to include in the response can be specified with the attributes query parameter.
      \n\nAttributes to exclude from the response can be specified with the excludedAttributes query parameter.
      \n\nThe schema related to ObjectConfig is: \n- **urn:ietf:params:scim:schemas:sailpoint:1.0:ObjectConfig**.\n","parameters":[{"in":"query","name":"filter","schema":{"type":"string","example":"name eq \"identity\""},"description":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported."},{"in":"query","name":"lookupByName","schema":{"type":"boolean","default":false,"example":true},"description":"(OPTIONAL) Set to true if the ObjectConfig name is passed instead of the ObjectConfig id."},{"in":"query","name":"sortBy","schema":{"type":"string","example":"name"},"description":"Allows sorting the results by a resource's attributes."},{"in":"query","name":"sortOrder","schema":{"type":"string","default":"ascending"},"example":"descending","description":"Determines what order to sort results in."},{"in":"query","name":"startIndex","schema":{"type":"integer","example":10,"default":1},"description":"Determines the starting index of the result set."},{"in":"query","name":"count","schema":{"type":"integer","example":10,"default":1000},"description":"Specifies the number of results per page."},{"in":"query","name":"attributes","schema":{"type":"string","example":"name"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"name, objectAttributes"},"description":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**"}],"responses":{"200":{"description":"Returned all SCIM resources for this endpoint.","content":{"application/json":{"schema":{"properties":{"totalResults":{"description":"Number of resources returned for this endpoint","type":"integer","example":"1,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"type":"array","items":{"properties":{"id":{"description":"Unique identifier of the ObjectConfig.","type":"string","example":"c0a8019c7fe11678817fe18984351477"},"name":{"description":"Name of the ObjectConfig.","type":"string","example":"Link"},"objectAttributes":{"description":"A list of attributes of the ObjectConfig.","type":"array","items":{"properties":{"name":{"description":"The object attribute name.","type":"string","example":"inactive"},"displayName":{"description":"The display name of the object attribute.","type":"string","example":"attr_demoInactive"},"type":{"description":"The type of the object attribute.","type":"string","example":"boolean"},"multi":{"description":"A Boolean value indicating this is a multi-valued attribute.","type":"boolean","example":false},"defaultValue":{"description":"The default value of the object attribute.","type":"string","example":"false"},"system":{"description":"A Boolean value indicating this is a system attribute that does not have a source and is not configurable.","type":"boolean","example":true},"standard":{"description":"A Boolean value indicating this is a standard attribute (i.e. manager, email, firstname, lastname).","type":"boolean","example":false},"extendedNumber":{"description":"Integer value of the extended attribute column number in the database schema.","type":"integer","example":1},"namedColumn":{"description":"A Boolean value indicating this attribute has a named column in the database schema.","type":"boolean","example":false},"ruleName":{"description":"Rule used to derive the value. Usually specified when there are no attributeSources defined.","type":"string","example":"lastLoginToDateRule"},"groupFactory":{"description":"A Boolean value indicating this attribute can be used in a group factory. Identity attributes only.","type":"boolean","example":true},"editMode":{"description":"Enumeration indicating whether this attribute allows modification.","type":"string","enum":["READONLY","PERMANENT","UNTILFEEDVALUECHANGES"],"example":"READONLY"},"attributeSources":{"description":"Sources of values for this atribute. Identity attributes only.","type":"array","items":{"properties":{"name":{"description":"The name of the attribute on the application.","type":"string","example":"app1_inactive"},"key":{"description":"Derived identifier for this source.","type":"string","example":"Active_Directory:app1_inactive"},"instance":{"description":"Optional instance name for template applications.","type":"string","example":"test-environment"},"ruleName":{"description":"Rule used to derive the value.","type":"string","example":"attributeSource-aws-S3-rule"}}}},"attributeTargets":{"description":"Targets of this attribute that should receive the value upon attribute synchronization. Identity attributes only.","type":"array","items":{"properties":{"name":{"description":"The name of the attribute on the application.","type":"string","example":"app2_active"},"key":{"description":"Derived identifier for this target.","type":"string","example":"Composite_ERP_Global_Platform:app2_inactive"},"instance":{"description":"Optional instance name for template applications.","type":"string","example":"continuous-integration-environment1"},"ruleName":{"description":"Rule used to derive the value.","type":"string","example":"attributeTarget-aws-S3-rule"},"provisionAllAccount":{"description":"Return whether to provision all accounts if an identity has multiple accounts on the target application. Identity attributes only.","type":"boolean","example":false}}}}}}},"meta":{"description":"Metadata for the ObjectConfig","type":"array","items":{"properties":{"created":{"description":"Datetime when the ObjectConfig was created","type":"string","example":"2022-03-31T14:52:40.245-05:00"},"location":{"description":"URL to the ObjectConfig","type":"string","example":"http://localhost:8080/identityiq/scim/v2/ObjectConfig/7f00000180281df7818028be62ef00e9"},"lastModified":{"description":"Datetime of ObjectConfig last modification","type":"string","example":"2022-03-31T14:52:40.265-05:00"},"version":{"description":"ObjectConfig version","type":"string","example":"\"W\"1649951092552\""},"resourceType":{"description":"Resource type of the metadata subject","type":"string","example":"ObjectConfig"}}}}}}}}}},"application/scim+json":{"schema":{"properties":{"totalResults":{"description":"Number of ObjectConfig resources returned.","type":"integer","example":"1500,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"description":"The SCIM resources returned for this endpoint.","type":"array","items":{"properties":{"id":{"description":"Unique identifier of the ObjectConfig.","type":"string","example":"c0a8019c7fe11678817fe18984351477"},"name":{"description":"Name of the ObjectConfig.","type":"string","example":"Link"},"objectAttributes":{"description":"A list of attributes of the ObjectConfig.","type":"array","items":{"properties":{"name":{"description":"The object attribute name.","type":"string","example":"inactive"},"displayName":{"description":"The display name of the object attribute.","type":"string","example":"attr_demoInactive"},"type":{"description":"The type of the object attribute.","type":"string","example":"boolean"},"multi":{"description":"A Boolean value indicating this is a multi-valued attribute.","type":"boolean","example":false},"defaultValue":{"description":"The default value of the object attribute.","type":"string","example":"false"},"system":{"description":"A Boolean value indicating this is a system attribute that does not have a source and is not configurable.","type":"boolean","example":true},"standard":{"description":"A Boolean value indicating this is a standard attribute (i.e. manager, email, firstname, lastname).","type":"boolean","example":false},"extendedNumber":{"description":"Integer value of the extended attribute column number in the database schema.","type":"integer","example":1},"namedColumn":{"description":"A Boolean value indicating this attribute has a named column in the database schema.","type":"boolean","example":false},"ruleName":{"description":"Rule used to derive the value. Usually specified when there are no attributeSources defined.","type":"string","example":"lastLoginToDateRule"},"groupFactory":{"description":"A Boolean value indicating this attribute can be used in a group factory. Identity attributes only.","type":"boolean","example":true},"editMode":{"description":"Enumeration indicating whether this attribute allows modification.","type":"string","enum":["READONLY","PERMANENT","UNTILFEEDVALUECHANGES"],"example":"READONLY"},"attributeSources":{"description":"Sources of values for this atribute. Identity attributes only.","type":"array","items":{"properties":{"name":{"description":"The name of the attribute on the application.","type":"string","example":"app1_inactive"},"key":{"description":"Derived identifier for this source.","type":"string","example":"Active_Directory:app1_inactive"},"instance":{"description":"Optional instance name for template applications.","type":"string","example":"test-environment"},"ruleName":{"description":"Rule used to derive the value.","type":"string","example":"attributeSource-aws-S3-rule"}}}},"attributeTargets":{"description":"Targets of this attribute that should receive the value upon attribute synchronization. Identity attributes only.","type":"array","items":{"properties":{"name":{"description":"The name of the attribute on the application.","type":"string","example":"app2_active"},"key":{"description":"Derived identifier for this target.","type":"string","example":"Composite_ERP_Global_Platform:app2_inactive"},"instance":{"description":"Optional instance name for template applications.","type":"string","example":"continuous-integration-environment1"},"ruleName":{"description":"Rule used to derive the value.","type":"string","example":"attributeTarget-aws-S3-rule"},"provisionAllAccount":{"description":"Return whether to provision all accounts if an identity has multiple accounts on the target application. Identity attributes only.","type":"boolean","example":false}}}}}}},"meta":{"description":"Metadata for the ObjectConfig","type":"array","items":{"properties":{"created":{"description":"Datetime when the ObjectConfig was created","type":"string","example":"2022-03-31T14:52:40.245-05:00"},"location":{"description":"URL to the ObjectConfig","type":"string","example":"http://localhost:8080/identityiq/scim/v2/ObjectConfig/7f00000180281df7818028be62ef00e9"},"lastModified":{"description":"Datetime of ObjectConfig last modification","type":"string","example":"2022-03-31T14:52:40.265-05:00"},"version":{"description":"ObjectConfig version","type":"string","example":"\"W\"1649951092552\""},"resourceType":{"description":"Resource type of the metadata subject","type":"string","example":"ObjectConfig"}}}}}}}}}}}}},"method":"get","path":"/ObjectConfigs","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns all object of type ObjectConfig.","description":{"content":"This endpoint returns all ObjectConfig resources.
      \n\nAttributes to include in the response can be specified with the attributes query parameter.
      \n\nAttributes to exclude from the response can be specified with the excludedAttributes query parameter.
      \n\nThe schema related to ObjectConfig is: \n- **urn:ietf:params:scim:schemas:sailpoint:1.0:ObjectConfig**.\n","type":"text/plain"},"url":{"path":["ObjectConfigs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.","type":"text/plain"},"key":"filter","value":""},{"disabled":false,"description":{"content":"(OPTIONAL) Set to true if the ObjectConfig name is passed instead of the ObjectConfig id.","type":"text/plain"},"key":"lookupByName","value":""},{"disabled":false,"description":{"content":"Allows sorting the results by a resource's attributes.","type":"text/plain"},"key":"sortBy","value":""},{"disabled":false,"description":{"content":"Determines what order to sort results in.","type":"text/plain"},"key":"sortOrder","value":""},{"disabled":false,"description":{"content":"Determines the starting index of the result set.","type":"text/plain"},"key":"startIndex","value":""},{"disabled":false,"description":{"content":"Specifies the number of results per page.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns all object of type ObjectConfig.' (get-object-configs)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns all object of type ObjectConfig. + + + +This endpoint returns all ObjectConfig resources.
      + +Attributes to include in the response can be specified with the attributes query parameter.
      + +Attributes to exclude from the response can be specified with the excludedAttributes query parameter.
      + +The schema related to ObjectConfig is: +- **urn:ietf:params:scim:schemas:sailpoint:1.0:ObjectConfig**. + + +
      Query Parameters
      + +Returned all SCIM resources for this endpoint. + +
      Schema
        Resources undefined[]
        objectAttributes undefined[]
        + +A list of attributes of the ObjectConfig. + +
        attributeSources undefined[]
        + +Sources of values for this atribute. Identity attributes only. + +
        attributeTargets undefined[]
        + +Targets of this attribute that should receive the value upon attribute synchronization. Identity attributes only. + +
        meta undefined[]
        + +Metadata for the ObjectConfig + +
      Schema
        Resources undefined[]
        + +The SCIM resources returned for this endpoint. + +
        objectAttributes undefined[]
        + +A list of attributes of the ObjectConfig. + +
        attributeSources undefined[]
        + +Sources of values for this atribute. Identity attributes only. + +
        attributeTargets undefined[]
        + +Targets of this attribute that should receive the value upon attribute synchronization. Identity attributes only. + +
        meta undefined[]
        + +Metadata for the ObjectConfig + +
      \ No newline at end of file diff --git a/products/iiq/api/get-policy-violation-by-id.api.mdx b/products/iiq/api/get-policy-violation-by-id.api.mdx new file mode 100644 index 000000000..77597572f --- /dev/null +++ b/products/iiq/api/get-policy-violation-by-id.api.mdx @@ -0,0 +1,55 @@ +--- +id: get-policy-violation-by-id +sidebar_label: Returns a PolicyViolation resource based on id. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getPolicyViolationById","tags":["PolicyViolations"],"description":"The PolicyViolation resource with matching id is returned.","parameters":[{"name":"policyViolationId","in":"path","schema":{"type":"string"},"description":"The id of the PolicyViolation.","required":true},{"in":"query","name":"attributes","schema":{"type":"string","example":"policyName,constraintName"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"policyName,constraintName"},"description":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*"}],"responses":{"200":{"description":"Returns a PolicyViolation resource based on the id.","content":{"application/json":{"schema":{"properties":{"id":{"description":"IdentityIQ id of the PolicyViolation.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"policyName":{"description":"Name of the Policy this PolicyViolation is associated with.","type":"string","example":"Entitlement Policy with Details"},"constraintName":{"description":"Name of the Constraint this PolicyViolation is associated with.","type":"string","example":"Entitlement Policy with Details"},"identity":{"description":"The Identity (User) that caused the PolicyViolation.","type":"object","properties":{"displayName":{"description":"Display name of the Identity that caused the PolicyViolation.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the Identity which caused the PolicyViolation.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"URI reference to the Identity (User).","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"owner":{"description":"The User that owns the Policy.","type":"object","properties":{"displayName":{"description":"Display name of the Policy owner.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the Policy owner.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"URI reference to the Policy owner.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"description":{"description":"Description of the PolicyViolation.","type":"string","example":"Production and development systems should not be available to one person."},"status":{"description":"Status of the PolicyViolation. This can be Open, Mitigated, Remediated, or Delegated.","type":"string","example":"Open"},"meta":{"description":"Metadata of the resource.","properties":{"created":{"description":"Datetime this Resource was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the resource was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the resource.","type":"string","example":"W/\"1644561244074\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"PolicyViolation"}}},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:PolicyViolation"]}}}},"application/scim+json":{"schema":{"properties":{"id":{"description":"IdentityIQ id of the PolicyViolation.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"policyName":{"description":"Name of the Policy this PolicyViolation is associated with.","type":"string","example":"Entitlement Policy with Details"},"constraintName":{"description":"Name of the Constraint this PolicyViolation is associated with.","type":"string","example":"Entitlement Policy with Details"},"identity":{"description":"The Identity (User) that caused the PolicyViolation.","type":"object","properties":{"displayName":{"description":"Display name of the Identity that caused the PolicyViolation.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the Identity which caused the PolicyViolation.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"URI reference to the Identity (User).","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"owner":{"description":"The User that owns the Policy.","type":"object","properties":{"displayName":{"description":"Display name of the Policy owner.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the Policy owner.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"URI reference to the Policy owner.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"description":{"description":"Description of the PolicyViolation.","type":"string","example":"Production and development systems should not be available to one person."},"status":{"description":"Status of the PolicyViolation. This can be Open, Mitigated, Remediated, or Delegated.","type":"string","example":"Open"},"meta":{"description":"Metadata of the resource.","properties":{"created":{"description":"Datetime this Resource was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the resource was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the resource.","type":"string","example":"W/\"1644561244074\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"PolicyViolation"}}},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:PolicyViolation"]}}}}}}},"method":"get","path":"/PolicyViolations/{policyViolationId}","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns a PolicyViolation resource based on id.","description":{"content":"The PolicyViolation resource with matching id is returned.","type":"text/plain"},"url":{"path":["PolicyViolations",":policyViolationId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The id of the PolicyViolation.","type":"text/plain"},"type":"any","value":"","key":"policyViolationId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns a PolicyViolation resource based on id.' (get-policy-violation-by-id)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns a PolicyViolation resource based on id. + + + +The PolicyViolation resource with matching id is returned. + +
      Path Parameters
      Query Parameters
      + +Returns a PolicyViolation resource based on the id. + +
      Schema
        identity object
        + +The Identity (User) that caused the PolicyViolation. + +
        owner object
        + +The User that owns the Policy. + +
        meta
        + +Metadata of the resource. + +
      Schema
        identity object
        + +The Identity (User) that caused the PolicyViolation. + +
        owner object
        + +The User that owns the Policy. + +
        meta
        + +Metadata of the resource. + +
      \ No newline at end of file diff --git a/products/iiq/api/get-policy-violations.api.mdx b/products/iiq/api/get-policy-violations.api.mdx new file mode 100644 index 000000000..0d9bddc49 --- /dev/null +++ b/products/iiq/api/get-policy-violations.api.mdx @@ -0,0 +1,59 @@ +--- +id: get-policy-violations +sidebar_label: Returns all PolicyViolation resources. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getPolicyViolations","tags":["PolicyViolations"],"description":"This endpoint returns all PolicyViolation resources.","parameters":[{"in":"query","name":"filter","schema":{"type":"string","example":"constraintName eq \"Mock Constraint\""},"description":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported."},{"in":"query","name":"sortBy","schema":{"type":"string","example":"constraintName"},"description":"Allows sorting the results by a resource's attributes."},{"in":"query","name":"sortOrder","schema":{"type":"string","example":"descending","default":"ascending"},"description":"Determines what order to sort results in."},{"in":"query","name":"startIndex","schema":{"type":"integer","example":2313,"default":1},"description":"Determines the starting index of the result set."},{"in":"query","name":"count","schema":{"type":"integer","example":10,"default":1000},"description":"Specifies the number of results per page."},{"in":"query","name":"attributes","schema":{"type":"string","example":"policyName,constraintName"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"policyName,constraintName"},"description":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*"}],"responses":{"200":{"description":"Returns all PolicyViolation resources.","content":{"application/json":{"schema":{"properties":{"totalResults":{"description":"Number of PolicyViolation resources returned","type":"integer","example":"18,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"type":"array","items":{"properties":{"id":{"description":"IdentityIQ id of the PolicyViolation.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"policyName":{"description":"Name of the Policy this PolicyViolation is associated with.","type":"string","example":"Entitlement Policy with Details"},"constraintName":{"description":"Name of the Constraint this PolicyViolation is associated with.","type":"string","example":"Entitlement Policy with Details"},"identity":{"description":"The Identity (User) that caused the PolicyViolation.","type":"object","properties":{"displayName":{"description":"Display name of the Identity that caused the PolicyViolation.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the Identity which caused the PolicyViolation.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"URI reference to the Identity (User).","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"owner":{"description":"The User that owns the Policy.","type":"object","properties":{"displayName":{"description":"Display name of the Policy owner.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the Policy owner.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"URI reference to the Policy owner.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"description":{"description":"Description of the PolicyViolation.","type":"string","example":"Production and development systems should not be available to one person."},"status":{"description":"Status of the PolicyViolation. This can be Open, Mitigated, Remediated, or Delegated.","type":"string","example":"Open"},"meta":{"description":"Metadata of the resource.","properties":{"created":{"description":"Datetime this Resource was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the resource was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the resource.","type":"string","example":"W/\"1644561244074\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"PolicyViolation"}}},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:PolicyViolation"]}}}}}}},"application/scim+json":{"schema":{"properties":{"totalResults":{"description":"Number of PolicyViolation resources returned.","type":"integer","example":"1500,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"description":"The SCIM resources returned for this endpoint.","type":"array","items":{"properties":{"id":{"description":"IdentityIQ id of the PolicyViolation.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"policyName":{"description":"Name of the Policy this PolicyViolation is associated with.","type":"string","example":"Entitlement Policy with Details"},"constraintName":{"description":"Name of the Constraint this PolicyViolation is associated with.","type":"string","example":"Entitlement Policy with Details"},"identity":{"description":"The Identity (User) that caused the PolicyViolation.","type":"object","properties":{"displayName":{"description":"Display name of the Identity that caused the PolicyViolation.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the Identity which caused the PolicyViolation.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"URI reference to the Identity (User).","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"owner":{"description":"The User that owns the Policy.","type":"object","properties":{"displayName":{"description":"Display name of the Policy owner.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the Policy owner.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"URI reference to the Policy owner.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"description":{"description":"Description of the PolicyViolation.","type":"string","example":"Production and development systems should not be available to one person."},"status":{"description":"Status of the PolicyViolation. This can be Open, Mitigated, Remediated, or Delegated.","type":"string","example":"Open"},"meta":{"description":"Metadata of the resource.","properties":{"created":{"description":"Datetime this Resource was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the resource was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the resource.","type":"string","example":"W/\"1644561244074\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"PolicyViolation"}}},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:PolicyViolation"]}}}}}}}}}},"method":"get","path":"/PolicyViolations","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns all PolicyViolation resources.","description":{"content":"This endpoint returns all PolicyViolation resources.","type":"text/plain"},"url":{"path":["PolicyViolations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.","type":"text/plain"},"key":"filter","value":""},{"disabled":false,"description":{"content":"Allows sorting the results by a resource's attributes.","type":"text/plain"},"key":"sortBy","value":""},{"disabled":false,"description":{"content":"Determines what order to sort results in.","type":"text/plain"},"key":"sortOrder","value":""},{"disabled":false,"description":{"content":"Determines the starting index of the result set.","type":"text/plain"},"key":"startIndex","value":""},{"disabled":false,"description":{"content":"Specifies the number of results per page.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns all PolicyViolation resources.' (get-policy-violations)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns all PolicyViolation resources. + + + +This endpoint returns all PolicyViolation resources. + +
      Query Parameters
      + +Returns all PolicyViolation resources. + +
      Schema
        Resources undefined[]
        identity object
        + +The Identity (User) that caused the PolicyViolation. + +
        owner object
        + +The User that owns the Policy. + +
        meta
        + +Metadata of the resource. + +
      Schema
        Resources undefined[]
        + +The SCIM resources returned for this endpoint. + +
        identity object
        + +The Identity (User) that caused the PolicyViolation. + +
        owner object
        + +The User that owns the Policy. + +
        meta
        + +Metadata of the resource. + +
      \ No newline at end of file diff --git a/products/iiq/api/get-resource-type-by-id.api.mdx b/products/iiq/api/get-resource-type-by-id.api.mdx new file mode 100644 index 000000000..c2f9f5e72 --- /dev/null +++ b/products/iiq/api/get-resource-type-by-id.api.mdx @@ -0,0 +1,35 @@ +--- +id: get-resource-type-by-id +sidebar_label: Returns a ResourceType resource based on ID. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getResourceTypeById","tags":["ResourceTypes"],"description":"The ResourceType with the matching ID is returned. The ID is the URN of the SCIM resource. The common fields for each ResourceType entry are 'endpoint', 'id', 'name', 'description', 'schema' and 'schemaExtensions'.","parameters":[{"name":"resourceTypeId","in":"path","schema":{"type":"string"},"description":"ID of ResourceType resource.","required":true}],"responses":{"200":{"description":"Returns a single ResourceType resource based on the ID.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"ID of the ResourceType.","type":"string","example":"User"},"name":{"description":"Name of the ResourceType.","type":"string","example":"User"},"endpoint":{"description":"The ResourceType's HTTP addressable endpoint relative to the Base URL.","type":"string","example":"/Applications"},"description":{"description":"Description of the ResourceType.","type":"string","example":"User Account."},"schema":{"description":"The primary/base schema URI of the ResourceType.","type":"string","example":"urn:ietf:params:scim:schemas:sailpoint:1.0:User"},"schemaExtensions":{"description":"A list of URIs of the ResourceType's schema extensions.","type":"array","items":{"example":[{"schema":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","required":true},{"schema":"urn:ietf:params:scim:schemas:sailpoint:1.0:User","required":true}]}},"meta":{"description":"Metadata of the ResourceType.","type":"object","properties":{"location":{"description":"The location of the ResourceType.","type":"string","example":"http://localhost:8080/iiq/scim/v2/ResourceTypes/User"},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"ResourceType"}}},"schemas":{"description":"The schema for the ResourceType resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:core:2.0:ResourceType"]}}}}}}},"method":"get","path":"/ResourceTypes/{resourceTypeId}","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns a ResourceType resource based on ID.","description":{"content":"The ResourceType with the matching ID is returned. The ID is the URN of the SCIM resource. The common fields for each ResourceType entry are 'endpoint', 'id', 'name', 'description', 'schema' and 'schemaExtensions'.","type":"text/plain"},"url":{"path":["ResourceTypes",":resourceTypeId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of ResourceType resource.","type":"text/plain"},"type":"any","value":"","key":"resourceTypeId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns a ResourceType resource based on ID.' (get-resource-type-by-id)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns a ResourceType resource based on ID. + + + +The ResourceType with the matching ID is returned. The ID is the URN of the SCIM resource. The common fields for each ResourceType entry are 'endpoint', 'id', 'name', 'description', 'schema' and 'schemaExtensions'. + +
      Path Parameters
      + +Returns a single ResourceType resource based on the ID. + +
      Schema
        meta object
        + +Metadata of the ResourceType. + +
      \ No newline at end of file diff --git a/products/iiq/api/get-resource-types.api.mdx b/products/iiq/api/get-resource-types.api.mdx new file mode 100644 index 000000000..497c666c6 --- /dev/null +++ b/products/iiq/api/get-resource-types.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-resource-types +sidebar_label: Returns all ResourceType resources. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getResourceTypes","tags":["ResourceTypes"],"description":"All ResourceType resources are listed in the response. The common fields for each ResourceType entry are 'endpoint', 'id', 'name', 'description', 'schema' and 'schemaExtensions'.","responses":{"200":{"description":"Returns all ResourceType resources.","content":{"application/json":{"schema":{"properties":{"totalResults":{"description":"Number of ResourceType resources returned.","type":"integer","example":18},"schemas":{"description":"The ResourceTypes type represented by URN used for this response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"type":"array","items":{"type":"object","properties":{"id":{"description":"ID of the ResourceType.","type":"string","example":"User"},"name":{"description":"Name of the ResourceType.","type":"string","example":"User"},"endpoint":{"description":"The ResourceType's HTTP addressable endpoint relative to the Base URL.","type":"string","example":"/Applications"},"description":{"description":"Description of the ResourceType.","type":"string","example":"User Account."},"schema":{"description":"The primary/base schema URI of the ResourceType.","type":"string","example":"urn:ietf:params:scim:schemas:sailpoint:1.0:User"},"schemaExtensions":{"description":"A list of URIs of the ResourceType's schema extensions.","type":"array","items":{"example":[{"schema":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","required":true},{"schema":"urn:ietf:params:scim:schemas:sailpoint:1.0:User","required":true}]}},"meta":{"description":"Metadata of the ResourceType.","type":"object","properties":{"location":{"description":"The location of the ResourceType.","type":"string","example":"http://localhost:8080/iiq/scim/v2/ResourceTypes/User"},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"ResourceType"}}},"schemas":{"description":"The schema for the ResourceType resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:core:2.0:ResourceType"]}}}}}}},"application/scim+json":{"schema":{"properties":{"totalResults":{"description":"Number of Schema resources returned.","type":"integer","example":18},"schemas":{"description":"The Schema type represented by URN used for this response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"type":"array","items":{"type":"object","properties":{"id":{"description":"ID of the ResourceType.","type":"string","example":"User"},"name":{"description":"Name of the ResourceType.","type":"string","example":"User"},"endpoint":{"description":"The ResourceType's HTTP addressable endpoint relative to the Base URL.","type":"string","example":"/Applications"},"description":{"description":"Description of the ResourceType.","type":"string","example":"User Account."},"schema":{"description":"The primary/base schema URI of the ResourceType.","type":"string","example":"urn:ietf:params:scim:schemas:sailpoint:1.0:User"},"schemaExtensions":{"description":"A list of URIs of the ResourceType's schema extensions.","type":"array","items":{"example":[{"schema":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","required":true},{"schema":"urn:ietf:params:scim:schemas:sailpoint:1.0:User","required":true}]}},"meta":{"description":"Metadata of the ResourceType.","type":"object","properties":{"location":{"description":"The location of the ResourceType.","type":"string","example":"http://localhost:8080/iiq/scim/v2/ResourceTypes/User"},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"ResourceType"}}},"schemas":{"description":"The schema for the ResourceType resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:core:2.0:ResourceType"]}}}}}}}}}},"method":"get","path":"/ResourceTypes","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns all ResourceType resources.","description":{"content":"All ResourceType resources are listed in the response. The common fields for each ResourceType entry are 'endpoint', 'id', 'name', 'description', 'schema' and 'schemaExtensions'.","type":"text/plain"},"url":{"path":["ResourceTypes"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns all ResourceType resources.' (get-resource-types)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns all ResourceType resources. + + + +All ResourceType resources are listed in the response. The common fields for each ResourceType entry are 'endpoint', 'id', 'name', 'description', 'schema' and 'schemaExtensions'. + +
      + +Returns all ResourceType resources. + +
      Schema
        Resources object[]
        meta object
        + +Metadata of the ResourceType. + +
      Schema
        Resources object[]
        meta object
        + +Metadata of the ResourceType. + +
      \ No newline at end of file diff --git a/products/iiq/api/get-role.api.mdx b/products/iiq/api/get-role.api.mdx new file mode 100644 index 000000000..51c69c317 --- /dev/null +++ b/products/iiq/api/get-role.api.mdx @@ -0,0 +1,59 @@ +--- +id: get-role +sidebar_label: Returns a Role resource based on ID or name. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRole","tags":["Roles"],"description":"The Role resource with matching ID or name is returned. Attributes to include in the response can be specified with the 'attributes' query parameter. Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter. The core schema is urn:ietf:params:scim:schemas:sailpoint:1.0:Role.","parameters":[{"name":"roleId","in":"path","schema":{"type":"string"},"description":"ID or name of Role resource.","required":true},{"in":"query","name":"lookupByName","schema":{"type":"boolean"},"description":"A boolean value that determines if the Role resource will be looked up by name instead of Id (value in path parameter 'roleId'). Setting this query parameter to true will cause the value pulled from the 'roleId' path parameter to be treated as a name when searching for the resource.

      **Example**: scim/v2/Roles/**Data Analyst**?**lookupByName=true**"},{"in":"query","name":"attributes","schema":{"type":"string"},"description":"The Role attributes to include in the response. The query parameter value is a comma-separated list of fields to be returned in the response for each Role.

      **Example**: attributes=name,type

      The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for a Role."},{"in":"query","name":"excludedAttributes","schema":{"type":"string"},"description":"The Role attributes to exclude frome the response. The query parameter value is a comma-separated list of fields to be excluded from the response for each Role.

      **Example**: excludedAttributes=permits,requirements

      The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for a Role."}],"responses":{"200":{"description":"Returns a single Role resource based on the ID.","content":{"application/json":{"schema":{"properties":{"id":{"description":"IIQ ID of the Role.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"name":{"description":"Unique name for the Role. This name MUST be unique across the entire set of Roles.","type":"string","example":"ADDirect-Production Manager"},"descriptions":{"description":"A list of localized descriptions of the Role.","type":"array","example":[{"locale":"en_US","value":"Directs production operations and processes for a plant, division, or company. Plans and maintains production schedules. Manages facilities and equipment maintenance."}]},"type":{"description":"The type of the Role.","type":"object","example":{"iiq":false,"requirements":false,"permits":false,"displayName":"IT","manualAssignment":false,"name":"it","autoAssignment":false,"assignmentSelector":false}},"displayableName":{"description":"Displayable name of the Role.","type":"string","example":"Staging Test Engineer - IT"},"active":{"description":"Flag to indicate this Role is enabled or active.","type":"boolean","example":true},"activationDate":{"description":"The date the Role will turn from inactive/disabled to active/enabled.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"deactivationDate":{"description":"The date the Role will turn from active/enabled to inactive/disabled.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"owner":{"description":"The owner of the Role.","type":"object","properties":{"displayName":{"description":"Display name of the Role owner.","type":"string","example":"Lori Ferguson"},"value":{"description":"ID of the Role owner.","type":"string","example":"ac1301737f901991817f90d9eb050372"},"$ref":{"description":"URI reference of the Role owner resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Users/ac1301737f901991817f90d9eb050372"}}},"inheritance":{"description":"Parent Roles this role inherits from.","type":"array","properties":{"displayName":{"description":"Display name of the parent Role.","type":"string","example":"Finance & Accounting"},"value":{"description":"ID of the parent Role.","type":"string","example":"ac1301737f901991817f90d9f054041c"},"$ref":{"description":"URI reference of the parent Role resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9f054041c"}}},"requirements":{"description":"Roles this role requires. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are required to support a business role.","type":"array","properties":{"displayName":{"description":"Display name of the required Role.","type":"string","example":"Accounting General Access - IT"},"value":{"description":"ID of the required Role.","type":"string","example":"ac1301737f901991817f90d9ed110387"},"$ref":{"description":"URI reference of the required Role resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9ed110387"}}},"permits":{"description":"Roles this role permits. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are allowed to support a business role.","type":"array","properties":{"displayName":{"description":"Display name of the permitted Role.","type":"string","example":"Accounts Payable Access - IT"},"value":{"description":"ID of the permitted Role.","type":"string","example":"ac1301737f901991817f90d9ed170388"},"$ref":{"description":"URI reference of the permitted Role resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9ed170388"}}},"classifications":{"description":"Classifications of this Role.","type":"array","example":[{"effective":false,"source":"UI","classification":{"displayName":"Special2","origin":"JDBCDirectDemoData","name":"Special2"}},{"effective":false,"source":"UI","classification":{"displayName":"Special7","origin":"JDBCDirectDemoData","name":"Special7"}}],"properties":{"source":{"description":"The source of the ObjectClassification.","type":"string"},"effective":{"description":"Flag indicating this is an effective Classification.","type":"boolean"},"classification":{"description":"Classification of this Object.","type":"object","properties":{"name":{"description":"The name of the Classification.","type":"string"},"displayName":{"description":"The displayName of the Classification.","type":"string"},"origin":{"description":"The origin of the Classification.","type":"string"},"type":{"description":"The type of the Classification. This can be used to group Classifications in/across different origins.","type":"string"}}}}},"meta":{"description":"Metadata of the SCIM resource.","properties":{"created":{"description":"Datetime this Role was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the SCIM resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Roles/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the Role was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the SCIM resource.","type":"string","example":"W/\\\"1644561244074\\\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"Role"}}},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:Role"]}}}}}}},"method":"get","path":"/Roles/{roleId}","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns a Role resource based on ID or name.","description":{"content":"The Role resource with matching ID or name is returned. Attributes to include in the response can be specified with the 'attributes' query parameter. Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter. The core schema is urn:ietf:params:scim:schemas:sailpoint:1.0:Role.","type":"text/plain"},"url":{"path":["Roles",":roleId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A boolean value that determines if the Role resource will be looked up by name instead of Id (value in path parameter 'roleId'). Setting this query parameter to true will cause the value pulled from the 'roleId' path parameter to be treated as a name when searching for the resource.

      **Example**: scim/v2/Roles/**Data Analyst**?**lookupByName=true**","type":"text/plain"},"key":"lookupByName","value":""},{"disabled":false,"description":{"content":"The Role attributes to include in the response. The query parameter value is a comma-separated list of fields to be returned in the response for each Role.

      **Example**: attributes=name,type

      The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for a Role.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"The Role attributes to exclude frome the response. The query parameter value is a comma-separated list of fields to be excluded from the response for each Role.

      **Example**: excludedAttributes=permits,requirements

      The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for a Role.","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ID or name of Role resource.","type":"text/plain"},"type":"any","value":"","key":"roleId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns a Role resource based on ID or name.' (get-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns a Role resource based on ID or name. + + + +The Role resource with matching ID or name is returned. Attributes to include in the response can be specified with the 'attributes' query parameter. Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter. The core schema is urn:ietf:params:scim:schemas:sailpoint:1.0:Role. + +
      Path Parameters
      Query Parameters

        **Example**: scim/v2/Roles/**Data Analyst**?**lookupByName=true**"}}>
        **Example**: attributes=name,type

        The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for a Role."}}>
        **Example**: excludedAttributes=permits,requirements

        The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for a Role."}}>
      + +Returns a single Role resource based on the ID. + +
      Schema
        owner object
        + +The owner of the Role. + +
        inheritance array
        + +Parent Roles this role inherits from. + +
        requirements array
        + +Roles this role requires. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are required to support a business role. + +
        permits array
        + +Roles this role permits. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are allowed to support a business role. + +
        classifications array
        + +Classifications of this Role. + +
        classification object
        + +Classification of this Object. + +
        meta
        + +Metadata of the SCIM resource. + +
      \ No newline at end of file diff --git a/products/iiq/api/get-roles.api.mdx b/products/iiq/api/get-roles.api.mdx new file mode 100644 index 000000000..01c0565b3 --- /dev/null +++ b/products/iiq/api/get-roles.api.mdx @@ -0,0 +1,91 @@ +--- +id: get-roles +sidebar_label: Returns all Role resources. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getRoles","tags":["Roles"],"description":"This endpoint returns all Role resources. Attributes to include in the response can be specified with the 'attributes' query parameter. Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter. The core schema is urn:ietf:params:scim:schemas:sailpoint:1.0:Role.","parameters":[{"in":"query","name":"filter","schema":{"type":"string"},"description":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.

      **Example**: filter=name eq \"Data Analyst\""},{"in":"query","name":"sortBy","schema":{"type":"string"},"description":"Allows sorting the results by a resource's attributes.

      **Example**: sortBy=\"name\""},{"in":"query","name":"sortOrder","schema":{"type":"string"},"description":"Determines what order to sort results in.

      **Example**: sortOrder=\"descending\""},{"in":"query","name":"startIndex","schema":{"type":"integer"},"description":"Determines the starting index of the result set.

      **Example**: startIndex=1100"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Specifies the number of results per page.

      **Example**: count=10"},{"in":"query","name":"attributes","schema":{"type":"string"},"description":"The Role attributes to include in the response. The query parameter value is a comma-separated list of fields to be returned in the response for each Role.

      **Example**: attributes=name,type,classifications

      The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for a Role."},{"in":"query","name":"excludedAttributes","schema":{"type":"string"},"description":"The Role attributes to exclude frome the response. The query parameter value is a comma-separated list of fields to be excluded from the response for each Role.

      **Example**: excludedAttributes=permits,requirements,inheritance

      The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for a Role."}],"responses":{"200":{"description":"Returns all SCIM Role resources.","content":{"application/json":{"schema":{"properties":{"totalResults":{"description":"Number of Role resources returned","type":"integer","example":"18,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"type":"array","items":{"properties":{"id":{"description":"IIQ ID of the Role.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"name":{"description":"Unique name for the Role. This name MUST be unique across the entire set of Roles.","type":"string","example":"ADDirect-Production Manager"},"descriptions":{"description":"A list of localized descriptions of the Role.","type":"array","example":[{"locale":"en_US","value":"Directs production operations and processes for a plant, division, or company. Plans and maintains production schedules. Manages facilities and equipment maintenance."}]},"type":{"description":"The type of the Role.","type":"object","example":{"iiq":false,"requirements":false,"permits":false,"displayName":"IT","manualAssignment":false,"name":"it","autoAssignment":false,"assignmentSelector":false}},"displayableName":{"description":"Displayable name of the Role.","type":"string","example":"Staging Test Engineer - IT"},"active":{"description":"Flag to indicate this Role is enabled or active.","type":"boolean","example":true},"activationDate":{"description":"The date the Role will turn from inactive/disabled to active/enabled.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"deactivationDate":{"description":"The date the Role will turn from active/enabled to inactive/disabled.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"owner":{"description":"The owner of the Role.","type":"object","properties":{"displayName":{"description":"Display name of the Role owner.","type":"string","example":"Lori Ferguson"},"value":{"description":"ID of the Role owner.","type":"string","example":"ac1301737f901991817f90d9eb050372"},"$ref":{"description":"URI reference of the Role owner resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Users/ac1301737f901991817f90d9eb050372"}}},"inheritance":{"description":"Parent Roles this role inherits from.","type":"array","properties":{"displayName":{"description":"Display name of the parent Role.","type":"string","example":"Finance & Accounting"},"value":{"description":"ID of the parent Role.","type":"string","example":"ac1301737f901991817f90d9f054041c"},"$ref":{"description":"URI reference of the parent Role resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9f054041c"}}},"requirements":{"description":"Roles this role requires. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are required to support a business role.","type":"array","properties":{"displayName":{"description":"Display name of the required Role.","type":"string","example":"Accounting General Access - IT"},"value":{"description":"ID of the required Role.","type":"string","example":"ac1301737f901991817f90d9ed110387"},"$ref":{"description":"URI reference of the required Role resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9ed110387"}}},"permits":{"description":"Roles this role permits. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are allowed to support a business role.","type":"array","properties":{"displayName":{"description":"Display name of the permitted Role.","type":"string","example":"Accounts Payable Access - IT"},"value":{"description":"ID of the permitted Role.","type":"string","example":"ac1301737f901991817f90d9ed170388"},"$ref":{"description":"URI reference of the permitted Role resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9ed170388"}}},"classifications":{"description":"Classifications of this Role.","type":"array","example":[{"effective":false,"source":"UI","classification":{"displayName":"Special2","origin":"JDBCDirectDemoData","name":"Special2"}},{"effective":false,"source":"UI","classification":{"displayName":"Special7","origin":"JDBCDirectDemoData","name":"Special7"}}],"properties":{"source":{"description":"The source of the ObjectClassification.","type":"string"},"effective":{"description":"Flag indicating this is an effective Classification.","type":"boolean"},"classification":{"description":"Classification of this Object.","type":"object","properties":{"name":{"description":"The name of the Classification.","type":"string"},"displayName":{"description":"The displayName of the Classification.","type":"string"},"origin":{"description":"The origin of the Classification.","type":"string"},"type":{"description":"The type of the Classification. This can be used to group Classifications in/across different origins.","type":"string"}}}}},"meta":{"description":"Metadata of the SCIM resource.","properties":{"created":{"description":"Datetime this Role was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the SCIM resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Roles/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the Role was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the SCIM resource.","type":"string","example":"W/\\\"1644561244074\\\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"Role"}}},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:Role"]}}}}}}},"application/scim+json":{"schema":{"properties":{"totalResults":{"description":"Number of Role resources returned.","type":"integer","example":"1500,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"description":"The SCIM resources returned for this endpoint.","type":"array","items":{"properties":{"id":{"description":"IIQ ID of the Role.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"name":{"description":"Unique name for the Role. This name MUST be unique across the entire set of Roles.","type":"string","example":"ADDirect-Production Manager"},"descriptions":{"description":"A list of localized descriptions of the Role.","type":"array","example":[{"locale":"en_US","value":"Directs production operations and processes for a plant, division, or company. Plans and maintains production schedules. Manages facilities and equipment maintenance."}]},"type":{"description":"The type of the Role.","type":"object","example":{"iiq":false,"requirements":false,"permits":false,"displayName":"IT","manualAssignment":false,"name":"it","autoAssignment":false,"assignmentSelector":false}},"displayableName":{"description":"Displayable name of the Role.","type":"string","example":"Staging Test Engineer - IT"},"active":{"description":"Flag to indicate this Role is enabled or active.","type":"boolean","example":true},"activationDate":{"description":"The date the Role will turn from inactive/disabled to active/enabled.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"deactivationDate":{"description":"The date the Role will turn from active/enabled to inactive/disabled.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"owner":{"description":"The owner of the Role.","type":"object","properties":{"displayName":{"description":"Display name of the Role owner.","type":"string","example":"Lori Ferguson"},"value":{"description":"ID of the Role owner.","type":"string","example":"ac1301737f901991817f90d9eb050372"},"$ref":{"description":"URI reference of the Role owner resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Users/ac1301737f901991817f90d9eb050372"}}},"inheritance":{"description":"Parent Roles this role inherits from.","type":"array","properties":{"displayName":{"description":"Display name of the parent Role.","type":"string","example":"Finance & Accounting"},"value":{"description":"ID of the parent Role.","type":"string","example":"ac1301737f901991817f90d9f054041c"},"$ref":{"description":"URI reference of the parent Role resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9f054041c"}}},"requirements":{"description":"Roles this role requires. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are required to support a business role.","type":"array","properties":{"displayName":{"description":"Display name of the required Role.","type":"string","example":"Accounting General Access - IT"},"value":{"description":"ID of the required Role.","type":"string","example":"ac1301737f901991817f90d9ed110387"},"$ref":{"description":"URI reference of the required Role resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9ed110387"}}},"permits":{"description":"Roles this role permits. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are allowed to support a business role.","type":"array","properties":{"displayName":{"description":"Display name of the permitted Role.","type":"string","example":"Accounts Payable Access - IT"},"value":{"description":"ID of the permitted Role.","type":"string","example":"ac1301737f901991817f90d9ed170388"},"$ref":{"description":"URI reference of the permitted Role resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9ed170388"}}},"classifications":{"description":"Classifications of this Role.","type":"array","example":[{"effective":false,"source":"UI","classification":{"displayName":"Special2","origin":"JDBCDirectDemoData","name":"Special2"}},{"effective":false,"source":"UI","classification":{"displayName":"Special7","origin":"JDBCDirectDemoData","name":"Special7"}}],"properties":{"source":{"description":"The source of the ObjectClassification.","type":"string"},"effective":{"description":"Flag indicating this is an effective Classification.","type":"boolean"},"classification":{"description":"Classification of this Object.","type":"object","properties":{"name":{"description":"The name of the Classification.","type":"string"},"displayName":{"description":"The displayName of the Classification.","type":"string"},"origin":{"description":"The origin of the Classification.","type":"string"},"type":{"description":"The type of the Classification. This can be used to group Classifications in/across different origins.","type":"string"}}}}},"meta":{"description":"Metadata of the SCIM resource.","properties":{"created":{"description":"Datetime this Role was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the SCIM resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Roles/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the Role was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the SCIM resource.","type":"string","example":"W/\\\"1644561244074\\\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"Role"}}},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:Role"]}}}}}}}}}},"method":"get","path":"/Roles","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns all Role resources.","description":{"content":"This endpoint returns all Role resources. Attributes to include in the response can be specified with the 'attributes' query parameter. Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter. The core schema is urn:ietf:params:scim:schemas:sailpoint:1.0:Role.","type":"text/plain"},"url":{"path":["Roles"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.

      **Example**: filter=name eq \"Data Analyst\"","type":"text/plain"},"key":"filter","value":""},{"disabled":false,"description":{"content":"Allows sorting the results by a resource's attributes.

      **Example**: sortBy=\"name\"","type":"text/plain"},"key":"sortBy","value":""},{"disabled":false,"description":{"content":"Determines what order to sort results in.

      **Example**: sortOrder=\"descending\"","type":"text/plain"},"key":"sortOrder","value":""},{"disabled":false,"description":{"content":"Determines the starting index of the result set.

      **Example**: startIndex=1100","type":"text/plain"},"key":"startIndex","value":""},{"disabled":false,"description":{"content":"Specifies the number of results per page.

      **Example**: count=10","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"The Role attributes to include in the response. The query parameter value is a comma-separated list of fields to be returned in the response for each Role.

      **Example**: attributes=name,type,classifications

      The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for a Role.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"The Role attributes to exclude frome the response. The query parameter value is a comma-separated list of fields to be excluded from the response for each Role.

      **Example**: excludedAttributes=permits,requirements,inheritance

      The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for a Role.","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns all Role resources.' (get-roles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns all Role resources. + + + +This endpoint returns all Role resources. Attributes to include in the response can be specified with the 'attributes' query parameter. Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter. The core schema is urn:ietf:params:scim:schemas:sailpoint:1.0:Role. + +
      Query Parameters

        **Example**: filter=name eq \"Data Analyst\""}}>
        **Example**: sortBy=\"name\""}}>
        **Example**: sortOrder=\"descending\""}}>
        **Example**: startIndex=1100"}}>
        **Example**: count=10"}}>
        **Example**: attributes=name,type,classifications

        The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for a Role."}}>
        **Example**: excludedAttributes=permits,requirements,inheritance

        The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for a Role."}}>
      + +Returns all SCIM Role resources. + +
      Schema
        Resources undefined[]
        owner object
        + +The owner of the Role. + +
        inheritance array
        + +Parent Roles this role inherits from. + +
        requirements array
        + +Roles this role requires. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are required to support a business role. + +
        permits array
        + +Roles this role permits. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are allowed to support a business role. + +
        classifications array
        + +Classifications of this Role. + +
        classification object
        + +Classification of this Object. + +
        meta
        + +Metadata of the SCIM resource. + +
      Schema
        Resources undefined[]
        + +The SCIM resources returned for this endpoint. + +
        owner object
        + +The owner of the Role. + +
        inheritance array
        + +Parent Roles this role inherits from. + +
        requirements array
        + +Roles this role requires. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are required to support a business role. + +
        permits array
        + +Roles this role permits. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are allowed to support a business role. + +
        classifications array
        + +Classifications of this Role. + +
        classification object
        + +Classification of this Object. + +
        meta
        + +Metadata of the SCIM resource. + +
      \ No newline at end of file diff --git a/products/iiq/api/get-schema-by-id.api.mdx b/products/iiq/api/get-schema-by-id.api.mdx new file mode 100644 index 000000000..174232fc4 --- /dev/null +++ b/products/iiq/api/get-schema-by-id.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-schema-by-id +sidebar_label: Returns a Schema based on id. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getSchemaById","tags":["Schemas"],"description":"The Schema with the matching id is returned. The id is the URN of the SCIM resource. The 'attributes' field holds the schema-specific attributes which differ depending on Schema type.","parameters":[{"name":"schemaId","in":"path","schema":{"type":"string"},"description":"The id of the Schema.","required":true}],"responses":{"200":{"description":"Returns a single Schema based on the id.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The id of the Schema. The id is the SCIM URN of the Schema.","type":"string","example":"urn:ietf:params:scim:schemas:sailpoint:1.0:User"},"name":{"description":"Name of the Schema.","type":"string","example":"User"},"description":{"description":"Description of the Schema.","type":"string","example":"Schema for a SCIM User."},"attributes":{"description":"Attributes used to describe this Schema.","type":"array","items":{"properties":{"uniqueness":{"description":"Determines whether there can be other Schema resources with the same value for this attribute. 'none' means there is no concern for uniqueness, 'server' means the uniqueness of this attribute should be guaranteed for this type of resource, and 'global' means the uniqueness should be guaranteed across all resources.","type":"string","example":"none"},"name":{"description":"Name of the attribute.","type":"string","example":"displayName"},"description":{"description":"Description of the attribute.","type":"string","example":"Display name of the User."},"mutability":{"description":"Indicates the ability to change this attribute. Possible values are 'readOnly', 'readWrite', and 'writeOnly'.","type":"string","example":"readOnly"},"type":{"description":"Defined as 'simple' or 'complex', where simple indicates attribute values stored as strings, integers, etc., and complex indicates object-based values.","type":"string","example":"string"},"multiValued":{"description":"Describes whether this attribute is allowed multiple values.","type":"boolean","example":false},"caseExact":{"description":"True if attribute value is case-sensitive; false otherwise.","type":"boolean","example":false},"returned":{"description":"Dictates whether the attribute should be returned in a SCIM response body. Can be 'always', 'default', 'request', or 'never'.","type":"string","example":"default"},"required":{"description":"True if this attribute is required for this Schema; false otherwise.","type":"boolean","example":false},"canonicalValues":{"description":"List of canonical values that could be used to supplement attribute.","type":"array","items":{"type":"string"},"example":["httpbasic","httpdigest","oauth"]},"subAttributes":{"description":"Only required if 'complex' is specified for 'type'. If this attribute is of 'complex' type, an array of objects can be stored in 'subAttributes' with attributes relevant to the respective Schema.","type":"array","items":{"additionalProperties":{"anyOf":[{"type":"object"}]}}}}}},"meta":{"description":"Metadata of the Schema.","type":"object","properties":{"location":{"description":"The location of the Schema.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Schemas/7f0123417e941b00007f9db3702906cb"},"version":{"description":"The version of the Schema.","type":"string","example":"W\"1647617443639\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"Schema"}}},"schemas":{"description":"The schema for the Schema resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:core:2.0:Schema"]}}}}}}},"method":"get","path":"/Schemas/{schemaId}","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns a Schema based on id.","description":{"content":"The Schema with the matching id is returned. The id is the URN of the SCIM resource. The 'attributes' field holds the schema-specific attributes which differ depending on Schema type.","type":"text/plain"},"url":{"path":["Schemas",":schemaId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The id of the Schema.","type":"text/plain"},"type":"any","value":"","key":"schemaId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns a Schema based on id.' (get-schema-by-id)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns a Schema based on id. + + + +The Schema with the matching id is returned. The id is the URN of the SCIM resource. The 'attributes' field holds the schema-specific attributes which differ depending on Schema type. + +
      Path Parameters
      + +Returns a single Schema based on the id. + +
      Schema
        attributes undefined[]
        + +Attributes used to describe this Schema. + +
        meta object
        + +Metadata of the Schema. + +
      \ No newline at end of file diff --git a/products/iiq/api/get-schemas.api.mdx b/products/iiq/api/get-schemas.api.mdx new file mode 100644 index 000000000..e2e129606 --- /dev/null +++ b/products/iiq/api/get-schemas.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-schemas +sidebar_label: Returns all Schema resources. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getSchemas","tags":["Schemas"],"description":"All Schema resources are listed in the response. The 'attributes' field holds the schema-specific attributes which differ depending on Schema type.","responses":{"200":{"description":"Returns all Schema resources.","content":{"application/json":{"schema":{"properties":{"totalResults":{"description":"Number of Schemas returned.","type":"integer","example":18},"schemas":{"description":"The Schema type used for this response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The id of the Schema. The id is the SCIM URN of the Schema.","type":"string","example":"urn:ietf:params:scim:schemas:sailpoint:1.0:User"},"name":{"description":"Name of the Schema.","type":"string","example":"User"},"description":{"description":"Description of the Schema.","type":"string","example":"Schema for a SCIM User."},"attributes":{"description":"Attributes used to describe this Schema.","type":"array","items":{"properties":{"uniqueness":{"description":"Determines whether there can be other Schema resources with the same value for this attribute. 'none' means there is no concern for uniqueness, 'server' means the uniqueness of this attribute should be guaranteed for this type of resource, and 'global' means the uniqueness should be guaranteed across all resources.","type":"string","example":"none"},"name":{"description":"Name of the attribute.","type":"string","example":"displayName"},"description":{"description":"Description of the attribute.","type":"string","example":"Display name of the User."},"mutability":{"description":"Indicates the ability to change this attribute. Possible values are 'readOnly', 'readWrite', and 'writeOnly'.","type":"string","example":"readOnly"},"type":{"description":"Defined as 'simple' or 'complex', where simple indicates attribute values stored as strings, integers, etc., and complex indicates object-based values.","type":"string","example":"string"},"multiValued":{"description":"Describes whether this attribute is allowed multiple values.","type":"boolean","example":false},"caseExact":{"description":"True if attribute value is case-sensitive; false otherwise.","type":"boolean","example":false},"returned":{"description":"Dictates whether the attribute should be returned in a SCIM response body. Can be 'always', 'default', 'request', or 'never'.","type":"string","example":"default"},"required":{"description":"True if this attribute is required for this Schema; false otherwise.","type":"boolean","example":false},"canonicalValues":{"description":"List of canonical values that could be used to supplement attribute.","type":"array","items":{"type":"string"},"example":["httpbasic","httpdigest","oauth"]},"subAttributes":{"description":"Only required if 'complex' is specified for 'type'. If this attribute is of 'complex' type, an array of objects can be stored in 'subAttributes' with attributes relevant to the respective Schema.","type":"array","items":{"additionalProperties":{"anyOf":[{"type":"object"}]}}}}}},"meta":{"description":"Metadata of the Schema.","type":"object","properties":{"location":{"description":"The location of the Schema.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Schemas/7f0123417e941b00007f9db3702906cb"},"version":{"description":"The version of the Schema.","type":"string","example":"W\"1647617443639\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"Schema"}}},"schemas":{"description":"The schema for the Schema resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:core:2.0:Schema"]}}}}}}},"application/scim+json":{"schema":{"properties":{"totalResults":{"description":"Number of Schemas returned.","type":"integer","example":18},"schemas":{"description":"The Schema type used for this response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The id of the Schema. The id is the SCIM URN of the Schema.","type":"string","example":"urn:ietf:params:scim:schemas:sailpoint:1.0:User"},"name":{"description":"Name of the Schema.","type":"string","example":"User"},"description":{"description":"Description of the Schema.","type":"string","example":"Schema for a SCIM User."},"attributes":{"description":"Attributes used to describe this Schema.","type":"array","items":{"properties":{"uniqueness":{"description":"Determines whether there can be other Schema resources with the same value for this attribute. 'none' means there is no concern for uniqueness, 'server' means the uniqueness of this attribute should be guaranteed for this type of resource, and 'global' means the uniqueness should be guaranteed across all resources.","type":"string","example":"none"},"name":{"description":"Name of the attribute.","type":"string","example":"displayName"},"description":{"description":"Description of the attribute.","type":"string","example":"Display name of the User."},"mutability":{"description":"Indicates the ability to change this attribute. Possible values are 'readOnly', 'readWrite', and 'writeOnly'.","type":"string","example":"readOnly"},"type":{"description":"Defined as 'simple' or 'complex', where simple indicates attribute values stored as strings, integers, etc., and complex indicates object-based values.","type":"string","example":"string"},"multiValued":{"description":"Describes whether this attribute is allowed multiple values.","type":"boolean","example":false},"caseExact":{"description":"True if attribute value is case-sensitive; false otherwise.","type":"boolean","example":false},"returned":{"description":"Dictates whether the attribute should be returned in a SCIM response body. Can be 'always', 'default', 'request', or 'never'.","type":"string","example":"default"},"required":{"description":"True if this attribute is required for this Schema; false otherwise.","type":"boolean","example":false},"canonicalValues":{"description":"List of canonical values that could be used to supplement attribute.","type":"array","items":{"type":"string"},"example":["httpbasic","httpdigest","oauth"]},"subAttributes":{"description":"Only required if 'complex' is specified for 'type'. If this attribute is of 'complex' type, an array of objects can be stored in 'subAttributes' with attributes relevant to the respective Schema.","type":"array","items":{"additionalProperties":{"anyOf":[{"type":"object"}]}}}}}},"meta":{"description":"Metadata of the Schema.","type":"object","properties":{"location":{"description":"The location of the Schema.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Schemas/7f0123417e941b00007f9db3702906cb"},"version":{"description":"The version of the Schema.","type":"string","example":"W\"1647617443639\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"Schema"}}},"schemas":{"description":"The schema for the Schema resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:core:2.0:Schema"]}}}}}}}}}},"method":"get","path":"/Schemas","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns all Schema resources.","description":{"content":"All Schema resources are listed in the response. The 'attributes' field holds the schema-specific attributes which differ depending on Schema type.","type":"text/plain"},"url":{"path":["Schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns all Schema resources.' (get-schemas)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns all Schema resources. + + + +All Schema resources are listed in the response. The 'attributes' field holds the schema-specific attributes which differ depending on Schema type. + +
      + +Returns all Schema resources. + +
      Schema
        Resources object[]
        attributes undefined[]
        + +Attributes used to describe this Schema. + +
        meta object
        + +Metadata of the Schema. + +
      Schema
        Resources object[]
        attributes undefined[]
        + +Attributes used to describe this Schema. + +
        meta object
        + +Metadata of the Schema. + +
      \ No newline at end of file diff --git a/products/iiq/api/get-task-result-by-id.api.mdx b/products/iiq/api/get-task-result-by-id.api.mdx new file mode 100644 index 000000000..8ee3333ae --- /dev/null +++ b/products/iiq/api/get-task-result-by-id.api.mdx @@ -0,0 +1,40 @@ +--- +id: get-task-result-by-id +sidebar_label: Returns a TaskResult resource based on id. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getTaskResultById","tags":["TaskResults"],"description":"The TaskResult resource with matching id is returned.

      \nAttributes to include in the response can be specified with the attributes query parameter.

      \nAttributes to exclude from the response can be specified with the excludedAttributes query parameter.

      \nThe schema related to TaskResult is:\n- **urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult**\n","parameters":[{"name":"taskResultId","in":"path","schema":{"type":"string","example":"c0a8019c802d1e5a81802eb2b57e020f"},"description":"id of TaskResult resource.","required":true},{"in":"query","name":"attributes","schema":{"type":"string","example":"host"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"name, messages"},"description":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**"}],"responses":{"200":{"description":"Returns a single TaskResult resource based on the id.","content":{"application/json":{"schema":{"properties":{"id":{"description":"Unique identifier of the TaskResult.","type":"string","example":"c0a8019c80761c398180856488d2051d"},"name":{"description":"Name of the TaskResult.","type":"string","example":"Aggregate Composite Application"},"type":{"description":"Type of the TaskResult.","type":"string","example":"AccountAggregation"},"completionStatus":{"type":"string","description":"Completion Status of the TaskResult.","enum":["Success","Warning","Error","Terminated","TempError"],"example":"Success"},"launcher":{"description":"Launcher of the TaskResult.","type":"string","example":"james.smith"},"host":{"description":"Host of the TaskResult.","type":"string","example":"mandrake.testdomain.com"},"progress":{"description":"Progress of the TaskResult.","type":"string","example":"3/5 tasks completed."},"targetClass":{"description":"Target Class of the TaskResult.","type":"string","example":"Permission"},"targetName":{"description":"Target Name of the Task Result.","type":"string","example":"Adam.Kennedy"},"terminated":{"description":"Flag to indicate this TaskResult is terminated.","type":"boolean","example":false},"partitioned":{"description":"Flag to indicate this TaskResult is partitioned.","type":"boolean","example":true},"launched":{"type":"string","format":"date-time","description":"The launched DateTime of the TaskResult.","example":"2022-05-02T10:30:00.014-05:00"},"completed":{"type":"string","format":"date-time","description":"The completed DateTime of the TaskResult.","example":"2022-05-02T10:30:00.035-05:00"},"expiration":{"type":"string","format":"date-time","description":"The expiration DateTime of the TaskResult.","example":"2022-05-03T16:40:34.271-05:00"},"verified":{"type":"string","format":"date-time","description":"The verification DateTime of the TaskResult.","example":"2022-05-03T16:40:34.271-05:00"},"percentageComplete":{"type":"integer","description":"The percentage completed of this TaskResult.","example":30},"pendingSignOffs":{"description":"The number of pending signoffs of this TaskResult.","type":"integer","example":0},"taskDefinition":{"type":"string","description":"Name of the TaskDefinition of the TaskResult.","example":"Workflow Launcher"},"taskSchedule":{"description":"Name of the TaskSchedule of the TaskResult.","type":"string","example":"Perform Identity Request Maintenance"},"attributes":{"description":"A list of attributes of the TaskResult.","type":"array","items":{"properties":{"key":{"description":"The attribute key.","type":"string","example":"inactiveWorkItemsForwarded"},"value":{"description":"The attribute value.","type":"string","example":"0"}}}},"messages":{"description":"List of messages of the TaskResult.","type":"array","items":{"example":["Partition 2 is pending."]}},"meta":{"type":"object","properties":{"created":{"description":"DateTime when the TaskResult was created.","type":"string","format":"date-time","example":"2022-05-02T10:30:00.018-05:00"},"location":{"description":"URL to the TaskResult.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/TaskResults/c0a8019c80761c398180856488d2051d"},"lastModified":{"description":"DateTime of TaskResult last modification.","type":"string","format":"date-time","example":"2022-05-02T10:30:00.036-05:00"},"version":{"description":"TaskResult version.","type":"string","example":"W\"1651505400036\""},"resourceType":{"description":"Resource type of the metadata subject.","type":"string","example":"TaskResult"}}},"schemas":{"type":"array","example":["urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult"]}}}}}}},"method":"get","path":"/TaskResults/{taskResultId}","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns a TaskResult resource based on id.","description":{"content":"The TaskResult resource with matching id is returned.

      \nAttributes to include in the response can be specified with the attributes query parameter.

      \nAttributes to exclude from the response can be specified with the excludedAttributes query parameter.

      \nThe schema related to TaskResult is:\n- **urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult**\n","type":"text/plain"},"url":{"path":["TaskResults",":taskResultId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) id of TaskResult resource.","type":"text/plain"},"type":"any","value":"","key":"taskResultId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns a TaskResult resource based on id.' (get-task-result-by-id)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns a TaskResult resource based on id. + + + +The TaskResult resource with matching id is returned.

      +Attributes to include in the response can be specified with the attributes query parameter.

      +Attributes to exclude from the response can be specified with the excludedAttributes query parameter.

      +The schema related to TaskResult is: +- **urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult** + + +
      Path Parameters
      Query Parameters
      + +Returns a single TaskResult resource based on the id. + +
      Schema
        attributes undefined[]
        + +A list of attributes of the TaskResult. + +
        meta object
      \ No newline at end of file diff --git a/products/iiq/api/get-user-by-id.api.mdx b/products/iiq/api/get-user-by-id.api.mdx new file mode 100644 index 000000000..4fa6bca00 --- /dev/null +++ b/products/iiq/api/get-user-by-id.api.mdx @@ -0,0 +1,127 @@ +--- +id: get-user-by-id +sidebar_label: Returns a User resource based on id. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getUserById","tags":["Users"],"description":"The User resource with matching id is returned. There are attributes marked as 'returned only by request', such as **roles**, which must be provided as part of the **attributes** query parameter in order to be included in the response.","parameters":[{"name":"userId","in":"path","schema":{"type":"string","example":"c7c7777c7ef77e77777ee77e7a1f0444"},"description":"The id of User resource. If **lookupByName** is set to **true**, this path parameter should be set to the **userName** of the User.","required":true},{"in":"query","name":"attributes","schema":{"type":"string","example":"userName,nativeIdentity"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"userName,manuallyCorrelated"},"description":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*"},{"in":"query","name":"lookupByName","schema":{"type":"boolean","example":false,"default":false},"description":"A boolean value that determines if the User resource will be looked up by userName instead of userId (value in path parameter 'userId'). Setting this query parameter to true will cause the value pulled from the 'userId' path parameter to be treated as a userName when searching for the resource.

      **Example**: scim/v2/Users/**Mock.User**?**lookupByName=true**"}],"responses":{"200":{"description":"Returns a single User resource based on the id.","content":{"application/json":{"schema":{"properties":{"id":{"description":"IdentityIQ id of the User.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"userName":{"description":"Unique identifier for the User. Typically used to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the entire set of Users. Cannot be changed.","type":"string","example":"Mock.User"},"name":{"description":"The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.","properties":{"formatted":{"description":"The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.","type":"string","example":"Ms. Barbara J Jensen, III"},"familyName":{"description":"The family name of the User, or Last Name in most Western languages","type":"string","example":"Jensen"},"givenName":{"description":"The given name of the User, or First Name in most Western languages","type":"string","example":"Barbara"}}},"displayName":{"description":"The name of the User, suitable for display to end-users. The name should be the full name of the User being described.","type":"string","example":"Barbara Jensen"},"userType":{"description":"The type of the User, identifying the relationship between the organization and the User.","type":"string","example":"employee"},"active":{"description":"A Boolean value indicating the User’s administrative status.","type":"boolean","example":true},"emails":{"description":"Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.","type":"array","items":{"properties":{"type":{"description":"Type of email address (work, home, other).","type":"string","example":"work"},"value":{"description":"Canonicalized email address.","type":"string","format":"email","example":"Barbara.Jensen@example.com"},"primary":{"description":"A Boolean value indicating the primary e-mail address. The primary attribute value 'true' MUST appear no more than once.","type":"boolean","example":"true"}}}},"urn:ietf:params:scim:schemas:sailpoint:1.0:User":{"description":"Additional attributes of the User.","type":"object","properties":{"accounts":{"description":"Simple representation of the Account (or Link) ResourceType.","type":"array","items":{"properties":{"displayName":{"description":"The display name of the Account.","type":"string","example":"Bob.Smith"},"value":{"description":"The id of the SCIM resource representing the Account.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"The URI of the SCIM resource representing the Account.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Accounts/c0a7778b7ef71e79817ee74e6a1f0444"}}}},"entitlements":{"description":"Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter.","type":"array","items":{"properties":{"value":{"description":"The value of the Entitlement.","type":"string","example":"groupmbr"},"display":{"description":"The display name of the Entitlement.","type":"string","example":"HelpDesk"},"type":{"description":"The type of Entitlement (Entitlement, Permission, etc.).","type":"string","example":"Permission"},"application":{"description":"The name of the Application this Entitlement applies to.","type":"string","example":"ADMockApp"},"accountName":{"description":"The account this Entitlement was sourced from.","type":"string","example":"CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com"},"$ref":{"description":"The URI of the SCIM resource representing the Entitlement.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Entitlements/c0a7777a7f74744d817e74fc12362c67"}}}},"roles":{"description":"Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter.","type":"array","items":{"properties":{"value":{"description":"The value of the Role.","type":"string","example":"detectedRoles"},"display":{"description":"The display name of the Role.","type":"string","example":"User - IT"},"type":{"description":"The type of Role (IT, Business, etc.).","type":"string","example":"it"},"acquired":{"description":"Indicates how this Role was acquired. Assigned or Detected.","type":"string","example":"Assigned"},"application":{"description":"The name of the Application where this Role came from.","type":"string","example":"Active_Directory"},"accountName":{"description":"The name of the Account this Role was sourced from.","type":"string","example":"CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com"},"$ref":{"description":"The URI of the SCIM resource representing the Role.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Roles/c0a7777a7f74744d817e74fc12362c67"}}}},"capabilities":{"description":"Capabilities assigned to this User.","type":"array","items":{"type":"string"},"example":"[\"SystemAdministrator\"]"},"riskScore":{"description":"Composite Risk Score of this User.","type":"integer","example":125},"isManager":{"description":"A Boolean value that determines if this User is a manager.","type":"boolean","example":false},"administrator":{"description":"The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service.","properties":{"displayName":{"description":"The display name of the Administrator of RPA user or Service account.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the SCIM resource representing the Administrator of RPA user or Service account.","type":"string","example":"c0a7777a7f74744d817e74fc12362c67O"},"$ref":{"description":"The URI of the SCIM resource representing the Administrator of RPA user or Service Account.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67"}}},"softwareVersion":{"description":"The software version of the RPA/Bots.","type":"string","example":"7.3"},"empId":{"description":"Employee id associated with this User.","type":"string","example":"1b2a3c"},"dn":{"description":"Distinguished name for this User.","type":"string","example":"cn=Bob Smith,ou=services"},"region":{"description":"The region this User is assigned to.","type":"string","example":"Americas"},"regionOwner":{"description":"The User who owns the region that this resource (User) belongs to.","properties":{"displayName":{"description":"Display name of the region owner.","type":"string","example":"Joe Smith"},"value":{"description":"The id of the region owner.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"$ref":{"description":"URI reference of the region owner resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"}}},"location":{"description":"The location this User is assigned to.","type":"string","example":"Singapore"},"locationOwner":{"description":"The User who owns the location that this resource (User) belongs to.","type":"object","properties":{"displayName":{"description":"Display name of the location owner.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the location owner.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"URI reference to the location owner resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"Department":{"description":"Department this User is assigned to.","type":"string","example":"Regional Operations"},"costcenter":{"description":"Cost centers this User is associated with.","type":"array","items":{"type":"string"},"example":["CC01","DD02"]},"jobtitle":{"description":"Job title given to this User.","type":"string","example":"Internal Audit Manager"},"lastRefresh":{"description":"Datetime representation of the last refresh for this User.","type":"string","format":"date-time"}}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"description":"Enterprise User Schema. Contains the manager of the User.","properties":{"manager":{"description":"Manager of the User.","properties":{"displayName":{"description":"Display name of the User's manager.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the SCIM resource representing the User’s manager.","type":"string","example":"c7a7347a7fe71e69077ee75f5d1f1237"},"$ref":{"description":"The URI of the SCIM resource representing the User’s manager.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237"}}}}},"meta":{"description":"Metadata of the resource.","properties":{"created":{"description":"Datetime this resource was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the resource was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the resource.","type":"string","example":"W\"1644561244074\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"User"}}},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:User","urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"]}}}},"application/scim+json":{"schema":{"properties":{"id":{"description":"IdentityIQ id of the User.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"userName":{"description":"Unique identifier for the User. Typically used to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the entire set of Users. Cannot be changed.","type":"string","example":"Mock.User"},"name":{"description":"The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.","properties":{"formatted":{"description":"The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.","type":"string","example":"Ms. Barbara J Jensen, III"},"familyName":{"description":"The family name of the User, or Last Name in most Western languages","type":"string","example":"Jensen"},"givenName":{"description":"The given name of the User, or First Name in most Western languages","type":"string","example":"Barbara"}}},"displayName":{"description":"The name of the User, suitable for display to end-users. The name should be the full name of the User being described.","type":"string","example":"Barbara Jensen"},"userType":{"description":"The type of the User, identifying the relationship between the organization and the User.","type":"string","example":"employee"},"active":{"description":"A Boolean value indicating the User’s administrative status.","type":"boolean","example":true},"emails":{"description":"Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.","type":"array","items":{"properties":{"type":{"description":"Type of email address (work, home, other).","type":"string","example":"work"},"value":{"description":"Canonicalized email address.","type":"string","format":"email","example":"Barbara.Jensen@example.com"},"primary":{"description":"A Boolean value indicating the primary e-mail address. The primary attribute value 'true' MUST appear no more than once.","type":"boolean","example":"true"}}}},"urn:ietf:params:scim:schemas:sailpoint:1.0:User":{"description":"Additional attributes of the User.","type":"object","properties":{"accounts":{"description":"Simple representation of the Account (or Link) ResourceType.","type":"array","items":{"properties":{"displayName":{"description":"The display name of the Account.","type":"string","example":"Bob.Smith"},"value":{"description":"The id of the SCIM resource representing the Account.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"The URI of the SCIM resource representing the Account.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Accounts/c0a7778b7ef71e79817ee74e6a1f0444"}}}},"entitlements":{"description":"Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter.","type":"array","items":{"properties":{"value":{"description":"The value of the Entitlement.","type":"string","example":"groupmbr"},"display":{"description":"The display name of the Entitlement.","type":"string","example":"HelpDesk"},"type":{"description":"The type of Entitlement (Entitlement, Permission, etc.).","type":"string","example":"Permission"},"application":{"description":"The name of the Application this Entitlement applies to.","type":"string","example":"ADMockApp"},"accountName":{"description":"The account this Entitlement was sourced from.","type":"string","example":"CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com"},"$ref":{"description":"The URI of the SCIM resource representing the Entitlement.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Entitlements/c0a7777a7f74744d817e74fc12362c67"}}}},"roles":{"description":"Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter.","type":"array","items":{"properties":{"value":{"description":"The value of the Role.","type":"string","example":"detectedRoles"},"display":{"description":"The display name of the Role.","type":"string","example":"User - IT"},"type":{"description":"The type of Role (IT, Business, etc.).","type":"string","example":"it"},"acquired":{"description":"Indicates how this Role was acquired. Assigned or Detected.","type":"string","example":"Assigned"},"application":{"description":"The name of the Application where this Role came from.","type":"string","example":"Active_Directory"},"accountName":{"description":"The name of the Account this Role was sourced from.","type":"string","example":"CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com"},"$ref":{"description":"The URI of the SCIM resource representing the Role.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Roles/c0a7777a7f74744d817e74fc12362c67"}}}},"capabilities":{"description":"Capabilities assigned to this User.","type":"array","items":{"type":"string"},"example":"[\"SystemAdministrator\"]"},"riskScore":{"description":"Composite Risk Score of this User.","type":"integer","example":125},"isManager":{"description":"A Boolean value that determines if this User is a manager.","type":"boolean","example":false},"administrator":{"description":"The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service.","properties":{"displayName":{"description":"The display name of the Administrator of RPA user or Service account.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the SCIM resource representing the Administrator of RPA user or Service account.","type":"string","example":"c0a7777a7f74744d817e74fc12362c67O"},"$ref":{"description":"The URI of the SCIM resource representing the Administrator of RPA user or Service Account.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67"}}},"softwareVersion":{"description":"The software version of the RPA/Bots.","type":"string","example":"7.3"},"empId":{"description":"Employee id associated with this User.","type":"string","example":"1b2a3c"},"dn":{"description":"Distinguished name for this User.","type":"string","example":"cn=Bob Smith,ou=services"},"region":{"description":"The region this User is assigned to.","type":"string","example":"Americas"},"regionOwner":{"description":"The User who owns the region that this resource (User) belongs to.","properties":{"displayName":{"description":"Display name of the region owner.","type":"string","example":"Joe Smith"},"value":{"description":"The id of the region owner.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"$ref":{"description":"URI reference of the region owner resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"}}},"location":{"description":"The location this User is assigned to.","type":"string","example":"Singapore"},"locationOwner":{"description":"The User who owns the location that this resource (User) belongs to.","type":"object","properties":{"displayName":{"description":"Display name of the location owner.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the location owner.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"URI reference to the location owner resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"Department":{"description":"Department this User is assigned to.","type":"string","example":"Regional Operations"},"costcenter":{"description":"Cost centers this User is associated with.","type":"array","items":{"type":"string"},"example":["CC01","DD02"]},"jobtitle":{"description":"Job title given to this User.","type":"string","example":"Internal Audit Manager"},"lastRefresh":{"description":"Datetime representation of the last refresh for this User.","type":"string","format":"date-time"}}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"description":"Enterprise User Schema. Contains the manager of the User.","properties":{"manager":{"description":"Manager of the User.","properties":{"displayName":{"description":"Display name of the User's manager.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the SCIM resource representing the User’s manager.","type":"string","example":"c7a7347a7fe71e69077ee75f5d1f1237"},"$ref":{"description":"The URI of the SCIM resource representing the User’s manager.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237"}}}}},"meta":{"description":"Metadata of the resource.","properties":{"created":{"description":"Datetime this resource was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the resource was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the resource.","type":"string","example":"W\"1644561244074\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"User"}}},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:User","urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"]}}}}}}},"method":"get","path":"/Users/{userId}","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns a User resource based on id.","description":{"content":"The User resource with matching id is returned. There are attributes marked as 'returned only by request', such as **roles**, which must be provided as part of the **attributes** query parameter in order to be included in the response.","type":"text/plain"},"url":{"path":["Users",":userId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*","type":"text/plain"},"key":"excludedAttributes","value":""},{"disabled":false,"description":{"content":"A boolean value that determines if the User resource will be looked up by userName instead of userId (value in path parameter 'userId'). Setting this query parameter to true will cause the value pulled from the 'userId' path parameter to be treated as a userName when searching for the resource.

      **Example**: scim/v2/Users/**Mock.User**?**lookupByName=true**","type":"text/plain"},"key":"lookupByName","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The id of User resource. If **lookupByName** is set to **true**, this path parameter should be set to the **userName** of the User.","type":"text/plain"},"type":"any","value":"","key":"userId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns a User resource based on id.' (get-user-by-id)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns a User resource based on id. + + + +The User resource with matching id is returned. There are attributes marked as 'returned only by request', such as **roles**, which must be provided as part of the **attributes** query parameter in order to be included in the response. + +
      Path Parameters
      Query Parameters

        **Example**: scim/v2/Users/**Mock.User**?**lookupByName=true**"}}>
      + +Returns a single User resource based on the id. + +
      Schema
        name
        + +The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined. + +
        emails undefined[]
        + +Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other. + +
        urn:ietf:params:scim:schemas:sailpoint:1.0:User object
        + +Additional attributes of the User. + +
        accounts undefined[]
        + +Simple representation of the Account (or Link) ResourceType. + +
        entitlements undefined[]
        + +Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter. + +
        roles undefined[]
        + +Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter. + +
        administrator
        + +The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service. + +
        regionOwner
        + +The User who owns the region that this resource (User) belongs to. + +
        locationOwner object
        + +The User who owns the location that this resource (User) belongs to. + +
        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
        + +Enterprise User Schema. Contains the manager of the User. + +
        manager
        + +Manager of the User. + +
        meta
        + +Metadata of the resource. + +
      Schema
        name
        + +The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined. + +
        emails undefined[]
        + +Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other. + +
        urn:ietf:params:scim:schemas:sailpoint:1.0:User object
        + +Additional attributes of the User. + +
        accounts undefined[]
        + +Simple representation of the Account (or Link) ResourceType. + +
        entitlements undefined[]
        + +Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter. + +
        roles undefined[]
        + +Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter. + +
        administrator
        + +The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service. + +
        regionOwner
        + +The User who owns the region that this resource (User) belongs to. + +
        locationOwner object
        + +The User who owns the location that this resource (User) belongs to. + +
        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
        + +Enterprise User Schema. Contains the manager of the User. + +
        manager
        + +Manager of the User. + +
        meta
        + +Metadata of the resource. + +
      \ No newline at end of file diff --git a/products/iiq/api/get-users.api.mdx b/products/iiq/api/get-users.api.mdx new file mode 100644 index 000000000..a7ff12d59 --- /dev/null +++ b/products/iiq/api/get-users.api.mdx @@ -0,0 +1,131 @@ +--- +id: get-users +sidebar_label: Returns all User resources. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getUsers","tags":["Users"],"description":"This endpoint returns all User resources. There are attributes marked as 'returned only by request', such as **roles**, which must be provided as part of the **attributes** query parameter in order to be included in the response.","parameters":[{"in":"query","name":"filter","schema":{"type":"string","example":"location eq \"Raleigh\" and name.givenName sw \"j\" and name.familyName sw \"s\""},"description":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported."},{"in":"query","name":"sortBy","schema":{"type":"string","example":"userName"},"description":"Allows sorting the results by a resource's attributes."},{"in":"query","name":"sortOrder","schema":{"type":"string","example":"descending","default":"ascending"},"description":"Determines what order to sort results in."},{"in":"query","name":"startIndex","schema":{"type":"integer","example":2313,"default":1},"description":"Determines the starting index of the result set."},{"in":"query","name":"count","schema":{"type":"integer","example":10,"default":1000},"description":"Specifies the number of results per page."},{"in":"query","name":"attributes","schema":{"type":"string","example":"userName,nativeIdentity"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"userName,manuallyCorrelated"},"description":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*"}],"responses":{"200":{"description":"Returns all SCIM User resources.","content":{"application/json":{"schema":{"properties":{"totalResults":{"description":"Number of User resources returned","type":"integer","example":"18,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"type":"array","items":{"properties":{"id":{"description":"IdentityIQ id of the User.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"userName":{"description":"Unique identifier for the User. Typically used to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the entire set of Users. Cannot be changed.","type":"string","example":"Mock.User"},"name":{"description":"The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.","properties":{"formatted":{"description":"The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.","type":"string","example":"Ms. Barbara J Jensen, III"},"familyName":{"description":"The family name of the User, or Last Name in most Western languages","type":"string","example":"Jensen"},"givenName":{"description":"The given name of the User, or First Name in most Western languages","type":"string","example":"Barbara"}}},"displayName":{"description":"The name of the User, suitable for display to end-users. The name should be the full name of the User being described.","type":"string","example":"Barbara Jensen"},"userType":{"description":"The type of the User, identifying the relationship between the organization and the User.","type":"string","example":"employee"},"active":{"description":"A Boolean value indicating the User’s administrative status.","type":"boolean","example":true},"emails":{"description":"Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.","type":"array","items":{"properties":{"type":{"description":"Type of email address (work, home, other).","type":"string","example":"work"},"value":{"description":"Canonicalized email address.","type":"string","format":"email","example":"Barbara.Jensen@example.com"},"primary":{"description":"A Boolean value indicating the primary e-mail address. The primary attribute value 'true' MUST appear no more than once.","type":"boolean","example":"true"}}}},"urn:ietf:params:scim:schemas:sailpoint:1.0:User":{"description":"Additional attributes of the User.","type":"object","properties":{"accounts":{"description":"Simple representation of the Account (or Link) ResourceType.","type":"array","items":{"properties":{"displayName":{"description":"The display name of the Account.","type":"string","example":"Bob.Smith"},"value":{"description":"The id of the SCIM resource representing the Account.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"The URI of the SCIM resource representing the Account.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Accounts/c0a7778b7ef71e79817ee74e6a1f0444"}}}},"entitlements":{"description":"Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter.","type":"array","items":{"properties":{"value":{"description":"The value of the Entitlement.","type":"string","example":"groupmbr"},"display":{"description":"The display name of the Entitlement.","type":"string","example":"HelpDesk"},"type":{"description":"The type of Entitlement (Entitlement, Permission, etc.).","type":"string","example":"Permission"},"application":{"description":"The name of the Application this Entitlement applies to.","type":"string","example":"ADMockApp"},"accountName":{"description":"The account this Entitlement was sourced from.","type":"string","example":"CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com"},"$ref":{"description":"The URI of the SCIM resource representing the Entitlement.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Entitlements/c0a7777a7f74744d817e74fc12362c67"}}}},"roles":{"description":"Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter.","type":"array","items":{"properties":{"value":{"description":"The value of the Role.","type":"string","example":"detectedRoles"},"display":{"description":"The display name of the Role.","type":"string","example":"User - IT"},"type":{"description":"The type of Role (IT, Business, etc.).","type":"string","example":"it"},"acquired":{"description":"Indicates how this Role was acquired. Assigned or Detected.","type":"string","example":"Assigned"},"application":{"description":"The name of the Application where this Role came from.","type":"string","example":"Active_Directory"},"accountName":{"description":"The name of the Account this Role was sourced from.","type":"string","example":"CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com"},"$ref":{"description":"The URI of the SCIM resource representing the Role.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Roles/c0a7777a7f74744d817e74fc12362c67"}}}},"capabilities":{"description":"Capabilities assigned to this User.","type":"array","items":{"type":"string"},"example":"[\"SystemAdministrator\"]"},"riskScore":{"description":"Composite Risk Score of this User.","type":"integer","example":125},"isManager":{"description":"A Boolean value that determines if this User is a manager.","type":"boolean","example":false},"administrator":{"description":"The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service.","properties":{"displayName":{"description":"The display name of the Administrator of RPA user or Service account.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the SCIM resource representing the Administrator of RPA user or Service account.","type":"string","example":"c0a7777a7f74744d817e74fc12362c67O"},"$ref":{"description":"The URI of the SCIM resource representing the Administrator of RPA user or Service Account.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67"}}},"softwareVersion":{"description":"The software version of the RPA/Bots.","type":"string","example":"7.3"},"empId":{"description":"Employee id associated with this User.","type":"string","example":"1b2a3c"},"dn":{"description":"Distinguished name for this User.","type":"string","example":"cn=Bob Smith,ou=services"},"region":{"description":"The region this User is assigned to.","type":"string","example":"Americas"},"regionOwner":{"description":"The User who owns the region that this resource (User) belongs to.","properties":{"displayName":{"description":"Display name of the region owner.","type":"string","example":"Joe Smith"},"value":{"description":"The id of the region owner.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"$ref":{"description":"URI reference of the region owner resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"}}},"location":{"description":"The location this User is assigned to.","type":"string","example":"Singapore"},"locationOwner":{"description":"The User who owns the location that this resource (User) belongs to.","type":"object","properties":{"displayName":{"description":"Display name of the location owner.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the location owner.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"URI reference to the location owner resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"Department":{"description":"Department this User is assigned to.","type":"string","example":"Regional Operations"},"costcenter":{"description":"Cost centers this User is associated with.","type":"array","items":{"type":"string"},"example":["CC01","DD02"]},"jobtitle":{"description":"Job title given to this User.","type":"string","example":"Internal Audit Manager"},"lastRefresh":{"description":"Datetime representation of the last refresh for this User.","type":"string","format":"date-time"}}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"description":"Enterprise User Schema. Contains the manager of the User.","properties":{"manager":{"description":"Manager of the User.","properties":{"displayName":{"description":"Display name of the User's manager.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the SCIM resource representing the User’s manager.","type":"string","example":"c7a7347a7fe71e69077ee75f5d1f1237"},"$ref":{"description":"The URI of the SCIM resource representing the User’s manager.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237"}}}}},"meta":{"description":"Metadata of the resource.","properties":{"created":{"description":"Datetime this resource was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the resource was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the resource.","type":"string","example":"W\"1644561244074\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"User"}}},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:User","urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"]}}}}}}},"application/scim+json":{"schema":{"properties":{"totalResults":{"description":"Number of User resources returned.","type":"integer","example":"1500,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"description":"The SCIM resources returned for this endpoint.","type":"array","items":{"properties":{"id":{"description":"IdentityIQ id of the User.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"userName":{"description":"Unique identifier for the User. Typically used to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the entire set of Users. Cannot be changed.","type":"string","example":"Mock.User"},"name":{"description":"The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.","properties":{"formatted":{"description":"The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.","type":"string","example":"Ms. Barbara J Jensen, III"},"familyName":{"description":"The family name of the User, or Last Name in most Western languages","type":"string","example":"Jensen"},"givenName":{"description":"The given name of the User, or First Name in most Western languages","type":"string","example":"Barbara"}}},"displayName":{"description":"The name of the User, suitable for display to end-users. The name should be the full name of the User being described.","type":"string","example":"Barbara Jensen"},"userType":{"description":"The type of the User, identifying the relationship between the organization and the User.","type":"string","example":"employee"},"active":{"description":"A Boolean value indicating the User’s administrative status.","type":"boolean","example":true},"emails":{"description":"Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.","type":"array","items":{"properties":{"type":{"description":"Type of email address (work, home, other).","type":"string","example":"work"},"value":{"description":"Canonicalized email address.","type":"string","format":"email","example":"Barbara.Jensen@example.com"},"primary":{"description":"A Boolean value indicating the primary e-mail address. The primary attribute value 'true' MUST appear no more than once.","type":"boolean","example":"true"}}}},"urn:ietf:params:scim:schemas:sailpoint:1.0:User":{"description":"Additional attributes of the User.","type":"object","properties":{"accounts":{"description":"Simple representation of the Account (or Link) ResourceType.","type":"array","items":{"properties":{"displayName":{"description":"The display name of the Account.","type":"string","example":"Bob.Smith"},"value":{"description":"The id of the SCIM resource representing the Account.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"The URI of the SCIM resource representing the Account.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Accounts/c0a7778b7ef71e79817ee74e6a1f0444"}}}},"entitlements":{"description":"Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter.","type":"array","items":{"properties":{"value":{"description":"The value of the Entitlement.","type":"string","example":"groupmbr"},"display":{"description":"The display name of the Entitlement.","type":"string","example":"HelpDesk"},"type":{"description":"The type of Entitlement (Entitlement, Permission, etc.).","type":"string","example":"Permission"},"application":{"description":"The name of the Application this Entitlement applies to.","type":"string","example":"ADMockApp"},"accountName":{"description":"The account this Entitlement was sourced from.","type":"string","example":"CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com"},"$ref":{"description":"The URI of the SCIM resource representing the Entitlement.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Entitlements/c0a7777a7f74744d817e74fc12362c67"}}}},"roles":{"description":"Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter.","type":"array","items":{"properties":{"value":{"description":"The value of the Role.","type":"string","example":"detectedRoles"},"display":{"description":"The display name of the Role.","type":"string","example":"User - IT"},"type":{"description":"The type of Role (IT, Business, etc.).","type":"string","example":"it"},"acquired":{"description":"Indicates how this Role was acquired. Assigned or Detected.","type":"string","example":"Assigned"},"application":{"description":"The name of the Application where this Role came from.","type":"string","example":"Active_Directory"},"accountName":{"description":"The name of the Account this Role was sourced from.","type":"string","example":"CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com"},"$ref":{"description":"The URI of the SCIM resource representing the Role.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Roles/c0a7777a7f74744d817e74fc12362c67"}}}},"capabilities":{"description":"Capabilities assigned to this User.","type":"array","items":{"type":"string"},"example":"[\"SystemAdministrator\"]"},"riskScore":{"description":"Composite Risk Score of this User.","type":"integer","example":125},"isManager":{"description":"A Boolean value that determines if this User is a manager.","type":"boolean","example":false},"administrator":{"description":"The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service.","properties":{"displayName":{"description":"The display name of the Administrator of RPA user or Service account.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the SCIM resource representing the Administrator of RPA user or Service account.","type":"string","example":"c0a7777a7f74744d817e74fc12362c67O"},"$ref":{"description":"The URI of the SCIM resource representing the Administrator of RPA user or Service Account.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67"}}},"softwareVersion":{"description":"The software version of the RPA/Bots.","type":"string","example":"7.3"},"empId":{"description":"Employee id associated with this User.","type":"string","example":"1b2a3c"},"dn":{"description":"Distinguished name for this User.","type":"string","example":"cn=Bob Smith,ou=services"},"region":{"description":"The region this User is assigned to.","type":"string","example":"Americas"},"regionOwner":{"description":"The User who owns the region that this resource (User) belongs to.","properties":{"displayName":{"description":"Display name of the region owner.","type":"string","example":"Joe Smith"},"value":{"description":"The id of the region owner.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"$ref":{"description":"URI reference of the region owner resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"}}},"location":{"description":"The location this User is assigned to.","type":"string","example":"Singapore"},"locationOwner":{"description":"The User who owns the location that this resource (User) belongs to.","type":"object","properties":{"displayName":{"description":"Display name of the location owner.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the location owner.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"URI reference to the location owner resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"Department":{"description":"Department this User is assigned to.","type":"string","example":"Regional Operations"},"costcenter":{"description":"Cost centers this User is associated with.","type":"array","items":{"type":"string"},"example":["CC01","DD02"]},"jobtitle":{"description":"Job title given to this User.","type":"string","example":"Internal Audit Manager"},"lastRefresh":{"description":"Datetime representation of the last refresh for this User.","type":"string","format":"date-time"}}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"description":"Enterprise User Schema. Contains the manager of the User.","properties":{"manager":{"description":"Manager of the User.","properties":{"displayName":{"description":"Display name of the User's manager.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the SCIM resource representing the User’s manager.","type":"string","example":"c7a7347a7fe71e69077ee75f5d1f1237"},"$ref":{"description":"The URI of the SCIM resource representing the User’s manager.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237"}}}}},"meta":{"description":"Metadata of the resource.","properties":{"created":{"description":"Datetime this resource was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the resource was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the resource.","type":"string","example":"W\"1644561244074\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"User"}}},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:User","urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"]}}}}}}}}}},"method":"get","path":"/Users","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns all User resources.","description":{"content":"This endpoint returns all User resources. There are attributes marked as 'returned only by request', such as **roles**, which must be provided as part of the **attributes** query parameter in order to be included in the response.","type":"text/plain"},"url":{"path":["Users"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.","type":"text/plain"},"key":"filter","value":""},{"disabled":false,"description":{"content":"Allows sorting the results by a resource's attributes.","type":"text/plain"},"key":"sortBy","value":""},{"disabled":false,"description":{"content":"Determines what order to sort results in.","type":"text/plain"},"key":"sortOrder","value":""},{"disabled":false,"description":{"content":"Determines the starting index of the result set.","type":"text/plain"},"key":"startIndex","value":""},{"disabled":false,"description":{"content":"Specifies the number of results per page.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns all User resources.' (get-users)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns all User resources. + + + +This endpoint returns all User resources. There are attributes marked as 'returned only by request', such as **roles**, which must be provided as part of the **attributes** query parameter in order to be included in the response. + +
      Query Parameters
      + +Returns all SCIM User resources. + +
      Schema
        Resources undefined[]
        name
        + +The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined. + +
        emails undefined[]
        + +Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other. + +
        urn:ietf:params:scim:schemas:sailpoint:1.0:User object
        + +Additional attributes of the User. + +
        accounts undefined[]
        + +Simple representation of the Account (or Link) ResourceType. + +
        entitlements undefined[]
        + +Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter. + +
        roles undefined[]
        + +Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter. + +
        administrator
        + +The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service. + +
        regionOwner
        + +The User who owns the region that this resource (User) belongs to. + +
        locationOwner object
        + +The User who owns the location that this resource (User) belongs to. + +
        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
        + +Enterprise User Schema. Contains the manager of the User. + +
        manager
        + +Manager of the User. + +
        meta
        + +Metadata of the resource. + +
      Schema
        Resources undefined[]
        + +The SCIM resources returned for this endpoint. + +
        name
        + +The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined. + +
        emails undefined[]
        + +Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other. + +
        urn:ietf:params:scim:schemas:sailpoint:1.0:User object
        + +Additional attributes of the User. + +
        accounts undefined[]
        + +Simple representation of the Account (or Link) ResourceType. + +
        entitlements undefined[]
        + +Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter. + +
        roles undefined[]
        + +Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter. + +
        administrator
        + +The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service. + +
        regionOwner
        + +The User who owns the region that this resource (User) belongs to. + +
        locationOwner object
        + +The User who owns the location that this resource (User) belongs to. + +
        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
        + +Enterprise User Schema. Contains the manager of the User. + +
        manager
        + +Manager of the User. + +
        meta
        + +Metadata of the resource. + +
      \ No newline at end of file diff --git a/products/iiq/api/get-workflow-by-id.api.mdx b/products/iiq/api/get-workflow-by-id.api.mdx new file mode 100644 index 000000000..b27befb3a --- /dev/null +++ b/products/iiq/api/get-workflow-by-id.api.mdx @@ -0,0 +1,37 @@ +--- +id: get-workflow-by-id +sidebar_label: Returns a Workflow resource based on id. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"getWorkflowById","tags":["Workflows"],"description":"The Workflow resource with matching id is returned.

      \nAttributes to include in the response can be specified with the attributes query parameter.

      \nAttributes to exclude from the response can be specified with the excludedAttributes query parameter.

      \n\nThe schema related to Workflow is:
      \n- **urn:ietf:params:scim:schemas:sailpoint:1.0:Workflow**\n","parameters":[{"name":"workflowId","in":"path","schema":{"type":"string","example":"c0a8019c802d1e5a81802eb2b57e020f"},"description":"id of Workflow resource.","required":true},{"in":"query","name":"attributes","schema":{"type":"string","example":"name, type"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"name, handler"},"description":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**"}],"responses":{"200":{"description":"Returns a single Workflow resource based on the id.","content":{"application/json":{"schema":{"required":["name"],"properties":{"id":{"description":"Unique identifier of the Workflow.","type":"string","example":"7f00000180281df7818028be6a9c01a3"},"name":{"description":"Name of the Workflow.","type":"string","example":"Aggregate Correlated Applications"},"description":{"description":"Description of the Workflow.","type":"string","example":"Library for Steps."},"type":{"type":"string","description":"Type of the Workflow.","enum":["Batch Provisioning","Scheduled Assignment","Scheduled Role Activation","Managed Attribute","Identity Correlation","Identity Event","Identity Lifecycle","Identity Update","Identity Refresh","LCM Identity","LCM Provisioning","LCM Registration","Policy Violation","Role Modeler","Subprocess","Password Intercept","Alert","Attribute Sync"],"example":"Step Library"},"handler":{"description":"Handler of the Workflow.","type":"string","example":"sailpoint.api.StandardWorkflowHandler"},"meta":{"type":"object","properties":{"created":{"description":"DateTime when the Workflow was created.","type":"string","format":"date-time","example":"2022-04-14T10:43:29.436-05:00"},"location":{"description":"URL to the Workflow.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Workflows/7f00000180281df7818028be6a9c01a3"},"lastModified":{"description":"DateTime of Workflow last modification.","type":"string","format":"date-time","example":"2022-05-05T15:52:30.119-05:00"},"version":{"description":"Workflow version.","type":"string","example":"\"W\"1649951094834\""},"resourceType":{"description":"Resource type of the metadata subject.","type":"string","example":"Workflow"}}}}}}}}},"method":"get","path":"/Workflows/{workflowId}","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns a Workflow resource based on id.","description":{"content":"The Workflow resource with matching id is returned.

      \nAttributes to include in the response can be specified with the attributes query parameter.

      \nAttributes to exclude from the response can be specified with the excludedAttributes query parameter.

      \n\nThe schema related to Workflow is:
      \n- **urn:ietf:params:scim:schemas:sailpoint:1.0:Workflow**\n","type":"text/plain"},"url":{"path":["Workflows",":workflowId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) id of Workflow resource.","type":"text/plain"},"type":"any","value":"","key":"workflowId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns a Workflow resource based on id.' (get-workflow-by-id)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns a Workflow resource based on id. + + + +The Workflow resource with matching id is returned.

      +Attributes to include in the response can be specified with the attributes query parameter.

      +Attributes to exclude from the response can be specified with the excludedAttributes query parameter.

      + +The schema related to Workflow is:
      +- **urn:ietf:params:scim:schemas:sailpoint:1.0:Workflow** + + +
      Path Parameters
      Query Parameters
      + +Returns a single Workflow resource based on the id. + +
      Schema
        meta object
      \ No newline at end of file diff --git a/products/iiq/api/identityiq-scim-rest-api.info.mdx b/products/iiq/api/identityiq-scim-rest-api.info.mdx new file mode 100644 index 000000000..3f5a80c05 --- /dev/null +++ b/products/iiq/api/identityiq-scim-rest-api.info.mdx @@ -0,0 +1,25 @@ +--- +id: identityiq-scim-rest-api +sidebar_label: Introduction +sidebar_position: 0 +hide_title: true +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'IdentityIQ SCIM REST API' (identityiq-scim-rest-api)" +--- + +import ApiLogo from "@theme/ApiLogo"; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import Export from "@theme/ApiDemoPanel/Export"; + +Version: 8.3 + + + +# IdentityIQ SCIM REST API + + + +IdentityIQ REST Endpoint Interface Documentation for SCIM + + +

      Authentication

      Security Scheme Type:http
      HTTP Authorization Scheme:basic
      Bearer format:
      \ No newline at end of file diff --git a/products/iiq/api/launch-workflow.api.mdx b/products/iiq/api/launch-workflow.api.mdx new file mode 100644 index 000000000..122ead053 --- /dev/null +++ b/products/iiq/api/launch-workflow.api.mdx @@ -0,0 +1,51 @@ +--- +id: launch-workflow +sidebar_label: Endpoint used to launch a Workflow. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"launchWorkflow","tags":["LaunchedWorkflows"],"description":"Endpoint to launch or execute a Workflow. A payload for the request is required and this can include inputs specific to the Workflow being launched.","parameters":[{"in":"query","name":"attributes","schema":{"type":"string","example":"input"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"workflowName"},"description":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*"}],"requestBody":{"required":true,"content":{"application/scim+json":{"schema":{"properties":{"schemas":{"type":"array","description":"Schemas related to Launched Workflows.","items":{"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow","urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult"]}},"workflowName":{"type":"string","description":"Name of the Workflow to launch.","example":"LCM Manage Passwords"},"input":{"type":"array","description":"A list of input attributes of the Launched Workflow.","items":{"properties":{"key":{"type":"string","description":"The attribute key.","example":"plan"},"value":{"type":"string","description":"The attribute value.","example":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n"},"type":{"type":"string","description":"The attribute type.","example":"application/xml"}}}}}}},"*/*":{"schema":{"properties":{"schemas":{"type":"array","description":"Schemas related to Launched Workflows.","items":{"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow","urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult"]}},"workflowName":{"type":"string","description":"Name of the Workflow to launch.","example":"LCM Manage Passwords"},"input":{"type":"array","description":"A list of input attributes of the Launched Workflow.","items":{"properties":{"key":{"type":"string","description":"The attribute key.","example":"plan"},"value":{"type":"string","description":"The attribute value.","example":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n"},"type":{"type":"string","description":"The attribute type.","example":"application/xml"}}}}}}}}},"responses":{"201":{"description":"Executes a workflow and returns the resulting LaunchedWorkflow. **LaunchedWorkflow responses include attributes from the TaskResult related to the Workflow execution.**","content":{"application/json":{"schema":{"type":"object","description":"Response example for a POST request to execute a Workflow.","properties":{"targetName":{"type":"string","description":"Target name of the TaskResult.","example":"Ernest.Wagner"},"verified":{"type":"string","format":"date-time","description":"The verified date of the TaskResult.","example":"2022-05-26T11:17:13.481-05:00"},"partitioned":{"type":"boolean","description":"Flag to indicate if the TaskResult is partitioned.","example":false},"completed":{"type":"string","format":"date-time","description":"The completed date of the TaskResult.","example":"2022-05-26T11:17:13.678-05:00"},"type":{"type":"string","description":"Type of the TaskResult.","example":"LCM"},"launched":{"type":"string","description":"The launched date of the TaskResult."},"pendingSignOffs":{"type":"integer","description":"Number of pending signoffs of this TaskResult.","example":0},"urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow":{"type":"object","description":"LaunchedWorkflow properties.","properties":{"output":{"type":"array","items":{"properties":{"type":{"type":"string","description":"The output attribute type.","example":"application/int"},"value":{"type":"string","description":"The output attribute value.","example":"0"},"key":{"type":"string","description":"The output attribute key.","example":"workflowSummary"}}}},"retries":{"type":"integer","description":"The number of retries performed during the execution of provisioning activities.","example":0},"input":{"type":"array","items":{"properties":{"key":{"type":"string","description":"The input attribute key.","example":"optimisticProvisioning"},"value":{"type":"string","description":"The input attribute value.","example":"true"},"type":{"type":"string","description":"The input attribute type.","example":"boolean"}}}},"workflowSummary":{"type":"string","description":"XML representation of the workflow summary.","example":"\n"},"workflowName":{"type":"string","description":"Name of the workflow to launch.","example":"LCM Manage Passwords."},"identityRequestId":{"type":"string","description":"Id representing the identity request.","example":"0000000004"},"workflowCaseId":{"type":"string","description":"Id representing the workflow case (a running instance of a workflow).","example":"c0a8019c810011478181012862b81568"}}},"targetClass":{"type":"string","description":"Target class of the Task Result.","example":"Identity"},"meta":{"description":"Metadata for the LaunchedWorkflow TaskResult.","type":"array","items":{"properties":{"created":{"description":"Datetime when the TaskResult for the LaunchedWorkflow was created.","type":"string","format":"date-time","example":"2022-03-31T14:52:40.245-05:00"},"location":{"description":"URL to the TaskResult.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/TaskResults/c0a8019c810011478181012862b51567"},"lastModified":{"description":"Datetime of LaunchedWorkflow TaskResult last modification","type":"string","format":"date-time","example":"2022-03-31T14:52:40.265-05:00"},"version":{"description":"Version of the LaunchedWorkflow TaskResult.","type":"string","example":"\"W\"1649951092552\""},"resourceType":{"description":"Resource type of the metadata subject","type":"string","example":"LaunchedWorkflow"}}}},"schemas":{"type":"array","description":"Schemas related to LaunchedWorkflow.","items":{"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow","urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult"]}},"name":{"type":"string","description":"Name of the TaskResult for the Workflow launch.","example":"LCM Manage Passwords - 2"},"messages":{"type":"array","description":"List of messages of the TaskResult.","items":{"example":["Connection error"]}},"Attributes":{"type":"object","description":"A list of attributes of the TaskResult.","properties":{"key":{"type":"string","description":"The attribute key.","example":"retries"},"value":{"type":"string","description":"The attribute value.","example":"0"}}},"id":{"type":"string","description":"Id of the task result for the Workflow launch.","example":"c0a8019c810011478181012862b51567"},"completionStatus":{"type":"string","description":"Completion Status of the TaskResult.","enum":["Success","Warning","Error","Terminated","TempError"],"example":"Success"},"taskDefinition":{"type":"string","description":"Name of the TaskDefinition of the TaskResult.","example":"Workflow Launcher"},"terminated":{"type":"boolean","description":"Flag to indicate this TaskResult is terminated.","example":false},"launcher":{"type":"string","description":"Launcher of the TaskResult.","example":"spadmin"}}}}}}},"method":"post","path":"/LaunchedWorkflows","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"jsonRequestBodyExample":{"schemas":[["urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow","urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult"]],"workflowName":"LCM Manage Passwords","input":[{"key":"plan","value":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n","type":"application/xml"}]},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Endpoint used to launch a Workflow.","description":{"content":"Endpoint to launch or execute a Workflow. A payload for the request is required and this can include inputs specific to the Workflow being launched.","type":"text/plain"},"url":{"path":["LaunchedWorkflows"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/scim+json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Endpoint used to launch a Workflow.' (launch-workflow)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Endpoint used to launch a Workflow. + + + +Endpoint to launch or execute a Workflow. A payload for the request is required and this can include inputs specific to the Workflow being launched. + +
      Query Parameters
      Request Body required
        input undefined[]
        + +A list of input attributes of the Launched Workflow. + +
      Request Body required
        input undefined[]
        + +A list of input attributes of the Launched Workflow. + +
      + +Executes a workflow and returns the resulting LaunchedWorkflow. **LaunchedWorkflow responses include attributes from the TaskResult related to the Workflow execution.** + +
      Schema
        urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow object
        + +LaunchedWorkflow properties. + +
        output undefined[]
        input undefined[]
        meta undefined[]
        + +Metadata for the LaunchedWorkflow TaskResult. + +
        Attributes object
        + +A list of attributes of the TaskResult. + +
      \\n\",\n \"workflowName\": \"LCM Manage Passwords.\",\n \"identityRequestId\": \"0000000004\",\n \"workflowCaseId\": \"c0a8019c810011478181012862b81568\"\n },\n \"targetClass\": \"Identity\",\n \"meta\": [\n {\n \"created\": \"2022-03-31T14:52:40.245-05:00\",\n \"location\": \"http://localhost:8080/identityiq/scim/v2/TaskResults/c0a8019c810011478181012862b51567\",\n \"lastModified\": \"2022-03-31T14:52:40.265-05:00\",\n \"version\": \"\\\"W\\\"1649951092552\\\"\",\n \"resourceType\": \"LaunchedWorkflow\"\n }\n ],\n \"schemas\": [\n [\n \"urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow\",\n \"urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult\"\n ]\n ],\n \"name\": \"LCM Manage Passwords - 2\",\n \"messages\": [\n [\n \"Connection error\"\n ]\n ],\n \"Attributes\": {\n \"key\": \"retries\",\n \"value\": \"0\"\n },\n \"id\": \"c0a8019c810011478181012862b51567\",\n \"completionStatus\": \"Success\",\n \"taskDefinition\": \"Workflow Launcher\",\n \"terminated\": false,\n \"launcher\": \"spadmin\"\n}"} language={"json"}>
      \ No newline at end of file diff --git a/products/iiq/api/launched-workflows-get.api.mdx b/products/iiq/api/launched-workflows-get.api.mdx new file mode 100644 index 000000000..a8252280d --- /dev/null +++ b/products/iiq/api/launched-workflows-get.api.mdx @@ -0,0 +1,64 @@ +--- +id: launched-workflows-get +sidebar_label: Returns all LaunchedWorkflow resources. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"LaunchedWorkflowsGet","tags":["LaunchedWorkflows"],"description":"This endpoint returns all LaunchedWorkflow resources.

      \nAttributes to include in the response can be specified with the 'attributes' query parameter.

      \nAttributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

      \nThe schema related to LaunchedWorkflow is: \n- **urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow**\n","parameters":[{"in":"query","name":"filter","schema":{"type":"string","example":"completed eq \"2022-05-03T16:40:34.271-05:00\""},"description":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported."},{"in":"query","name":"sortBy","schema":{"type":"string","example":"application"},"description":"Allows sorting the results by a resource's attributes."},{"in":"query","name":"sortOrder","schema":{"type":"string","default":"ascending"},"example":"descending","description":"Determines what order to sort results in."},{"in":"query","name":"startIndex","schema":{"type":"integer","example":10,"default":1},"description":"Determines the starting index of the result set."},{"in":"query","name":"count","schema":{"type":"integer","example":10,"default":1000},"description":"Specifies the number of results per page."},{"in":"query","name":"attributes","schema":{"type":"string","example":"name, expiration"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"identityRequestId"},"description":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**"}],"responses":{"200":{"description":"Returned all SCIM resources for this endpoint.
      **LaunchedWorkflow responses include attributes from the TaskResult related to the Workflow execution.**","content":{"application/json":{"schema":{"properties":{"totalResults":{"description":"Number of resources returned for this endpoint","type":"integer","example":"1,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"type":"array","items":{"properties":{"partitioned":{"description":"Flag to indicate this TaskResult is partitioned. (From the TaskResult used to launch the Workflow).","type":"boolean","example":true},"completed":{"type":"string","format":"date-time","description":"The completed DateTime of the TaskResult. (From the TaskResult used to launch the Workflow).","example":"2022-04-14T10:45:26.098-05:00"},"type":{"description":"Type of the TaskResult. (From the TaskResult used to launch the Workflow).","type":"string","example":"Workflow"},"launched":{"type":"string","format":"date-time","description":"The launched DateTime of the TaskResult. (From the TaskResult used to launch the Workflow).","example":"2022-04-14T10:45:26.114-05:00"},"pendingSignOffs":{"description":"The number of pending signoffs of this TaskResult. (From the TaskResult used to launch the Workflow).","type":"integer","example":2},"workflowName":{"description":"Name of the Workflow to launch.","type":"string","example":"Update Identity Adam.Kennedy AccessRequest"},"identityRequestId":{"description":"Id representing the identity request.","type":"string","example":"0000000001"},"workflowCaseId":{"description":"Id representing the workflow case (a running instance of a workflow).","type":"string","example":"c0a8019c808b1baa81808bde2c2201b3"},"workflowProcessId":{"type":"string","description":"Id representing the workflow monitoring process log.","example":"7f000001806719888180675c8f8a225g"},"retries":{"description":"The number of retries performed during the execution of provisioning activities.","type":"integer","example":1},"approvalSet":{"description":"XML representation of approvals.","type":"string","example":"example: "},"workflowSummary":{"description":"XML representation of the workflow summary.","type":"string","example":"example: \"\""},"input":{"description":"A list of input attributes of the Launched Workflow.","type":"object","properties":{"key":{"description":"The attribute key.","type":"string","example":"_workflowRef"},"value":{"description":"The attribute value.","type":"string","example":"UpdateIdentityWorkflow"},"type":{"description":"The attribute type.","type":"string","example":"string"}}},"output":{"description":"A list of output attributes of the Launched Workflow.","type":"object","properties":{"key":{"description":"The attribute key.","type":"string","example":"workflowSummary"},"value":{"description":"The attribute value.","type":"string","example":"\\n \\n \\n \\n\\n"},"type":{"description":"The attribute type.","type":"string","example":"application/xml"}}},"targetClass":{"description":"Target Class of the TaskResult. (From the TaskResult used to launch the Workflow).","type":"string","example":"Permission"},"name":{"description":"Name of the TaskResult. (From the TaskResult used to launch the Workflow).","type":"string","example":"Update Account Group a2a"},"messages":{"description":"List of messages of the TaskResult. (From the TaskResult used to launch the Workflow).","type":"array","items":{"example":["Task executed successfully."]}},"attributes":{"description":"A list of attributes of the TaskResult. (From the TaskResult used to launch the Workflow).","type":"array","items":{"properties":{"key":{"description":"The attribute key.","type":"string","example":"Workflow Summary"},"value":{"description":"The attribute value.","type":"string","example":"\\n \\n \\n \\n\\n"}}}},"id":{"description":"Unique identifier of the TaskResult. (From the TaskResult used to launch the Workflow).","type":"string","example":"7f00000180281df7818028c03252085c"},"completionStatus":{"type":"string","description":"Completion Status of the TaskResult. (From the TaskResult used to launch the Workflow).","enum":["Success","Warning","Error","Terminated","TempError"],"example":"Success"},"taskDefinition":{"type":"string","description":"Name of the TaskDefinition of the TaskResult. (From the TaskResult used to launch the Workflow).","example":"Workflow Launcher"},"terminated":{"description":"Flag to indicate this TaskResult is terminated. (From the TaskResult used to launch the Workflow).","type":"boolean","example":true},"launcher":{"description":"Launcher of the TaskResult. (From the TaskResult used to launch the Workflow).","type":"string","example":"spadmin"},"meta":{"type":"object","properties":{"created":{"description":"DateTime when the TaskResult was created. (From the TaskResult used to launch the Workflow).","type":"string","format":"date-time","example":"2022-04-14T10:44:54.834-05:00"},"location":{"description":"URL to the TaskResult. (From the TaskResult used to launch the Workflow).","type":"string","example":"http://localhost:8080/identityiq/scim/v2/TaskResults/7f00000180281df7818028c03252085c"},"lastModified":{"description":"DateTime of TaskResult last modification. (From the TaskResult used to launch the Workflow).","type":"string","format":"date-time","example":"2022-04-05T15:52:30.119-05:00"},"version":{"description":"TaskResult version. (From the TaskResult used to launch the Workflow).","type":"string","example":"\"W\"1649951094834\""},"resourceType":{"description":"Resource type of the metadata subject. (From the TaskResult used to launch the Workflow).","type":"string","example":"TaskResult"}}}}}}}}},"application/scim+json":{"schema":{"properties":{"totalResults":{"description":"Number of LaunchedWorkflow resources returned.","type":"integer","example":"1500,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"description":"The SCIM resources returned for this endpoint.","type":"array","items":{"properties":{"partitioned":{"description":"Flag to indicate this TaskResult is partitioned. (From the TaskResult used to launch the Workflow).","type":"boolean","example":true},"completed":{"type":"string","format":"date-time","description":"The completed DateTime of the TaskResult. (From the TaskResult used to launch the Workflow).","example":"2022-04-14T10:45:26.098-05:00"},"type":{"description":"Type of the TaskResult. (From the TaskResult used to launch the Workflow).","type":"string","example":"Workflow"},"launched":{"type":"string","format":"date-time","description":"The launched DateTime of the TaskResult. (From the TaskResult used to launch the Workflow).","example":"2022-04-14T10:45:26.114-05:00"},"pendingSignOffs":{"description":"The number of pending signoffs of this TaskResult. (From the TaskResult used to launch the Workflow).","type":"integer","example":2},"workflowName":{"description":"Name of the Workflow to launch.","type":"string","example":"Update Identity Adam.Kennedy AccessRequest"},"identityRequestId":{"description":"Id representing the identity request.","type":"string","example":"0000000001"},"workflowCaseId":{"description":"Id representing the workflow case (a running instance of a workflow).","type":"string","example":"c0a8019c808b1baa81808bde2c2201b3"},"workflowProcessId":{"type":"string","description":"Id representing the workflow monitoring process log.","example":"7f000001806719888180675c8f8a225g"},"retries":{"description":"The number of retries performed during the execution of provisioning activities.","type":"integer","example":1},"approvalSet":{"description":"XML representation of approvals.","type":"string","example":"example: "},"workflowSummary":{"description":"XML representation of the workflow summary.","type":"string","example":"example: \"\""},"input":{"description":"A list of input attributes of the Launched Workflow.","type":"object","properties":{"key":{"description":"The attribute key.","type":"string","example":"_workflowRef"},"value":{"description":"The attribute value.","type":"string","example":"UpdateIdentityWorkflow"},"type":{"description":"The attribute type.","type":"string","example":"string"}}},"output":{"description":"A list of output attributes of the Launched Workflow.","type":"object","properties":{"key":{"description":"The attribute key.","type":"string","example":"workflowSummary"},"value":{"description":"The attribute value.","type":"string","example":"\\n \\n \\n \\n\\n"},"type":{"description":"The attribute type.","type":"string","example":"application/xml"}}},"targetClass":{"description":"Target Class of the TaskResult. (From the TaskResult used to launch the Workflow).","type":"string","example":"Permission"},"name":{"description":"Name of the TaskResult. (From the TaskResult used to launch the Workflow).","type":"string","example":"Update Account Group a2a"},"messages":{"description":"List of messages of the TaskResult. (From the TaskResult used to launch the Workflow).","type":"array","items":{"example":["Task executed successfully."]}},"attributes":{"description":"A list of attributes of the TaskResult. (From the TaskResult used to launch the Workflow).","type":"array","items":{"properties":{"key":{"description":"The attribute key.","type":"string","example":"Workflow Summary"},"value":{"description":"The attribute value.","type":"string","example":"\\n \\n \\n \\n\\n"}}}},"id":{"description":"Unique identifier of the TaskResult. (From the TaskResult used to launch the Workflow).","type":"string","example":"7f00000180281df7818028c03252085c"},"completionStatus":{"type":"string","description":"Completion Status of the TaskResult. (From the TaskResult used to launch the Workflow).","enum":["Success","Warning","Error","Terminated","TempError"],"example":"Success"},"taskDefinition":{"type":"string","description":"Name of the TaskDefinition of the TaskResult. (From the TaskResult used to launch the Workflow).","example":"Workflow Launcher"},"terminated":{"description":"Flag to indicate this TaskResult is terminated. (From the TaskResult used to launch the Workflow).","type":"boolean","example":true},"launcher":{"description":"Launcher of the TaskResult. (From the TaskResult used to launch the Workflow).","type":"string","example":"spadmin"},"meta":{"type":"object","properties":{"created":{"description":"DateTime when the TaskResult was created. (From the TaskResult used to launch the Workflow).","type":"string","format":"date-time","example":"2022-04-14T10:44:54.834-05:00"},"location":{"description":"URL to the TaskResult. (From the TaskResult used to launch the Workflow).","type":"string","example":"http://localhost:8080/identityiq/scim/v2/TaskResults/7f00000180281df7818028c03252085c"},"lastModified":{"description":"DateTime of TaskResult last modification. (From the TaskResult used to launch the Workflow).","type":"string","format":"date-time","example":"2022-04-05T15:52:30.119-05:00"},"version":{"description":"TaskResult version. (From the TaskResult used to launch the Workflow).","type":"string","example":"\"W\"1649951094834\""},"resourceType":{"description":"Resource type of the metadata subject. (From the TaskResult used to launch the Workflow).","type":"string","example":"TaskResult"}}}}}}}}}}}},"method":"get","path":"/LaunchedWorkflows","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns all LaunchedWorkflow resources.","description":{"content":"This endpoint returns all LaunchedWorkflow resources.

      \nAttributes to include in the response can be specified with the 'attributes' query parameter.

      \nAttributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

      \nThe schema related to LaunchedWorkflow is: \n- **urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow**\n","type":"text/plain"},"url":{"path":["LaunchedWorkflows"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.","type":"text/plain"},"key":"filter","value":""},{"disabled":false,"description":{"content":"Allows sorting the results by a resource's attributes.","type":"text/plain"},"key":"sortBy","value":""},{"disabled":false,"description":{"content":"Determines what order to sort results in.","type":"text/plain"},"key":"sortOrder","value":""},{"disabled":false,"description":{"content":"Determines the starting index of the result set.","type":"text/plain"},"key":"startIndex","value":""},{"disabled":false,"description":{"content":"Specifies the number of results per page.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns all LaunchedWorkflow resources.' (launched-workflows-get)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns all LaunchedWorkflow resources. + + + +This endpoint returns all LaunchedWorkflow resources.

      +Attributes to include in the response can be specified with the 'attributes' query parameter.

      +Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

      +The schema related to LaunchedWorkflow is: +- **urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow** + + +
      Query Parameters
      + +Returned all SCIM resources for this endpoint.
      **LaunchedWorkflow responses include attributes from the TaskResult related to the Workflow execution.** + +
      Schema
        Resources undefined[]
        input object
        + +A list of input attributes of the Launched Workflow. + +
        output object
        + +A list of output attributes of the Launched Workflow. + +
        attributes undefined[]
        + +A list of attributes of the TaskResult. (From the TaskResult used to launch the Workflow). + +
        meta object
       \",\n \"workflowSummary\": \"example: \\\"\\\"\",\n \"input\": {\n \"key\": \"_workflowRef\",\n \"value\": \"UpdateIdentityWorkflow\",\n \"type\": \"string\"\n },\n \"output\": {\n \"key\": \"workflowSummary\",\n \"value\": \"\\\\n \\\\n \\\\n \\\\n\\\\n\",\n \"type\": \"application/xml\"\n },\n \"targetClass\": \"Permission\",\n \"name\": \"Update Account Group a2a\",\n \"messages\": [\n [\n \"Task executed successfully.\"\n ]\n ],\n \"attributes\": [\n {\n \"key\": \"Workflow Summary\",\n \"value\": \"\\\\n \\\\n \\\\n \\\\n\\\\n\"\n }\n ],\n \"id\": \"7f00000180281df7818028c03252085c\",\n \"completionStatus\": \"Success\",\n \"taskDefinition\": \"Workflow Launcher\",\n \"terminated\": true,\n \"launcher\": \"spadmin\",\n \"meta\": {\n \"created\": \"2022-04-14T10:44:54.834-05:00\",\n \"location\": \"http://localhost:8080/identityiq/scim/v2/TaskResults/7f00000180281df7818028c03252085c\",\n \"lastModified\": \"2022-04-05T15:52:30.119-05:00\",\n \"version\": \"\\\"W\\\"1649951094834\\\"\",\n \"resourceType\": \"TaskResult\"\n }\n }\n ]\n}"} language={"json"}>
      Schema
        Resources undefined[]
        + +The SCIM resources returned for this endpoint. + +
        input object
        + +A list of input attributes of the Launched Workflow. + +
        output object
        + +A list of output attributes of the Launched Workflow. + +
        attributes undefined[]
        + +A list of attributes of the TaskResult. (From the TaskResult used to launch the Workflow). + +
        meta object
       \",\n \"workflowSummary\": \"example: \\\"\\\"\",\n \"input\": {\n \"key\": \"_workflowRef\",\n \"value\": \"UpdateIdentityWorkflow\",\n \"type\": \"string\"\n },\n \"output\": {\n \"key\": \"workflowSummary\",\n \"value\": \"\\\\n \\\\n \\\\n \\\\n\\\\n\",\n \"type\": \"application/xml\"\n },\n \"targetClass\": \"Permission\",\n \"name\": \"Update Account Group a2a\",\n \"messages\": [\n [\n \"Task executed successfully.\"\n ]\n ],\n \"attributes\": [\n {\n \"key\": \"Workflow Summary\",\n \"value\": \"\\\\n \\\\n \\\\n \\\\n\\\\n\"\n }\n ],\n \"id\": \"7f00000180281df7818028c03252085c\",\n \"completionStatus\": \"Success\",\n \"taskDefinition\": \"Workflow Launcher\",\n \"terminated\": true,\n \"launcher\": \"spadmin\",\n \"meta\": {\n \"created\": \"2022-04-14T10:44:54.834-05:00\",\n \"location\": \"http://localhost:8080/identityiq/scim/v2/TaskResults/7f00000180281df7818028c03252085c\",\n \"lastModified\": \"2022-04-05T15:52:30.119-05:00\",\n \"version\": \"\\\"W\\\"1649951094834\\\"\",\n \"resourceType\": \"TaskResult\"\n }\n }\n ]\n}"} language={"json"}>
      \ No newline at end of file diff --git a/products/iiq/api/launched-workflows.tag.mdx b/products/iiq/api/launched-workflows.tag.mdx new file mode 100644 index 000000000..f1b4497ee --- /dev/null +++ b/products/iiq/api/launched-workflows.tag.mdx @@ -0,0 +1,16 @@ +--- +id: launched-workflows +title: "LaunchedWorkflows" +description: "LaunchedWorkflows" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/iiq/api/object-config.tag.mdx b/products/iiq/api/object-config.tag.mdx new file mode 100644 index 000000000..db2bc7293 --- /dev/null +++ b/products/iiq/api/object-config.tag.mdx @@ -0,0 +1,16 @@ +--- +id: object-config +title: "ObjectConfig" +description: "ObjectConfig" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/iiq/api/policy-violations.tag.mdx b/products/iiq/api/policy-violations.tag.mdx new file mode 100644 index 000000000..d04c9b5c5 --- /dev/null +++ b/products/iiq/api/policy-violations.tag.mdx @@ -0,0 +1,16 @@ +--- +id: policy-violations +title: "PolicyViolations" +description: "PolicyViolations" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/iiq/api/resource-types.tag.mdx b/products/iiq/api/resource-types.tag.mdx new file mode 100644 index 000000000..386beec18 --- /dev/null +++ b/products/iiq/api/resource-types.tag.mdx @@ -0,0 +1,16 @@ +--- +id: resource-types +title: "ResourceTypes" +description: "ResourceTypes" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/iiq/api/roles.tag.mdx b/products/iiq/api/roles.tag.mdx new file mode 100644 index 000000000..05e3337cf --- /dev/null +++ b/products/iiq/api/roles.tag.mdx @@ -0,0 +1,16 @@ +--- +id: roles +title: "Roles" +description: "Roles" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/iiq/api/schemas.tag.mdx b/products/iiq/api/schemas.tag.mdx new file mode 100644 index 000000000..261d61cc6 --- /dev/null +++ b/products/iiq/api/schemas.tag.mdx @@ -0,0 +1,16 @@ +--- +id: schemas +title: "Schemas" +description: "Schemas" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/iiq/api/service-provider-config-get.api.mdx b/products/iiq/api/service-provider-config-get.api.mdx new file mode 100644 index 000000000..1de0574ec --- /dev/null +++ b/products/iiq/api/service-provider-config-get.api.mdx @@ -0,0 +1,96 @@ +--- +id: service-provider-config-get +sidebar_label: Returns all ServiceProviderConfig resources. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"ServiceProviderConfigGet","tags":["ServiceProviderConfig"],"description":"This endpoint returns all ServiceProviderConfig resources.

      \nAttributes to include in the response can be specified with the 'attributes' query parameter.

      \nAttributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

      \nThe schema related to ServiceProviderConfig is:
      \n- **urn:ietf:params:scim:schemas:sailpoint:2.0:ServiceProviderConfig**\n","responses":{"200":{"description":"Returned all SCIM resources for this endpoint.","content":{"application/json":{"schema":{"properties":{"totalResults":{"description":"Number of resources returned for this endpoint.","type":"integer","example":"1,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"type":"array","items":{"required":["patch","etag","bulk","filter","changePassword","sort","authenticationSchemes"],"properties":{"documentationUri":{"description":"An HTTP addressable URL pointing to the service provider's human consumable help documentation.","type":"string","example":"https://community.sailpoint.com/community/identityiq/product-downloads"},"patch":{"description":"A complex type that specifies PATCH configuration options.","type":"object","required":["supported"],"properties":{"supported":{"type":"boolean","description":"Boolean value specifying whether the operation is supported.","example":false}}},"etag":{"description":"A complex type that specifies ETAG configuration options.","type":"object","required":["supported"],"properties":{"supported":{"description":"Boolean value specifying whether the operation is supported.","type":"boolean"}}},"bulk":{"description":"A complex type that specifies ETAG configuration options.","type":"object","required":["supported","maxOperations","maxPayloadSize"],"properties":{"supported":{"description":"Boolean value specifying whether the operation is supported.","type":"boolean","example":false},"maxOperations":{"description":"An integer value specifying the maximum number of operations.","type":"integer","example":3},"maxPayloadSize":{"description":"An integer value specifying the maximum payload size in bytes.","type":"integer","example":128}}},"filter":{"description":"A complex type that specifies FILTER options.","type":"object","required":["supported","maxResults"],"properties":{"supported":{"description":"Boolean value specifying whether the operation is supported.","type":"boolean","example":true},"maxResults":{"description":"Integer value specifying the maximum number of resources returned in a response.","type":"integer","example":10}}},"changePassword":{"description":"A complex type that specifies change password options.","type":"object","required":["supported"],"properties":{"supported":{"description":"Boolean value specifying whether the operation is supported.","type":"boolean","example":false}}},"sort":{"description":"A complex type that specifies sort result options.","type":"object","required":["supported"],"properties":{"supported":{"description":"Boolean value specifying whether the operation is supported.","type":"boolean","example":false}}},"authenticationSchemes":{"description":"A complex type that specifies supported Authentication Scheme properties.","type":"object","required":["name","description","type"],"properties":{"name":{"description":"The common authentication scheme name; e.g., HTTP Basic.","type":"string","example":"HTTP Basic"},"description":{"description":"A description of the authentication scheme.","type":"string","example":"Authentication Scheme using the Http Basic Standard."},"specUri":{"description":"An HTTP addressable URL pointing to the Authentication Scheme's specification.","type":"string","example":"http://www.ietf.org/rfc/rfc2617.txt"},"documentationUri":{"description":"An HTTP addressable URL pointing to the Authentication Scheme's usage documentation.","type":"string","example":"https://community.sailpoint.com/community/identityiq/product-downloads"},"type":{"type":"string","description":"The authentication scheme.","enum":["oauth","oauth2","oauthbearertoken","httpbasic","httpdigest"],"example":"oauthbearertoken"}}},"meta":{"type":"object","properties":{"location":{"type":"string","description":"URL to ServiceProviderConfig resource.","example":"http://localhost:8080/identityiq/scim/v2/ServiceProviderConfig"},"resourceType":{"type":"string","description":"Resource type of the metadata subject.","example":"ServiceProviderConfig"}}}}}}}}},"application/scim+json":{"schema":{"properties":{"maxResults":{"description":"Number of ServiceProviderConfig resources returned.","type":"integer","example":"1500,"},"supported":{"type":"boolean","example":true},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"description":"The SCIM resources returned for this endpoint.","type":"array","items":{"required":["patch","etag","bulk","filter","changePassword","sort","authenticationSchemes"],"properties":{"documentationUri":{"description":"An HTTP addressable URL pointing to the service provider's human consumable help documentation.","type":"string","example":"https://community.sailpoint.com/community/identityiq/product-downloads"},"patch":{"description":"A complex type that specifies PATCH configuration options.","type":"object","required":["supported"],"properties":{"supported":{"type":"boolean","description":"Boolean value specifying whether the operation is supported.","example":false}}},"etag":{"description":"A complex type that specifies ETAG configuration options.","type":"object","required":["supported"],"properties":{"supported":{"description":"Boolean value specifying whether the operation is supported.","type":"boolean"}}},"bulk":{"description":"A complex type that specifies ETAG configuration options.","type":"object","required":["supported","maxOperations","maxPayloadSize"],"properties":{"supported":{"description":"Boolean value specifying whether the operation is supported.","type":"boolean","example":false},"maxOperations":{"description":"An integer value specifying the maximum number of operations.","type":"integer","example":3},"maxPayloadSize":{"description":"An integer value specifying the maximum payload size in bytes.","type":"integer","example":128}}},"filter":{"description":"A complex type that specifies FILTER options.","type":"object","required":["supported","maxResults"],"properties":{"supported":{"description":"Boolean value specifying whether the operation is supported.","type":"boolean","example":true},"maxResults":{"description":"Integer value specifying the maximum number of resources returned in a response.","type":"integer","example":10}}},"changePassword":{"description":"A complex type that specifies change password options.","type":"object","required":["supported"],"properties":{"supported":{"description":"Boolean value specifying whether the operation is supported.","type":"boolean","example":false}}},"sort":{"description":"A complex type that specifies sort result options.","type":"object","required":["supported"],"properties":{"supported":{"description":"Boolean value specifying whether the operation is supported.","type":"boolean","example":false}}},"authenticationSchemes":{"description":"A complex type that specifies supported Authentication Scheme properties.","type":"object","required":["name","description","type"],"properties":{"name":{"description":"The common authentication scheme name; e.g., HTTP Basic.","type":"string","example":"HTTP Basic"},"description":{"description":"A description of the authentication scheme.","type":"string","example":"Authentication Scheme using the Http Basic Standard."},"specUri":{"description":"An HTTP addressable URL pointing to the Authentication Scheme's specification.","type":"string","example":"http://www.ietf.org/rfc/rfc2617.txt"},"documentationUri":{"description":"An HTTP addressable URL pointing to the Authentication Scheme's usage documentation.","type":"string","example":"https://community.sailpoint.com/community/identityiq/product-downloads"},"type":{"type":"string","description":"The authentication scheme.","enum":["oauth","oauth2","oauthbearertoken","httpbasic","httpdigest"],"example":"oauthbearertoken"}}},"meta":{"type":"object","properties":{"location":{"type":"string","description":"URL to ServiceProviderConfig resource.","example":"http://localhost:8080/identityiq/scim/v2/ServiceProviderConfig"},"resourceType":{"type":"string","description":"Resource type of the metadata subject.","example":"ServiceProviderConfig"}}}}}}}}}}}},"method":"get","path":"/ServiceProviderConfig","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns all ServiceProviderConfig resources.","description":{"content":"This endpoint returns all ServiceProviderConfig resources.

      \nAttributes to include in the response can be specified with the 'attributes' query parameter.

      \nAttributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

      \nThe schema related to ServiceProviderConfig is:
      \n- **urn:ietf:params:scim:schemas:sailpoint:2.0:ServiceProviderConfig**\n","type":"text/plain"},"url":{"path":["ServiceProviderConfig"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns all ServiceProviderConfig resources.' (service-provider-config-get)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns all ServiceProviderConfig resources. + + + +This endpoint returns all ServiceProviderConfig resources.

      +Attributes to include in the response can be specified with the 'attributes' query parameter.

      +Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

      +The schema related to ServiceProviderConfig is:
      +- **urn:ietf:params:scim:schemas:sailpoint:2.0:ServiceProviderConfig** + + +
      + +Returned all SCIM resources for this endpoint. + +
      Schema
        Resources undefined[]
        patch object
        + +A complex type that specifies PATCH configuration options. + +
        etag object
        + +A complex type that specifies ETAG configuration options. + +
        bulk object
        + +A complex type that specifies ETAG configuration options. + +
        filter object
        + +A complex type that specifies FILTER options. + +
        changePassword object
        + +A complex type that specifies change password options. + +
        sort object
        + +A complex type that specifies sort result options. + +
        authenticationSchemes object
        + +A complex type that specifies supported Authentication Scheme properties. + +
        meta object
      Schema
        Resources undefined[]
        + +The SCIM resources returned for this endpoint. + +
        patch object
        + +A complex type that specifies PATCH configuration options. + +
        etag object
        + +A complex type that specifies ETAG configuration options. + +
        bulk object
        + +A complex type that specifies ETAG configuration options. + +
        filter object
        + +A complex type that specifies FILTER options. + +
        changePassword object
        + +A complex type that specifies change password options. + +
        sort object
        + +A complex type that specifies sort result options. + +
        authenticationSchemes object
        + +A complex type that specifies supported Authentication Scheme properties. + +
        meta object
      \ No newline at end of file diff --git a/products/iiq/api/service-provider-config.tag.mdx b/products/iiq/api/service-provider-config.tag.mdx new file mode 100644 index 000000000..b195c7498 --- /dev/null +++ b/products/iiq/api/service-provider-config.tag.mdx @@ -0,0 +1,16 @@ +--- +id: service-provider-config +title: "ServiceProviderConfig" +description: "ServiceProviderConfig" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/iiq/api/sidebar.js b/products/iiq/api/sidebar.js new file mode 100644 index 000000000..caca09b16 --- /dev/null +++ b/products/iiq/api/sidebar.js @@ -0,0 +1 @@ +module.exports = [{"type":"doc","id":"api/identityiq-scim-rest-api"},{"type":"category","label":"Accounts","link":{"type":"doc","id":"api/accounts"},"items":[{"type":"doc","id":"api/get-accounts","label":"Returns all Account resources.","className":"api-method get"},{"type":"doc","id":"api/create-account","label":"Creates an Account.","className":"api-method post"},{"type":"doc","id":"api/get-account-by-id","label":"Returns an Account resource based on id.","className":"api-method get"},{"type":"doc","id":"api/update-account","label":"Updates an existing Account.","className":"api-method put"},{"type":"doc","id":"api/delete-account","label":"Deletes an existing Account.","className":"api-method delete"}]},{"type":"category","label":"Alerts","link":{"type":"doc","id":"api/alerts"},"items":[{"type":"doc","id":"api/get-alerts","label":"Returns all Alert resources.","className":"api-method get"},{"type":"doc","id":"api/create-alert","label":"Creates a new Alert.","className":"api-method post"},{"type":"doc","id":"api/get-alert-by-id","label":"Returns an Alert resource based on id.","className":"api-method get"}]},{"type":"category","label":"Applications","link":{"type":"doc","id":"api/applications"},"items":[{"type":"doc","id":"api/get-applications","label":"Returns all Application resources.","className":"api-method get"},{"type":"doc","id":"api/get-application","label":"Returns an Application resource based on id or name.","className":"api-method get"}]},{"type":"category","label":"Checked Policy Violations","link":{"type":"doc","id":"api/checked-policy-violations"},"items":[{"type":"doc","id":"api/check-policy-violations","label":"This endpoint simulates provisioning a set of access items, and then checks against a set of policies to determine if granting the access items would cause creation of new policy violations.","className":"api-method post"}]},{"type":"category","label":"Entitlements","link":{"type":"doc","id":"api/entitlements"},"items":[{"type":"doc","id":"api/get-entitlements","label":"Returns all Entitlement resources.","className":"api-method get"},{"type":"doc","id":"api/get-entitlement-by-id","label":"Returns an Entitlement resource based on id.","className":"api-method get"}]},{"type":"category","label":"LaunchedWorkflows","link":{"type":"doc","id":"api/launched-workflows"},"items":[{"type":"doc","id":"api/launched-workflows-get","label":"Returns all LaunchedWorkflow resources.","className":"api-method get"},{"type":"doc","id":"api/launch-workflow","label":"Endpoint used to launch a Workflow.","className":"api-method post"},{"type":"doc","id":"api/get-launched-workflow-by-id","label":"Returns a LaunchedWorkflow resource based on id.","className":"api-method get"}]},{"type":"category","label":"ObjectConfig","link":{"type":"doc","id":"api/object-config"},"items":[{"type":"doc","id":"api/get-object-configs","label":"Returns all object of type ObjectConfig.","className":"api-method get"},{"type":"doc","id":"api/get-object-config-by-id","label":"Returns an ObjectConfig resource based on its name or id.","className":"api-method get"}]},{"type":"category","label":"PolicyViolations","link":{"type":"doc","id":"api/policy-violations"},"items":[{"type":"doc","id":"api/get-policy-violations","label":"Returns all PolicyViolation resources.","className":"api-method get"},{"type":"doc","id":"api/get-policy-violation-by-id","label":"Returns a PolicyViolation resource based on id.","className":"api-method get"}]},{"type":"category","label":"ResourceTypes","link":{"type":"doc","id":"api/resource-types"},"items":[{"type":"doc","id":"api/get-resource-types","label":"Returns all ResourceType resources.","className":"api-method get"},{"type":"doc","id":"api/get-resource-type-by-id","label":"Returns a ResourceType resource based on ID.","className":"api-method get"}]},{"type":"category","label":"Roles","link":{"type":"doc","id":"api/roles"},"items":[{"type":"doc","id":"api/get-roles","label":"Returns all Role resources.","className":"api-method get"},{"type":"doc","id":"api/get-role","label":"Returns a Role resource based on ID or name.","className":"api-method get"}]},{"type":"category","label":"Schemas","link":{"type":"doc","id":"api/schemas"},"items":[{"type":"doc","id":"api/get-schemas","label":"Returns all Schema resources.","className":"api-method get"},{"type":"doc","id":"api/get-schema-by-id","label":"Returns a Schema based on id.","className":"api-method get"}]},{"type":"category","label":"ServiceProviderConfig","link":{"type":"doc","id":"api/service-provider-config"},"items":[{"type":"doc","id":"api/service-provider-config-get","label":"Returns all ServiceProviderConfig resources.","className":"api-method get"}]},{"type":"category","label":"TaskResults","link":{"type":"doc","id":"api/task-results"},"items":[{"type":"doc","id":"api/task-results-get","label":"Returns all TaskResult resources.","className":"api-method get"},{"type":"doc","id":"api/get-task-result-by-id","label":"Returns a TaskResult resource based on id.","className":"api-method get"}]},{"type":"category","label":"Users","link":{"type":"doc","id":"api/users"},"items":[{"type":"doc","id":"api/get-users","label":"Returns all User resources.","className":"api-method get"},{"type":"doc","id":"api/create-user","label":"Creates a User.","className":"api-method post"},{"type":"doc","id":"api/get-user-by-id","label":"Returns a User resource based on id.","className":"api-method get"},{"type":"doc","id":"api/update-user","label":"Updates an existing User.","className":"api-method put"},{"type":"doc","id":"api/delete-user","label":"Deletes an existing User.","className":"api-method delete"}]},{"type":"category","label":"Workflows","link":{"type":"doc","id":"api/workflows"},"items":[{"type":"doc","id":"api/workflows-get","label":"Returns all Workflow resources.","className":"api-method get"},{"type":"doc","id":"api/get-workflow-by-id","label":"Returns a Workflow resource based on id.","className":"api-method get"}]}]; \ No newline at end of file diff --git a/products/iiq/api/task-results-get.api.mdx b/products/iiq/api/task-results-get.api.mdx new file mode 100644 index 000000000..fbb66f401 --- /dev/null +++ b/products/iiq/api/task-results-get.api.mdx @@ -0,0 +1,48 @@ +--- +id: task-results-get +sidebar_label: Returns all TaskResult resources. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"TaskResultsGet","tags":["TaskResults"],"description":"This endpoint returns all TaskResult resources.

      \nAttributes to include in the response can be specified with the 'attributes' query parameter.

      \nAttributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

      \nThe schema related to TaskResult is:\n- **urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult**\n","parameters":[{"in":"query","name":"filter","schema":{"type":"string","example":"name eq \"AdminsAggTask\""},"description":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported."},{"in":"query","name":"lookupByName","schema":{"type":"boolean","default":false,"example":true},"description":"**(OPTIONAL)** Set to true if the TaskResult name is passed instead of the TaskResult id."},{"in":"query","name":"sortBy","schema":{"type":"string","example":"launched"},"description":"Allows sorting the results by a resource's attributes."},{"in":"query","name":"sortOrder","schema":{"type":"string","default":"ascending"},"example":"descending","description":"Determines what order to sort results in."},{"in":"query","name":"startIndex","schema":{"type":"integer","example":10,"default":1},"description":"Determines the starting index of the result set."},{"in":"query","name":"count","schema":{"type":"integer","example":5,"default":1000},"description":"Specifies the number of results per page."},{"in":"query","name":"attributes","schema":{"type":"string","example":"completionStatus, attributes"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"taskDefinition, host"},"description":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**"}],"responses":{"200":{"description":"Returned all SCIM resources for this endpoint.","content":{"application/json":{"schema":{"properties":{"totalResults":{"description":"Number of resources returned for this endpoint","type":"integer","example":"1,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"type":"array","items":{"properties":{"id":{"description":"Unique identifier of the TaskResult.","type":"string","example":"7f00000180281df7818028c03252085c"},"name":{"description":"Name of the TaskResult.","type":"string","example":"Aggregate HR Authoritative"},"type":{"description":"Type of the TaskResult.","type":"string","example":"AccountAggregation"},"completionStatus":{"type":"string","description":"Completion Status of the TaskResult.","enum":["Success","Warning","Error","Terminated","TempError"],"example":"Success"},"launcher":{"description":"Launcher of the TaskResult.","type":"string","example":"spadmin"},"host":{"description":"Host of the TaskResult.","type":"string","example":"centos-server.local"},"progress":{"description":"Progress of the TaskResult.","type":"string","example":"Launched 2 partitions."},"targetClass":{"description":"Target Class of the TaskResult.","type":"string","example":"Permission"},"targetName":{"description":"Target Name of the Task Result.","type":"string","example":"PAM Credential Container"},"terminated":{"description":"Flag to indicate this TaskResult is terminated.","type":"boolean","example":true},"partitioned":{"description":"Flag to indicate this TaskResult is partitioned.","type":"boolean","example":true},"launched":{"type":"string","format":"date-time","description":"The launched DateTime of the TaskResult.","example":"2022-04-14T10:45:26.114-05:00"},"completed":{"type":"string","format":"date-time","description":"The completed DateTime of the TaskResult.","example":"2022-04-14T10:45:26.098-05:00"},"expiration":{"type":"string","format":"date-time","description":"The expiration DateTime of the TaskResult.","example":"2022-05-03T16:40:34.271-05:00"},"verified":{"type":"string","format":"date-time","description":"The verification DateTime of the TaskResult.","example":"2022-05-03T16:40:34.271-05:00"},"percentageComplete":{"type":"integer","description":"The percentage completed of this TaskResult.","example":55},"pendingSignOffs":{"description":"The number of pending signoffs of this TaskResult.","type":"integer","example":2},"taskDefinition":{"type":"string","description":"Name of the TaskDefinition of the TaskResult.","example":"Aggregate HR Authoritative"},"taskSchedule":{"description":"Name of the TaskSchedule of the TaskResult.","type":"string","example":"Perform maintenance"},"attributes":{"description":"A list of attributes of the TaskResult.","type":"array","items":{"properties":{"key":{"description":"The attribute key.","type":"string","example":"total"},"value":{"description":"The attribute value.","type":"string","example":"3"}}}},"messages":{"description":"List of messages of the TaskResult.","type":"array","items":{"example":["Unathorized access to database in server: 192.100.1.25"]}},"meta":{"type":"object","properties":{"created":{"description":"DateTime when the TaskResult was created.","type":"string","format":"date-time","example":"2022-04-14T10:44:54.834-05:00"},"location":{"description":"URL to the TaskResult.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/TaskResults/7f00000180281df7818028c03252085c"},"lastModified":{"description":"DateTime of TaskResult last modification.","type":"string","format":"date-time","example":"2022-04-05T15:52:30.119-05:00"},"version":{"description":"TaskResult version.","type":"string","example":"\"W\"1649951094834\""},"resourceType":{"description":"Resource type of the metadata subject.","type":"string","example":"TaskResult"}}},"schemas":{"type":"array","example":["urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult"]}}}}}}},"application/scim+json":{"schema":{"properties":{"totalResults":{"description":"Number of TaskResult resources returned.","type":"integer","example":"1500,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"description":"The SCIM resources returned for this endpoint.","type":"array","items":{"properties":{"id":{"description":"Unique identifier of the TaskResult.","type":"string","example":"7f00000180281df7818028c03252085c"},"name":{"description":"Name of the TaskResult.","type":"string","example":"Aggregate HR Authoritative"},"type":{"description":"Type of the TaskResult.","type":"string","example":"AccountAggregation"},"completionStatus":{"type":"string","description":"Completion Status of the TaskResult.","enum":["Success","Warning","Error","Terminated","TempError"],"example":"Success"},"launcher":{"description":"Launcher of the TaskResult.","type":"string","example":"spadmin"},"host":{"description":"Host of the TaskResult.","type":"string","example":"centos-server.local"},"progress":{"description":"Progress of the TaskResult.","type":"string","example":"Launched 2 partitions."},"targetClass":{"description":"Target Class of the TaskResult.","type":"string","example":"Permission"},"targetName":{"description":"Target Name of the Task Result.","type":"string","example":"PAM Credential Container"},"terminated":{"description":"Flag to indicate this TaskResult is terminated.","type":"boolean","example":true},"partitioned":{"description":"Flag to indicate this TaskResult is partitioned.","type":"boolean","example":true},"launched":{"type":"string","format":"date-time","description":"The launched DateTime of the TaskResult.","example":"2022-04-14T10:45:26.114-05:00"},"completed":{"type":"string","format":"date-time","description":"The completed DateTime of the TaskResult.","example":"2022-04-14T10:45:26.098-05:00"},"expiration":{"type":"string","format":"date-time","description":"The expiration DateTime of the TaskResult.","example":"2022-05-03T16:40:34.271-05:00"},"verified":{"type":"string","format":"date-time","description":"The verification DateTime of the TaskResult.","example":"2022-05-03T16:40:34.271-05:00"},"percentageComplete":{"type":"integer","description":"The percentage completed of this TaskResult.","example":55},"pendingSignOffs":{"description":"The number of pending signoffs of this TaskResult.","type":"integer","example":2},"taskDefinition":{"type":"string","description":"Name of the TaskDefinition of the TaskResult.","example":"Aggregate HR Authoritative"},"taskSchedule":{"description":"Name of the TaskSchedule of the TaskResult.","type":"string","example":"Perform maintenance"},"attributes":{"description":"A list of attributes of the TaskResult.","type":"array","items":{"properties":{"key":{"description":"The attribute key.","type":"string","example":"total"},"value":{"description":"The attribute value.","type":"string","example":"3"}}}},"messages":{"description":"List of messages of the TaskResult.","type":"array","items":{"example":["Unathorized access to database in server: 192.100.1.25"]}},"meta":{"type":"object","properties":{"created":{"description":"DateTime when the TaskResult was created.","type":"string","format":"date-time","example":"2022-04-14T10:44:54.834-05:00"},"location":{"description":"URL to the TaskResult.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/TaskResults/7f00000180281df7818028c03252085c"},"lastModified":{"description":"DateTime of TaskResult last modification.","type":"string","format":"date-time","example":"2022-04-05T15:52:30.119-05:00"},"version":{"description":"TaskResult version.","type":"string","example":"\"W\"1649951094834\""},"resourceType":{"description":"Resource type of the metadata subject.","type":"string","example":"TaskResult"}}},"schemas":{"type":"array","example":["urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult"]}}}}}}}}}},"method":"get","path":"/TaskResults","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns all TaskResult resources.","description":{"content":"This endpoint returns all TaskResult resources.

      \nAttributes to include in the response can be specified with the 'attributes' query parameter.

      \nAttributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

      \nThe schema related to TaskResult is:\n- **urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult**\n","type":"text/plain"},"url":{"path":["TaskResults"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.","type":"text/plain"},"key":"filter","value":""},{"disabled":false,"description":{"content":"**(OPTIONAL)** Set to true if the TaskResult name is passed instead of the TaskResult id.","type":"text/plain"},"key":"lookupByName","value":""},{"disabled":false,"description":{"content":"Allows sorting the results by a resource's attributes.","type":"text/plain"},"key":"sortBy","value":""},{"disabled":false,"description":{"content":"Determines what order to sort results in.","type":"text/plain"},"key":"sortOrder","value":""},{"disabled":false,"description":{"content":"Determines the starting index of the result set.","type":"text/plain"},"key":"startIndex","value":""},{"disabled":false,"description":{"content":"Specifies the number of results per page.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns all TaskResult resources.' (task-results-get)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns all TaskResult resources. + + + +This endpoint returns all TaskResult resources.

      +Attributes to include in the response can be specified with the 'attributes' query parameter.

      +Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

      +The schema related to TaskResult is: +- **urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult** + + +
      Query Parameters
      + +Returned all SCIM resources for this endpoint. + +
      Schema
        Resources undefined[]
        attributes undefined[]
        + +A list of attributes of the TaskResult. + +
        meta object
      Schema
        Resources undefined[]
        + +The SCIM resources returned for this endpoint. + +
        attributes undefined[]
        + +A list of attributes of the TaskResult. + +
        meta object
      \ No newline at end of file diff --git a/products/iiq/api/task-results.tag.mdx b/products/iiq/api/task-results.tag.mdx new file mode 100644 index 000000000..8e6e9005b --- /dev/null +++ b/products/iiq/api/task-results.tag.mdx @@ -0,0 +1,16 @@ +--- +id: task-results +title: "TaskResults" +description: "TaskResults" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/iiq/api/update-account.api.mdx b/products/iiq/api/update-account.api.mdx new file mode 100644 index 000000000..328443aef --- /dev/null +++ b/products/iiq/api/update-account.api.mdx @@ -0,0 +1,71 @@ +--- +id: update-account +sidebar_label: Updates an existing Account. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateAccount","tags":["Accounts"],"description":"The endpoint used to update an Account resource. The required payload fields depend on the corresponding Application.","parameters":[{"name":"accountId","in":"path","schema":{"type":"string","example":"c7c7777c7ef77e77777ee77e7a1f0444"},"description":"The id of the Account.","required":true},{"in":"query","name":"attributes","schema":{"type":"string","example":"displayName,active"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"displayName,active"},"description":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*"}],"requestBody":{"required":true,"content":{"application/scim+json":{"schema":{"properties":{"identity":{"required":["value"],"description":"The corresponding User object of the Account.","properties":{"userName":{"description":"The identity name of the Account User.","type":"string","example":"Barbara.Jensen"},"displayName":{"description":"The displayable name of the Account User.","type":"string","example":"Barbara Jensen"},"value":{"description":"IdentityIQ identifier for the Account User.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"ref":{"description":"The URI of the SCIM resource representing the Account User.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"application":{"required":["value"],"description":"The corresponding Application object of the Account.","properties":{"displayName":{"description":"The displayable name of the Account Application.","type":"string","example":"Mock Application1"},"value":{"description":"IdentityIQ identifier for the Account Application.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"ref":{"description":"The URI of the SCIM resource representing the Account Application.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Applications/c0a7778b7ef71e79817ee74e6a1f0444"}}},"nativeIdentity":{"description":"The Account unique identifier associated with the native application. This field is immutable.","type":"string","example":"a1b2c3"},"displayName":{"description":"The name of the Account, suitable for display to end-users.","type":"string","example":"Barbara Jensen"},"instance":{"description":"The instance identifier of the Account. This field is immutable.","type":"string","example":"mockInstance"},"password":{"description":"The password of the Account, used in created or changing the Account password. This attribute is write-only and will never be returned in a response.","type":"string","example":"useStrongPwd123!"},"currentPassword":{"description":"The current password of the Account, used in created or changing the Account password. This attribute is write-only and will never be returned in a response.","type":"string","example":"useStrongPwd123!"},"urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account":{"description":"Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.

      Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true},"active":{"description":"Flag to indicate this account is enabled or disabled.","type":"boolean","example":true},"locked":{"description":"Flag to indicate this account is locked. An account may be unlocked by setting this attribute to false, but can not be locked by setting a false value to true.","type":"boolean","example":true}},"required":["identity","application","nativeIdentity","urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account"]}},"*/*":{"schema":{"properties":{"identity":{"required":["value"],"description":"The corresponding User object of the Account.","properties":{"userName":{"description":"The identity name of the Account User.","type":"string","example":"Barbara.Jensen"},"displayName":{"description":"The displayable name of the Account User.","type":"string","example":"Barbara Jensen"},"value":{"description":"IdentityIQ identifier for the Account User.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"ref":{"description":"The URI of the SCIM resource representing the Account User.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"application":{"required":["value"],"description":"The corresponding Application object of the Account.","properties":{"displayName":{"description":"The displayable name of the Account Application.","type":"string","example":"Mock Application1"},"value":{"description":"IdentityIQ identifier for the Account Application.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"ref":{"description":"The URI of the SCIM resource representing the Account Application.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Applications/c0a7778b7ef71e79817ee74e6a1f0444"}}},"nativeIdentity":{"description":"The Account unique identifier associated with the native application. This field is immutable.","type":"string","example":"a1b2c3"},"displayName":{"description":"The name of the Account, suitable for display to end-users.","type":"string","example":"Barbara Jensen"},"instance":{"description":"The instance identifier of the Account. This field is immutable.","type":"string","example":"mockInstance"},"password":{"description":"The password of the Account, used in created or changing the Account password. This attribute is write-only and will never be returned in a response.","type":"string","example":"useStrongPwd123!"},"currentPassword":{"description":"The current password of the Account, used in created or changing the Account password. This attribute is write-only and will never be returned in a response.","type":"string","example":"useStrongPwd123!"},"urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account":{"description":"Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.

      Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true},"active":{"description":"Flag to indicate this account is enabled or disabled.","type":"boolean","example":true},"locked":{"description":"Flag to indicate this account is locked. An account may be unlocked by setting this attribute to false, but can not be locked by setting a false value to true.","type":"boolean","example":true}},"required":["identity","application","nativeIdentity","urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account"]}}}},"responses":{"200":{"description":"Updates an existing Account and returns that Account.","content":{"application/json":{"schema":{"properties":{"id":{"description":"IdentityIQ id of the Account.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"identity":{"description":"The corresponding User object of the Account.","properties":{"userName":{"description":"The identity name of the Account User.","type":"string","example":"Barbara.Jensen"},"displayName":{"description":"The displayable name of the Account User.","type":"string","example":"Barbara Jensen"},"value":{"description":"IdentityIQ identifier for the Account User.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"ref":{"description":"The URI of the SCIM resource representing the Account User.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"application":{"description":"The corresponding Application object of the Account.","properties":{"displayName":{"description":"The displayable name of the Account Application.","type":"string","example":"Mock Application1"},"value":{"description":"IdentityIQ identifier for the Account Application.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"ref":{"description":"The URI of the SCIM resource representing the Account Application.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Applications/c0a7778b7ef71e79817ee74e6a1f0444"}}},"nativeIdentity":{"description":"The Account unique identifier associated with the native application. This field is immutable.","type":"string","example":"a1b2c3"},"displayName":{"description":"The name of the Account, suitable for display to end-users.","type":"string","example":"Barbara Jensen"},"instance":{"description":"The instance identifier of the Account. This field is immutable.","type":"string","example":null},"uuid":{"description":"The UUID of the Account.","type":"string","example":"{f99999ff-f000-444b-b6ae-4443dd6cd6ed}"},"urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account":{"description":"Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.

      Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true},"active":{"description":"Flag to indicate this account is enabled or disabled.","type":"boolean","example":true},"locked":{"description":"Flag to indicate this account is locked. An account may be unlocked by setting this attribute to false, but can not be locked by setting a false value to true.","type":"boolean","example":true},"manuallyCorrelated":{"description":"Flag to indicate this account has been manually correlated in the UI.","type":"boolean","example":true},"hasEntitlements":{"description":"Flag to indicate this account has one or more entitlement attributes.","type":"boolean","example":true},"lastRefresh":{"description":"Datetime representation of the last refresh for this Account.","type":"string","format":"date-time"},"lastTargetAggregation":{"description":"Datetime representation of last targeted aggregation for the Account.","type":"string","format":"date-time"},"meta":{"description":"Metadata of the SCIM resource.","properties":{"created":{"description":"Datetime this resource was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Accounts/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the resource was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the SCIM resource.","type":"string","example":"W\"1644561244074\""},"resourceType":{"description":"The resource type.","type":"string","example":"Account"}}},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:Account","urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Mock Application:account"]}}}}}}},"method":"put","path":"/Accounts/{accountId}","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"jsonRequestBodyExample":{"identity":{"userName":"Barbara.Jensen","displayName":"Barbara Jensen","value":"c0a7778b7ef71e79817ee74e6a1f0444","ref":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"},"application":{"displayName":"Mock Application1","value":"c0a7778b7ef71e79817ee74e6a1f0444","ref":"http://localhost:8080/iiq/scim/v2/Applications/c0a7778b7ef71e79817ee74e6a1f0444"},"nativeIdentity":"a1b2c3","displayName":"Barbara Jensen","instance":"mockInstance","password":"useStrongPwd123!","currentPassword":"useStrongPwd123!","urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account":{},"active":true,"locked":true},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Updates an existing Account.","description":{"content":"The endpoint used to update an Account resource. The required payload fields depend on the corresponding Application.","type":"text/plain"},"url":{"path":["Accounts",":accountId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The id of the Account.","type":"text/plain"},"type":"any","value":"","key":"accountId"}]},"header":[{"key":"Content-Type","value":"application/scim+json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "put api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Updates an existing Account.' (update-account)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Updates an existing Account. + + + +The endpoint used to update an Account resource. The required payload fields depend on the corresponding Application. + +
      Path Parameters
      Query Parameters
      Request Body required
        identity required
        + +The corresponding User object of the Account. + +
        application required
        + +The corresponding Application object of the Account. + +
        urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account object required
        + +Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.

        Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { "department": "IT"} + +
      Request Body required
        identity required
        + +The corresponding User object of the Account. + +
        application required
        + +The corresponding Application object of the Account. + +
        urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account object required
        + +Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.

        Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { "department": "IT"} + +
      + +Updates an existing Account and returns that Account. + +
      Schema
        identity
        + +The corresponding User object of the Account. + +
        application
        + +The corresponding Application object of the Account. + +
        urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account object
        + +Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.

        Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { "department": "IT"} + +
        meta
        + +Metadata of the SCIM resource. + +
      \ No newline at end of file diff --git a/products/iiq/api/update-user.api.mdx b/products/iiq/api/update-user.api.mdx new file mode 100644 index 000000000..2064a3e6f --- /dev/null +++ b/products/iiq/api/update-user.api.mdx @@ -0,0 +1,135 @@ +--- +id: update-user +sidebar_label: Updates an existing User. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateUser","tags":["Users"],"description":"The endpoint used to update a User resource. There are attributes marked as 'returned only by request', such as **roles**, which must be provided as part of the **attributes** query parameter in order to be included in the response.

      In order for Lifecycle Events to have access to previous Identity values, a new IdentityArchive object is created and saved to the database. This feature is turned on by default and *could* have an impact on the overall performance of the SCIM update. It is not expected for the impact of this change to be noticeable, but in cases where it is, and when configured Lifecycle Events are not dependent on the previous Identity attributes, the creation of the IdentityArchive object during a SCIM update is configurable. By default, the IdentityArchive creation during a SCIM update is enabled. To disable the creation of the IdentityArchive object during SCIM updates, the following attribute can be set on the SystemConfiguration object:

      **<entry key=\"scimTriggerSnapshots\" value=\"false\">**","parameters":[{"name":"userId","in":"path","schema":{"type":"string","example":"c7c7777c7ef77e77777ee77e7a1f0444"},"description":"The id of User resource. If **lookupByName** is set to **true**, this path parameter should be set to the **userName** of the User.","required":true},{"in":"query","name":"attributes","schema":{"type":"string"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string"},"description":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*"},{"in":"query","name":"lookupByName","schema":{"type":"boolean","example":false,"default":false},"description":"A boolean value that determines if the User resource will be looked up by userName instead of userId (value in path parameter 'userId'). Setting this query parameter to true will cause the value pulled from the 'userId' path parameter to be treated as a userName when searching for the resource.

      **Example**: scim/v2/Users/**Mock.User**?**lookupByName=true**"}],"requestBody":{"required":true,"content":{"application/scim+json":{"schema":{"properties":{"userName":{"description":"Unique identifier for the User. Typically used to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the entire set of Users. This attribute cannot be changed.","type":"string","example":"Mock.User"},"name":{"description":"The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.","properties":{"formatted":{"description":"The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.","type":"string","example":"Ms. Barbara J Jensen, III"},"familyName":{"description":"The family name of the User, or Last Name in most Western languages","type":"string","example":"Jensen"},"givenName":{"description":"The given name of the User, or First Name in most Western languages","type":"string","example":"Barbara"}}},"displayName":{"description":"The name of the User, suitable for display to end-users. The name should be the full name of the User being described.","type":"string","example":"Barbara Jensen"},"userType":{"description":"The type of the User, identifying the relationship between the organization and the User.","type":"string","example":"employee"},"active":{"description":"A Boolean value indicating the User’s administrative status.","type":"boolean","example":true},"password":{"description":"The User's case-sensitive cleartext password. This attribute is intended to be used as a means to specify an initial password when creating a new User or to reset an existing User's password. This attribute will never be returned in a response.","type":"string"},"emails":{"description":"Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.","type":"array","items":{"properties":{"type":{"description":"Type of email address (work, home, other).","type":"string","example":"work"},"value":{"description":"Canonicalized email address.","type":"string","format":"email","example":"Barbara.Jensen@example.com"},"primary":{"description":"A Boolean value indicating the primary e-mail address. The primary attribute value 'true' MUST appear no more than once.","type":"boolean","example":"true"}}}},"urn:ietf:params:scim:schemas:sailpoint:1.0:User":{"properties":{"capabilities":{"description":"Capabilities assigned to this User.","type":"array","items":{"type":"string"},"example":"[\"SystemAdministrator\"]"},"administrator":{"description":"The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service.","properties":{"displayName":{"description":"The display name of the Administrator of RPA user or Service account.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the SCIM resource representing the Administrator of RPA user or Service account.","type":"string","example":"c0a7777a7f74744d817e74fc12362c67O"},"$ref":{"description":"The URI of the SCIM resource representing the Administrator of RPA user or Service Account.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67"}}},"softwareVersion":{"description":"The software version of the RPA/Bots.","type":"string","example":"7.3"},"empId":{"description":"Employee id associated with this User.","type":"string","example":"1b2a3c"},"dn":{"description":"Distinguished name for this User.","type":"string","example":"cn=Bob Smith,ou=services"},"region":{"description":"The region this User is assigned to.","type":"string","example":"Americas"},"regionOwner":{"description":"The User who owns the region that this resource (User) belongs to.","properties":{"displayName":{"description":"Display name of the region owner.","type":"string","example":"Joe Smith"},"value":{"description":"The id of the region owner.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"$ref":{"description":"URI reference of the region owner resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"}}},"location":{"description":"The location this User is assigned to.","type":"string","example":"Singapore"},"locationOwner":{"description":"The User who owns the location that this resource (User) belongs to.","type":"object","properties":{"displayName":{"description":"Display name of the location owner.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the location owner.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"URI reference to the location owner resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"Department":{"description":"Department this User is assigned to.","type":"string","example":"Regional Operations"},"costcenter":{"description":"Cost centers this User is associated with.","type":"array","items":{"type":"string"},"example":["CC01","DD02"]},"jobtitle":{"description":"Job title given to this User.","type":"string","example":"Internal Audit Manager"}}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"description":"Enterprise User Schema. Contains the manager of the User.","properties":{"manager":{"description":"Manager of the user.","properties":{"displayName":{"description":"Display name of the manager.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the manager.","type":"string","example":"c7a7347a7fe71e69077ee75f5d1f1237"},"$ref":{"description":"Reference to the manager resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237"}}}}}},"required":["userName"]}},"*/*":{"schema":{"properties":{"userName":{"description":"Unique identifier for the User. Typically used to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the entire set of Users. This attribute cannot be changed.","type":"string","example":"Mock.User"},"name":{"description":"The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.","properties":{"formatted":{"description":"The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.","type":"string","example":"Ms. Barbara J Jensen, III"},"familyName":{"description":"The family name of the User, or Last Name in most Western languages","type":"string","example":"Jensen"},"givenName":{"description":"The given name of the User, or First Name in most Western languages","type":"string","example":"Barbara"}}},"displayName":{"description":"The name of the User, suitable for display to end-users. The name should be the full name of the User being described.","type":"string","example":"Barbara Jensen"},"userType":{"description":"The type of the User, identifying the relationship between the organization and the User.","type":"string","example":"employee"},"active":{"description":"A Boolean value indicating the User’s administrative status.","type":"boolean","example":true},"password":{"description":"The User's case-sensitive cleartext password. This attribute is intended to be used as a means to specify an initial password when creating a new User or to reset an existing User's password. This attribute will never be returned in a response.","type":"string"},"emails":{"description":"Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.","type":"array","items":{"properties":{"type":{"description":"Type of email address (work, home, other).","type":"string","example":"work"},"value":{"description":"Canonicalized email address.","type":"string","format":"email","example":"Barbara.Jensen@example.com"},"primary":{"description":"A Boolean value indicating the primary e-mail address. The primary attribute value 'true' MUST appear no more than once.","type":"boolean","example":"true"}}}},"urn:ietf:params:scim:schemas:sailpoint:1.0:User":{"properties":{"capabilities":{"description":"Capabilities assigned to this User.","type":"array","items":{"type":"string"},"example":"[\"SystemAdministrator\"]"},"administrator":{"description":"The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service.","properties":{"displayName":{"description":"The display name of the Administrator of RPA user or Service account.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the SCIM resource representing the Administrator of RPA user or Service account.","type":"string","example":"c0a7777a7f74744d817e74fc12362c67O"},"$ref":{"description":"The URI of the SCIM resource representing the Administrator of RPA user or Service Account.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67"}}},"softwareVersion":{"description":"The software version of the RPA/Bots.","type":"string","example":"7.3"},"empId":{"description":"Employee id associated with this User.","type":"string","example":"1b2a3c"},"dn":{"description":"Distinguished name for this User.","type":"string","example":"cn=Bob Smith,ou=services"},"region":{"description":"The region this User is assigned to.","type":"string","example":"Americas"},"regionOwner":{"description":"The User who owns the region that this resource (User) belongs to.","properties":{"displayName":{"description":"Display name of the region owner.","type":"string","example":"Joe Smith"},"value":{"description":"The id of the region owner.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"$ref":{"description":"URI reference of the region owner resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"}}},"location":{"description":"The location this User is assigned to.","type":"string","example":"Singapore"},"locationOwner":{"description":"The User who owns the location that this resource (User) belongs to.","type":"object","properties":{"displayName":{"description":"Display name of the location owner.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the location owner.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"URI reference to the location owner resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"Department":{"description":"Department this User is assigned to.","type":"string","example":"Regional Operations"},"costcenter":{"description":"Cost centers this User is associated with.","type":"array","items":{"type":"string"},"example":["CC01","DD02"]},"jobtitle":{"description":"Job title given to this User.","type":"string","example":"Internal Audit Manager"}}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"description":"Enterprise User Schema. Contains the manager of the User.","properties":{"manager":{"description":"Manager of the user.","properties":{"displayName":{"description":"Display name of the manager.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the manager.","type":"string","example":"c7a7347a7fe71e69077ee75f5d1f1237"},"$ref":{"description":"Reference to the manager resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237"}}}}}},"required":["userName"]}}}},"responses":{"200":{"description":"Updates an existing User and returns that User.","content":{"application/json":{"schema":{"properties":{"id":{"description":"IdentityIQ id of the User.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"userName":{"description":"Unique identifier for the User. Typically used to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the entire set of Users. Cannot be changed.","type":"string","example":"Mock.User"},"name":{"description":"The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.","properties":{"formatted":{"description":"The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.","type":"string","example":"Ms. Barbara J Jensen, III"},"familyName":{"description":"The family name of the User, or Last Name in most Western languages","type":"string","example":"Jensen"},"givenName":{"description":"The given name of the User, or First Name in most Western languages","type":"string","example":"Barbara"}}},"displayName":{"description":"The name of the User, suitable for display to end-users. The name should be the full name of the User being described.","type":"string","example":"Barbara Jensen"},"userType":{"description":"The type of the User, identifying the relationship between the organization and the User.","type":"string","example":"employee"},"active":{"description":"A Boolean value indicating the User’s administrative status.","type":"boolean","example":true},"emails":{"description":"Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.","type":"array","items":{"properties":{"type":{"description":"Type of email address (work, home, other).","type":"string","example":"work"},"value":{"description":"Canonicalized email address.","type":"string","format":"email","example":"Barbara.Jensen@example.com"},"primary":{"description":"A Boolean value indicating the primary e-mail address. The primary attribute value 'true' MUST appear no more than once.","type":"boolean","example":"true"}}}},"urn:ietf:params:scim:schemas:sailpoint:1.0:User":{"description":"Additional attributes of the User.","type":"object","properties":{"accounts":{"description":"Simple representation of the Account (or Link) ResourceType.","type":"array","items":{"properties":{"displayName":{"description":"The display name of the Account.","type":"string","example":"Bob.Smith"},"value":{"description":"The id of the SCIM resource representing the Account.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"The URI of the SCIM resource representing the Account.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Accounts/c0a7778b7ef71e79817ee74e6a1f0444"}}}},"entitlements":{"description":"Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter.","type":"array","items":{"properties":{"value":{"description":"The value of the Entitlement.","type":"string","example":"groupmbr"},"display":{"description":"The display name of the Entitlement.","type":"string","example":"HelpDesk"},"type":{"description":"The type of Entitlement (Entitlement, Permission, etc.).","type":"string","example":"Permission"},"application":{"description":"The name of the Application this Entitlement applies to.","type":"string","example":"ADMockApp"},"accountName":{"description":"The account this Entitlement was sourced from.","type":"string","example":"CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com"},"$ref":{"description":"The URI of the SCIM resource representing the Entitlement.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Entitlements/c0a7777a7f74744d817e74fc12362c67"}}}},"roles":{"description":"Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter.","type":"array","items":{"properties":{"value":{"description":"The value of the Role.","type":"string","example":"detectedRoles"},"display":{"description":"The display name of the Role.","type":"string","example":"User - IT"},"type":{"description":"The type of Role (IT, Business, etc.).","type":"string","example":"it"},"acquired":{"description":"Indicates how this Role was acquired. Assigned or Detected.","type":"string","example":"Assigned"},"application":{"description":"The name of the Application where this Role came from.","type":"string","example":"Active_Directory"},"accountName":{"description":"The name of the Account this Role was sourced from.","type":"string","example":"CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com"},"$ref":{"description":"The URI of the SCIM resource representing the Role.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Roles/c0a7777a7f74744d817e74fc12362c67"}}}},"capabilities":{"description":"Capabilities assigned to this User.","type":"array","items":{"type":"string"},"example":"[\"SystemAdministrator\"]"},"riskScore":{"description":"Composite Risk Score of this User.","type":"integer","example":125},"isManager":{"description":"A Boolean value that determines if this User is a manager.","type":"boolean","example":false},"administrator":{"description":"The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service.","properties":{"displayName":{"description":"The display name of the Administrator of RPA user or Service account.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the SCIM resource representing the Administrator of RPA user or Service account.","type":"string","example":"c0a7777a7f74744d817e74fc12362c67O"},"$ref":{"description":"The URI of the SCIM resource representing the Administrator of RPA user or Service Account.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67"}}},"softwareVersion":{"description":"The software version of the RPA/Bots.","type":"string","example":"7.3"},"empId":{"description":"Employee id associated with this User.","type":"string","example":"1b2a3c"},"dn":{"description":"Distinguished name for this User.","type":"string","example":"cn=Bob Smith,ou=services"},"region":{"description":"The region this User is assigned to.","type":"string","example":"Americas"},"regionOwner":{"description":"The User who owns the region that this resource (User) belongs to.","properties":{"displayName":{"description":"Display name of the region owner.","type":"string","example":"Joe Smith"},"value":{"description":"The id of the region owner.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"$ref":{"description":"URI reference of the region owner resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"}}},"location":{"description":"The location this User is assigned to.","type":"string","example":"Singapore"},"locationOwner":{"description":"The User who owns the location that this resource (User) belongs to.","type":"object","properties":{"displayName":{"description":"Display name of the location owner.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the location owner.","type":"string","example":"c0a7778b7ef71e79817ee74e6a1f0444"},"$ref":{"description":"URI reference to the location owner resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"}}},"Department":{"description":"Department this User is assigned to.","type":"string","example":"Regional Operations"},"costcenter":{"description":"Cost centers this User is associated with.","type":"array","items":{"type":"string"},"example":["CC01","DD02"]},"jobtitle":{"description":"Job title given to this User.","type":"string","example":"Internal Audit Manager"},"lastRefresh":{"description":"Datetime representation of the last refresh for this User.","type":"string","format":"date-time"}}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"description":"Enterprise User Schema. Contains the manager of the User.","properties":{"manager":{"description":"Manager of the User.","properties":{"displayName":{"description":"Display name of the User's manager.","type":"string","example":"Bob Smith"},"value":{"description":"The id of the SCIM resource representing the User’s manager.","type":"string","example":"c7a7347a7fe71e69077ee75f5d1f1237"},"$ref":{"description":"The URI of the SCIM resource representing the User’s manager.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237"}}}}},"meta":{"description":"Metadata of the resource.","properties":{"created":{"description":"Datetime this resource was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the resource was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the resource.","type":"string","example":"W\"1644561244074\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"User"}}},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:User","urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"]}}}}}}},"method":"put","path":"/Users/{userId}","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"jsonRequestBodyExample":{"userName":"Mock.User","name":{"formatted":"Ms. Barbara J Jensen, III","familyName":"Jensen","givenName":"Barbara"},"displayName":"Barbara Jensen","userType":"employee","active":true,"password":"string","emails":[{"type":"work","value":"Barbara.Jensen@example.com","primary":"true"}],"urn:ietf:params:scim:schemas:sailpoint:1.0:User":{"capabilities":"[\"SystemAdministrator\"]","administrator":{"displayName":"Bob Smith","value":"c0a7777a7f74744d817e74fc12362c67O","$ref":"http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67"},"softwareVersion":"7.3","empId":"1b2a3c","dn":"cn=Bob Smith,ou=services","region":"Americas","regionOwner":{"displayName":"Joe Smith","value":"c0b4568a4fe7458c434ee77d1fbt156b","$ref":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"},"location":"Singapore","locationOwner":{"displayName":"Bob Smith","value":"c0a7778b7ef71e79817ee74e6a1f0444","$ref":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"},"Department":"Regional Operations","costcenter":["CC01","DD02"],"jobtitle":"Internal Audit Manager"},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"manager":{"displayName":"Bob Smith","value":"c7a7347a7fe71e69077ee75f5d1f1237","$ref":"http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237"}}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Updates an existing User.","description":{"content":"The endpoint used to update a User resource. There are attributes marked as 'returned only by request', such as **roles**, which must be provided as part of the **attributes** query parameter in order to be included in the response.

      In order for Lifecycle Events to have access to previous Identity values, a new IdentityArchive object is created and saved to the database. This feature is turned on by default and *could* have an impact on the overall performance of the SCIM update. It is not expected for the impact of this change to be noticeable, but in cases where it is, and when configured Lifecycle Events are not dependent on the previous Identity attributes, the creation of the IdentityArchive object during a SCIM update is configurable. By default, the IdentityArchive creation during a SCIM update is enabled. To disable the creation of the IdentityArchive object during SCIM updates, the following attribute can be set on the SystemConfiguration object:

      **<entry key=\"scimTriggerSnapshots\" value=\"false\">**","type":"text/plain"},"url":{"path":["Users",":userId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*","type":"text/plain"},"key":"excludedAttributes","value":""},{"disabled":false,"description":{"content":"A boolean value that determines if the User resource will be looked up by userName instead of userId (value in path parameter 'userId'). Setting this query parameter to true will cause the value pulled from the 'userId' path parameter to be treated as a userName when searching for the resource.

      **Example**: scim/v2/Users/**Mock.User**?**lookupByName=true**","type":"text/plain"},"key":"lookupByName","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The id of User resource. If **lookupByName** is set to **true**, this path parameter should be set to the **userName** of the User.","type":"text/plain"},"type":"any","value":"","key":"userId"}]},"header":[{"key":"Content-Type","value":"application/scim+json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "put api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Updates an existing User.' (update-user)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Updates an existing User. + + + +The endpoint used to update a User resource. There are attributes marked as 'returned only by request', such as **roles**, which must be provided as part of the **attributes** query parameter in order to be included in the response.

      In order for Lifecycle Events to have access to previous Identity values, a new IdentityArchive object is created and saved to the database. This feature is turned on by default and *could* have an impact on the overall performance of the SCIM update. It is not expected for the impact of this change to be noticeable, but in cases where it is, and when configured Lifecycle Events are not dependent on the previous Identity attributes, the creation of the IdentityArchive object during a SCIM update is configurable. By default, the IdentityArchive creation during a SCIM update is enabled. To disable the creation of the IdentityArchive object during SCIM updates, the following attribute can be set on the SystemConfiguration object:

      **<entry key="scimTriggerSnapshots" value="false">** + +
      Path Parameters
      Query Parameters

        **Example**: scim/v2/Users/**Mock.User**?**lookupByName=true**"}}>
      Request Body required
        name
        + +The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined. + +
        emails undefined[]
        + +Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other. + +
        urn:ietf:params:scim:schemas:sailpoint:1.0:User
        administrator
        + +The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service. + +
        regionOwner
        + +The User who owns the region that this resource (User) belongs to. + +
        locationOwner object
        + +The User who owns the location that this resource (User) belongs to. + +
        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
        + +Enterprise User Schema. Contains the manager of the User. + +
        manager
        + +Manager of the user. + +
      Request Body required
        name
        + +The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined. + +
        emails undefined[]
        + +Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other. + +
        urn:ietf:params:scim:schemas:sailpoint:1.0:User
        administrator
        + +The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service. + +
        regionOwner
        + +The User who owns the region that this resource (User) belongs to. + +
        locationOwner object
        + +The User who owns the location that this resource (User) belongs to. + +
        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
        + +Enterprise User Schema. Contains the manager of the User. + +
        manager
        + +Manager of the user. + +
      + +Updates an existing User and returns that User. + +
      Schema
        name
        + +The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined. + +
        emails undefined[]
        + +Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other. + +
        urn:ietf:params:scim:schemas:sailpoint:1.0:User object
        + +Additional attributes of the User. + +
        accounts undefined[]
        + +Simple representation of the Account (or Link) ResourceType. + +
        entitlements undefined[]
        + +Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter. + +
        roles undefined[]
        + +Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter. + +
        administrator
        + +The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service. + +
        regionOwner
        + +The User who owns the region that this resource (User) belongs to. + +
        locationOwner object
        + +The User who owns the location that this resource (User) belongs to. + +
        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
        + +Enterprise User Schema. Contains the manager of the User. + +
        manager
        + +Manager of the User. + +
        meta
        + +Metadata of the resource. + +
      \ No newline at end of file diff --git a/products/iiq/api/users.tag.mdx b/products/iiq/api/users.tag.mdx new file mode 100644 index 000000000..a6d0e6713 --- /dev/null +++ b/products/iiq/api/users.tag.mdx @@ -0,0 +1,16 @@ +--- +id: users +title: "Users" +description: "Users" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/products/iiq/api/workflows-get.api.mdx b/products/iiq/api/workflows-get.api.mdx new file mode 100644 index 000000000..2da123b15 --- /dev/null +++ b/products/iiq/api/workflows-get.api.mdx @@ -0,0 +1,40 @@ +--- +id: workflows-get +sidebar_label: Returns all Workflow resources. +hide_title: true +hide_table_of_contents: true +api: {"operationId":"WorkflowsGet","tags":["Workflows"],"description":"This endpoint returns all Workflow resources.

      \nAttributes to include in the response can be specified with the 'attributes' query parameter.

      \nAttributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

      \nThe schema related to Workflow is:
      \n- **urn:ietf:params:scim:schemas:sailpoint:1.0:Workflow**\n","parameters":[{"in":"query","name":"filter","schema":{"type":"string","example":"name eq \"Do Provisioning Forms\""},"description":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported."},{"in":"query","name":"lookupByName","schema":{"type":"boolean","default":false,"example":true},"description":"**(OPTIONAL)** Set to true if the Workflows name is passed instead of the Workflow id."},{"in":"query","name":"sortBy","schema":{"type":"string","example":"name"},"description":"Allows sorting the results by a resource's attributes."},{"in":"query","name":"sortOrder","schema":{"type":"string","default":"ascending","example":"descending"},"description":"Determines what order to sort results in."},{"in":"query","name":"startIndex","schema":{"type":"integer","example":15,"default":1},"description":"Determines the starting index of the result set."},{"in":"query","name":"count","schema":{"type":"integer","example":15,"default":1000},"description":"Specifies the number of results per page."},{"in":"query","name":"attributes","schema":{"type":"string","example":"name"},"description":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"name, type"},"description":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**"}],"responses":{"200":{"description":"Returned all SCIM resources for this endpoint.","content":{"application/json":{"schema":{"properties":{"totalResults":{"description":"Number of resources returned for this endpoint.","type":"integer","example":"1,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"type":"array","items":{"required":["name"],"properties":{"id":{"description":"Unique identifier of the Workflow.","type":"string","example":"7f00000180281df7818028bf977502f3"},"name":{"description":"Name of the Workflow.","type":"string","example":"Identity Request Approve Identity Changes"},"description":{"description":"Description of the Workflow.","type":"string","example":"\n The subprocess that drives the Create and Update Identity workflows.\n This is different then the Identity Request Approve subprocess because this\n approval process produces a form with the approval so that\n approvers can update values while approving.\n\n This subprocess builds the form necessary for the editable approvals\n and then assimilates that data entered back to the plan, which\n can be returned from the subprocess.\n"},"type":{"description":"Type of the Workflow.","type":"string","enum":["Batch Provisioning","Scheduled Assignment","Scheduled Role Activation","Managed Attribute","Identity Correlation","Identity Event","Identity Lifecycle","Identity Update","Identity Refresh","LCM Identity","LCM Provisioning","LCM Registration","Policy Violation","Role Modeler","Subprocess","Password Intercept","Alert","Attribute Sync"],"example":"Subprocess"},"handler":{"description":"Handler of the Workflow.","type":"string","example":"sailpoint.api.StandardWorkflowHandler"},"meta":{"type":"object","properties":{"created":{"description":"DateTime when the Workflow was created.","type":"string","example":"2022-04-14T10:44:46.453-05:00"},"location":{"description":"URL to the Workflow.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Workflows/7f00000180281df7818028bf977502f3"},"lastModified":{"description":"DateTime of Workflow last modification.","type":"string","example":"2022-05-05T15:52:30.119-05:00"},"version":{"description":"Workflow version.","type":"string","example":"W\"1649951086453\""},"resourceType":{"description":"Resource type of the metadata subject.","type":"string","example":"Workflow"}}}}}}}}},"application/scim+json":{"schema":{"properties":{"totalResults":{"description":"Number of Workflow resources returned.","type":"integer","example":"1500,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"description":"The SCIM resources returned for this endpoint.","type":"array","items":{"required":["name"],"properties":{"id":{"description":"Unique identifier of the Workflow.","type":"string","example":"7f00000180281df7818028bf977502f3"},"name":{"description":"Name of the Workflow.","type":"string","example":"Identity Request Approve Identity Changes"},"description":{"description":"Description of the Workflow.","type":"string","example":"\n The subprocess that drives the Create and Update Identity workflows.\n This is different then the Identity Request Approve subprocess because this\n approval process produces a form with the approval so that\n approvers can update values while approving.\n\n This subprocess builds the form necessary for the editable approvals\n and then assimilates that data entered back to the plan, which\n can be returned from the subprocess.\n"},"type":{"description":"Type of the Workflow.","type":"string","enum":["Batch Provisioning","Scheduled Assignment","Scheduled Role Activation","Managed Attribute","Identity Correlation","Identity Event","Identity Lifecycle","Identity Update","Identity Refresh","LCM Identity","LCM Provisioning","LCM Registration","Policy Violation","Role Modeler","Subprocess","Password Intercept","Alert","Attribute Sync"],"example":"Subprocess"},"handler":{"description":"Handler of the Workflow.","type":"string","example":"sailpoint.api.StandardWorkflowHandler"},"meta":{"type":"object","properties":{"created":{"description":"DateTime when the Workflow was created.","type":"string","example":"2022-04-14T10:44:46.453-05:00"},"location":{"description":"URL to the Workflow.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Workflows/7f00000180281df7818028bf977502f3"},"lastModified":{"description":"DateTime of Workflow last modification.","type":"string","example":"2022-05-05T15:52:30.119-05:00"},"version":{"description":"Workflow version.","type":"string","example":"W\"1649951086453\""},"resourceType":{"description":"Resource type of the metadata subject.","type":"string","example":"Workflow"}}}}}}}}}}}},"method":"get","path":"/Workflows","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns all Workflow resources.","description":{"content":"This endpoint returns all Workflow resources.

      \nAttributes to include in the response can be specified with the 'attributes' query parameter.

      \nAttributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

      \nThe schema related to Workflow is:
      \n- **urn:ietf:params:scim:schemas:sailpoint:1.0:Workflow**\n","type":"text/plain"},"url":{"path":["Workflows"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.","type":"text/plain"},"key":"filter","value":""},{"disabled":false,"description":{"content":"**(OPTIONAL)** Set to true if the Workflows name is passed instead of the Workflow id.","type":"text/plain"},"key":"lookupByName","value":""},{"disabled":false,"description":{"content":"Allows sorting the results by a resource's attributes.","type":"text/plain"},"key":"sortBy","value":""},{"disabled":false,"description":{"content":"Determines what order to sort results in.","type":"text/plain"},"key":"sortOrder","value":""},{"disabled":false,"description":{"content":"Determines the starting index of the result set.","type":"text/plain"},"key":"startIndex","value":""},{"disabled":false,"description":{"content":"Specifies the number of results per page.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: iiq/api/identityiq-scim-rest-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns all Workflow resources.' (workflows-get)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Returns all Workflow resources. + + + +This endpoint returns all Workflow resources.

      +Attributes to include in the response can be specified with the 'attributes' query parameter.

      +Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

      +The schema related to Workflow is:
      +- **urn:ietf:params:scim:schemas:sailpoint:1.0:Workflow** + + +
      Query Parameters
      + +Returned all SCIM resources for this endpoint. + +
      Schema
        Resources undefined[]
        meta object
      Schema
        Resources undefined[]
        + +The SCIM resources returned for this endpoint. + +
        meta object
      \ No newline at end of file diff --git a/products/iiq/api/workflows.tag.mdx b/products/iiq/api/workflows.tag.mdx new file mode 100644 index 000000000..f1c44e4b7 --- /dev/null +++ b/products/iiq/api/workflows.tag.mdx @@ -0,0 +1,16 @@ +--- +id: workflows +title: "Workflows" +description: "Workflows" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file